Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

Application Server

About the attributes page

  • Last UpdatedJan 15, 2025
  • 7 minute read

The Attributes page divides into two or more panes when you initially open it. The number of panes the Attributes page divides in depends on whether or not attributes or graphics have been defined for the object, whether the object is an instance or a template, and if it is an instance, whether or not it is derived from a template that includes an Object Wizard.

If the object you are editing does not have any attributes defined, the Attributes page will be empty. The Attributes page will also show a pane for graphics, and depending on the type of object (template or instance) and its contents, may show additional Object Wizard configuration panes.

You can activate various features, such as I/O, History, State Alarm and Statistics. See Configure Objects for more information about attributes and features. When you add an attribute to an object, information about the attribute is shown.

Set object attributes page

Object wizard open/close icon

Opens the Object Wizard editor.

Filter attributes icon

To filter attributes, select the Filter button. You can then select filtering criteria by checking source type, enabled feature type, writeability type, lock status, data type, visibility type (hidden or not hidden), and diagnostic type (configuration, run time, or both).

Add an attribute icon

Adds a new attribute.

Duplicate selected attributes icon

Duplicates the selected attributes.

Remove selected attributes icon

Removes the selected attributes.

Display Scripts icon

To display the Scripts pane used to associate scripts with an Object Wizard, select the Scripts button.

Show details icon

Shows Details about an attribute. The name, description, and icons representing activated features for the object’s attributes will be shown.

When you add an attribute to an object, the Attributes page divides into three sections. The left side of the page lists attributes, the top right shows information about the currently selected attribute, and the bottom of the right side contains fields for configuring features.

You can search attributes by entering the characters you are trying to find in the Search Current Attributes text box. This will display attributes that contain the characters you enter.

Note: The search function finds attributes that contain the search term anywhere within the attribute name. For example, if you want to locate all attributes associated with Pump125, you could enter "125" in the text box. All attributes with 125 anywhere in their names will be shown.

You can also search for attributes by typing the character you are searching for when the cursor is pointed at the attribute list. The first attribute that contains the character, anywhere within its name, will be highlighted.

Note: The search begins at the attribute that is currently selected. Selection will move to the next attribute that contains the character entered.

  • On the left side of the page, all attribute names for the object are listed. Pressing the Show Details button reveals additional information about the listed attributes. Check boxes are provided for Inherited and User extended.

    • Inherited: Checking this displays attributes that were added in the parent template used to create the object.

    • User extended: Checking this displays details about any features you added to the attribute, for example, for I/O.

  • At the top of the right side, information for the current attribute is listed. Additional fields may be listed, depending on the data type of the attribute. However, all data types include the following properties:

Property

Description

Name

Attribute name (for example, Attribute001).

Description

User defined; a description of the attribute.

Data type

Can be set to Boolean, Integer, Float, Double, String, Time, ElapsedTime, or InternationalizedString.

The data type determines which features can be added to an attribute. For example, when configuring a Boolean data type, only two alarm features are available: State Alarm and Bad Value Alarm. When configuring an Integer data type, there are four available alarm features: Limit Alarms, ROC Alarms, Deviation Alarms and Bad Value Alarms.

To create an array, check the Array option and specify the array's length in the # of elements box. You can create an array for each data type except InternationalizedString.

Writeability

Can be set to Calculated, Calculated retentive, Object writeable, or User writeable. See the Object Viewer User Guide for additional information about writeability categories.

  • Calculated: Permits only scripts within the same object to write to the attribute. Calculated attributes are not saved across restarts. If you select Calculated for an attribute, only scripts running on the same object can write to the attribute.

  • Calculated Retentive: Permits only scripts within the same object to write to the attribute. Calculated Retentive attributes are saved across engine restarts.

  • Object Writeable: Permits other objects to write to this attribute in addition to being set by scripts within this object. Object Writeable attributes are saved across restarts. This category is not user writeable.

  • User Writeable: Permits other users to write to this attribute in addition to being set by scripts and objects throughout the system. User Writeable attributes are saved across restarts. They can be locked at configuration time. If locked, they are read-only.

Initial value

Specifies the initial value for the attribute when the object is deployed. Enter value data for each data type. In the case of a non-arrayed Boolean, select True or False in the list box. For an arrayed Boolean, select the appropriate checkbox.

Some attribute text boxes may show --- (dash dash dash). The --- is a placeholder reference that does not cause the associated object to be placed in a warning configuration status when it is validated. You may also see attribute text boxes showing a ---.--- (dash dash dash dot dash dash dash). You need to provide a valid reference in the text box. The ---.--- placeholder causes the associated object to be placed in a warning configuration status when the associated object is validated.

Important: Edit the I/O auto assignment placeholder in the Object Editor ONLY if you do NOT want to use I/O auto assignment for the object. In most cases, I/O auto assignment is the preferred method.

  • At the bottom of the right side, fields for configuring activated features are displayed. Available features include:

    Feature

    Description

    Input/output field icon

    The I/O feature is used to activate the attribute for I/O. You can select Read (input), Read/Write (input and output), or Write (output).

    When you select the I/O feature for application objects and system objects, such as areas, the "Read from / Write to attribute text box contains the placeholder reference <IODevice>. [HierarchicalName].[AttributeName].InputSource or <IODevice>.[HierarchicalName].[AttributeName]. OutputDest.

    You should not edit these placeholders in the Object Editor, but instead use the IO Devices view to assign the object to a scan group. This will allow the placeholder to automatically resolve to the correct I/O reference. See I/O auto assignment for additional information.

    History field icon

    The History feature enables historization to the Historian.

    Note: The AppEngine hosting the object must be configured for historization.

    State Alarm field icon

    The State Alarm feature is available for Boolean data types. You can set alarm priorities, the alarm state, an alarm message, and time deadband.

    Limit alarm field icon

    The Limit Alarms feature is available for integer, float, and double data types. With it, you can set value alarms (Hi, HiHi, Lo, LoLo), and the limits, priority, and messages to apply to each alarm limit.

    ROC alarms field icon

    The Rate of Change (ROC) Alarm feature is available for integer, float, and double data types. With it, you can set alarms if changes within the specified time period exceed set values. Configurable parameters include change limits, change direction, alarm priority, the alarm message, how often to evaluate changes to the value, and time period.

    Deviation alarms field icon

    The Deviation Alarm feature is available for integer, float, and double data types. With it, you can set deviation alarms (major and minor), and the tolerance, priority, messages, target value, deadband, and settling period.

    Bad value alarms field icon

    The Bad Value Alarm feature adds an alarm if the value returned from the attribute is determined to be bad quality.

    Statistics field icon

    The Statistics feature monitors statistics associated with the object.

    Log change field icon

    The Log Change feature will cause the attribute to generate an event each time the attribute value changes.

Related Links
TitleResults for “How to create a CRG?”Also Available in