A register definition is configured using a report definition. A register definition is used as a template in the tag register generation process and allows you to define the type of tag registers and register category. From the list of properties that you configured for the selected report definition, you can select and set required properties as mandatory properties that must appear in the tag registers. The report definition can also help you to keep track of changes in the tag registers by displaying the changes in different colors.
You must have the RegisterAdministrator role to create or update report definitions.
Allows you to create a new register definition.
Name - Allows you to provide a name for the new register definition.
Description - Allows you to provide a description of the new register definition.
Register category - Allows you to select the type of objects that you want to display in the generated tag register.
Report definition - Allows you to select the report definition to be used when generating the tag register.
Show all properties from view definition - Allows you to include all the properties from the applicable view definition associated with the selected report definition. The properties that are not selected on the report definition appear as read-only in the Mandatory properties section.
Identify missing mandatory data - Allows you to view the missing mandatory tag data in the generated tag register. All the mandatory properties that have missing values are marked with the text MISSING, by default.
Mandatory properties - Lists the properties that you configured for the selected report definition. From this list, you can select the properties that you want to set as mandatory. All the mandatory properties are marked with an asterisk (*) in the tag register.
Select All - Allows you to select all of the listed properties except those that were not selected on the report definition.
Clear All - Allows you to clear all the selected properties.
Display Unit of measurement Separately (UOM) - Allows you to view the UOM separately from its property value. In a Microsoft Excel sheet, the value and UOM appear in separate columns. In an ASCII file, they are separated by the specified delimiter.
Register type - Allows you to select the type of tag register you want to create.
-
Full tag registers display all the applicable tags for the specified tag type.
-
Incremental only tag registers, when generated the first time, also display all the applicable tags for the specified tag type. However, each time the tag register is regenerated, the new version will include only tags that have been added, modified, or deleted since a previous version that you select for comparison.
If no changes are found since the selected previous version, no new version of the
tag register is generated.
Show change status column - Displays the change status column in the tag register.
-
For Incremental only tag registers, the Show change status column check box is selected by default and is read-only.
-
For Full tag registers, you can select or clear the Show change status column check box.
Indicate changes - Allows you to use colored text in the resulting Microsoft Excel file to indicate how the data has changed since the older version used in the comparison.
The following table describes various color codes that are displayed in the generated Microsoft Excel file:
|
Text |
Indicates |
|
Red |
Deleted tags |
|
Green |
Newly added tags or new property values added to the tags with Modified status |
|
Blue |
Changed property values with Modified status |
The cells filled with a red color indicate deleted property values of tags with Modified status.
Show comments with previous values - Allows you to view the data that has changed since the older version used in the comparison as a comment when you pause the mouse on the current value in a tag register (Microsoft Excel file).
Historical values - Allows you to view the changes made to a tag property value in various register document versions. When you pause the mouse on the current tag property value in a tag register (Microsoft Excel file), property values in previous document versions, corresponding register document versions, and the date of modification appear in a comment.
Allows you to update the details of a register definition.
Name - Allows you to provide a name for the new register definition.
Description - Allows you to provide a description of the new register definition.
Register category - Allows you to select the type of objects that you want to display in the generated tag register.
Report definition - Allows you to select the report definition to be used when generating the tag register.
Show all properties from view definition - Allows you to include all the properties from the applicable view definition associated with the selected report definition. The properties that are not selected on the report definition appear as read-only in the Mandatory properties section.
Identify missing mandatory data - Allows you to find the missing mandatory tag data in the generated tag register. All the mandatory properties that are having missing values are marked with the text 'MISSING' by default.
Mandatory properties - Lists the properties that you configured for the selected report definition. From this list, you can select the properties that you want to set as mandatory. All the mandatory properties are marked with an asterisk (*) in the tag register.
Select All - Allows you to select all of the listed properties except those that were not selected on the report definition.
Clear All - Allows you to clear all the selected properties.
Display Unit of measurement Separately (UOM) - Allows you to view the UOM separately from its property value. In a Microsoft Excel sheet, the value and UOM appear in separate columns. In an ASCII file, they are separated by the specified delimiter.
Register type - Allows you to select the type of tag register you want to create.
-
Full tag registers display all the applicable tags for the specified tag type.
-
Incremental only tag registers, when generated the first time, also display all the applicable tags for the specified tag type. However, each time the tag register is regenerated, the new version will include only tags that have been added, modified, or deleted since a previous version that you select for comparison.
If no changes are found since the selected previous version, no new version of the
tag register is generated.
Show change status column - Displays the change status column in the tag register.
-
For Incremental only tag registers, the Show change status column check box is selected by default and is read-only.
-
For Full tag registers, you can select or clear the Show change status column check box.
Indicate changes - Allows you to use colored text in the resulting Microsoft Excel file to indicate how the data has changed since the older version used in the comparison.
The following table describes various color codes that are displayed in the generated Microsoft Excel file:
|
Text |
Indicates |
|
Red |
Deleted tags |
|
Green |
Newly added tags or new property values added to the tags with Modified status |
|
Blue |
Changed property values with Modified status |
The cells filled with a red color indicate deleted property values of tags with Modified status.
Show comments with previous values - Allows you to view the data that has changed since the older version used in the comparison as a comment when you pause the mouse on the current value in a tag register (Microsoft Excel file).
Historical values - Allows you to view the changes made to a tag property value in various register document versions. When you pause the mouse on the current tag property value in a tag register (Microsoft Excel file), property values in previous document versions, corresponding register document versions, and the date of modification appear in a comment.
Allows you to configure the status name that you want to view in the generated tag register.
Configure reporting of change types - Displays the statuses of the tags: Added, Modified, and Deleted.
Modified - Allows you to enter alternative name for the Modified status.
Added - Allows you to enter alternative name for the Added status.
Deleted - Allows you to enter alternative name for the Deleted status.
Main details
Name - Displays the name of the register configuration object.
This object cannot be terminated or deleted, and only one register configuration
object can exist in a SmartPlant Foundation site.
Description - Allows you to edit the description of the register configuration object.
What do you want to do?