Understanding the attribute table

Name

Enter a name for the attribute.

Description

Enter a description for the attribute.

Field Name

To select one of the fields available in your system:

• Enter the name of the field, or

• Select and select the desired field name in the Field Name Selector dialog box.
  

The value for the flag determines whether the attribute is active or not. The Field Name must be the name of a field included in the flags or the replicatedFlags structure with type oas_boolean_t.

If you provide a name that is not part of the flags or the replicatedFlags structure, the record will not save and an error will appear.

Note: There are some special fields in flags structure (sevint, tag, and flexTag) that are not oas_boolean_t type, but can be used to describe attributes. A special logic is defined for them to process the image to be used. Refer to the Image Field description for more information.

Alarm icons in the attribute table may flash. If you configure an attribute that has the sevint or alarm field assigned to an icon, the Control Room Management (CRM) object can be configured so that the icon will flash for an unacknowledged alarm.

Note: You should only assign either an alarm severity or alarm state to a single icon. API-1165 and Abnormal Situation Management (ASM) both call for alarm severity only being displayed in the icon. Assigning an alarm state goes against the recommended practice. Alarm state is depicted through colors only for API-1165 and not through an icon. There is no mention of alarm state in ASM.

Is Inverted

When this checkbox is selected, and the value of the configured field name is no, the attribute will be considered active.

Precedence within Icon

This precedence defines the stack options for the attributes. The image used for each icon will be the one that is configured in the attribute assigned to the icon that is active and has the highest precedence. For the precedence, the values are 1 to 50. Lower numbers correspond to a higher precedence.

Note: The value for this property must be different for all records assigned to the same icon. If there are two rows with the same precedence, the same icon position, and both attributes are active, the behavior is unpredictable.

Image File

The content of this field is determined by the type of attribute that you want to define. There are two types of attributes: regular attributes and special logic attributes.

Note: A question mark (?) will be drawn in the element in the easy eXtended Operator Station (ezXOS) if the image file specified does not exist.

Regular Attributes

A single defined image will be shown when the attribute is active. For regular attributes, the Image File field contains the image that will be shown when the attribute is active. The image file must have the .gif extension and must not contain:

• any white space,

• the following special characters: < > " : * | / \ ?

  To select an image, do one of the following:

• Enter the name of the required file in folders under the icons, bitmaps, or images folders.

• Select the button in the image field to open the Image Selector dialog box.

  Note: Only files under the ADE custom link folder are valid. An error message will appear if another folder is used.

  

  Note: If you want to use a field that can be used for special logic as a regular attribute, you must include the .gif extension to clearly specify that this attribute is to be considered as a regular attribute and you do not want to use the associated special logic.

Special Logic Attributes

Attributes configured with certain database field names can show different images when the attribute is active (depending on certain conditions). It is the responsibility of the customer to create as many images as possible to match the possible values of the images. The possible values depend on the field names and are described below:

• sevint: The attributes with this field name will be considered active when the alarm severity associated to the current state of the point is different than "none (0)". When a sevint attribute is active and you configure an Image File without the .gif extension, the data attribute icon will show different images depending on the severity of the current status of the point. The name of the image to show will be formed by appending the alarm severity code to the Image File provided.

  • The following alarm severity codes are available:

    • 0: none: attribute inactive

    • 4: low severity

    • 8: minor severity

    • 12: medium severity

    • 16: major severity

    • 20: high severity

  • Example:

    • attribute configured with an image file = anotAlarm

    • analog point with current state = high

    • high state configured in message table with severity = major

    • image to show = anotAlarm16.gif ()

      Note: If you include the .gif extension in the Image Name field, the configured image will always be shown whenever the alarm severity is different than none regardless of the current state.

• alarm: This option shows a different image depending on alarm state. The attributes with this field name will be considered active when the flag.alarm is true. When an alarm attribute is active and you configure an Image File without the .gif extension, the data attribute icon will show different images depending on the current status of the point. The name of the image to show will be formed by appending the current status of the point (flag.msgtxt) to the image file provided.

  • Example:

    • attribute configured with an image file = alarm

    • analog point with current state = HIGH

    • image to show = alarmHIGH.gif

      Notes: The alarmHIGH.gif does not exist as a default file. You must create all the required files to cover the possible values for the flag.mgstxt field.
      
      If you include the .gif extension in the Image Name field, the configured image will always be shown whenever the point is in alarm regardless of the current state.

• tag: This option shows a different image depending on the type of the highest priority tag placed on the point.

  The name of the image to be shown will be formed by appending the tag code to the image file provided. The following tag codes are available:

  • No commands = A

  • Being controlled = B

  • No close = C

  • No MultiCommands = M

  • No open = O

  • No program = P

  • Warning = W

  • No operator commands = H

  • Tagged and executing command = CB, MB, OB, PB, WB, HB

flexTag: This attribute shows a different image based on the flexible tagging configuration. For the flexTag field name, the content of the Image File field is ignored. The images that will be used will be the ones configured in the flexible tagging configuration.

• isControllable: This attribute will define the image to be shown in the icon when the attribute is active and the showControllability property of the CRM object is set to True. If the showControllability property of the CRM object is set to False, the attribute with isControllable field name is ignored and the image shown in the icon will correspond to the active attribute having the next precedence.

  Note: Only one attribute for the isControllable field can be defined for the same icon. If there are two rows with the isControllable attribute associated with the same icon position, the behavior is unpredictable. This means that configuring one icon that shows one image for a controllable condition and another image for a non-controllable condition is not supported.

Icon Position

Select the icon that the attribute is mapped to. If you select Unassigned, the attribute will not be used in any icon. The possible values are Icon1, Icon2, Icon3, and Unassigned.

Note: You may assign only one of the alarm severity or alarm state configurations to an icon. The other must remain Unassigned.