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

AVEVA™ Gateways

TABLE OF CONTENTS

Add Attributes to Classes

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedMar 04, 2025
  • 15 minute read

You can add the following attributes to the classes that have been selected for export:

  • Context

  • Name

  • Revision

  • Class ID

  • Characteristic

  • Property

  • Association

The following image shows the user interface for adding attributes.

Adding Context

You can add a context to an individual object. The context you provide here overrides the common context configured in the Other tab of the Settings dialog box. For more information about the common context, see Specify Common Settings for Export.

An object can have only one context.

To add a context:

  1. On the Drawings tab, click Class Mappings.

  2. Select the required class from the class list.

  3. In the EIWM Object Mapping area, select the root of the object tree for which you want to add a context, right-click and select Add EIWM > Context. The Context attribute is added to the object tree and the Context ID area appears.

  4. Do one of the following:

    • If you want to specify the value for the Context ID attribute directly, select the Constant option and enter a value in the Text box. The specified value is added to the Context ID attribute in the EIWM Object Mapping area.

      Note: You can add the value to the list by clicking the Add icon. Click the Delete icon to delete the selected value from the list. When you delete a value from the list, the value is deleted from the object tree as well.

    • If you want to derive the value for the Context ID attribute from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Context ID attribute in the EIWM Object Mapping area.

    • If you want to derive the value for the Context ID attribute from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Context ID attribute in the EIWM Object Mapping area.

      Note: The attributes without a value or a mapping are displayed in red and an error message is displayed in the tooltip. You can provide a nested context by providing the highest context first followed by a + or | symbol and so on. For example, ROOT+PARENT+CHILD (or ROOT|PARENT|CHILD).

Adding the Name Attribute

An object can have only one Name attribute.

To add a Name attribute:

  1. Click the Drawings tab, and then click Class Mappings.

  2. Select the required class from the class list.

  3. In the EIWM Object Mapping area, select the root of the object tree for which you want to add a name attribute, right-click and select Add EIWM > Name. The Name attribute is added to the object tree and the Name area appears.

    Do one of the following:

    • If you want to specify the value for the Name attribute directly, select the Constant option and enter a value in the Text box. The specified value is added to the Name attribute in the EIWM Object Mapping area.

      Note: You can add the value to the list by clicking the Add icon. Click the Delete icon to delete the selected value from the list. When you delete a value from the list, the value is deleted from the object tree as well.

    • If you want to derive the value for the Name attribute from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Name attribute in the EIWM Object Mapping area.

    • If you want to derive the value for the Name attribute from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Name attribute in the EIWM Object Mapping area.

      Note: The attributes without a value or a mapping are displayed in red and an error message is displayed in the tooltip.

    Adding the Revision Attribute

    An object can have only one Revision attribute.

    To add a Revision attribute:

    1. On the Revision tab, click Class Mappings.

    2. Select the required class from the class list. The mappings for the class, if any, are displayed in the EIWM Object Mapping area on the EIWM tab.

    3. In the EIWM Object Mapping area, select the root of the object tree for which you want to add a revision attribute, right-click and select Add EIWM > Revision. The Revision attribute is added to the object tree and the Revision area appears.

      Do one of the following:

      • If you want to specify the value for the Revision attribute directly, select the Constant option and enter a value in the Text box. The specified value is added to the Revision attribute in the EIWM Object Mapping area.

        Note: You can add the value to the list by clicking the Add icon. Click the Delete icon to delete the selected value from the list. When you delete a value from the list, the value is deleted from the object tree as well.

      • If you want to derive the value for the Revision attribute from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Revision attribute in the EIWM Object Mapping area.

      • If you want to derive the value for the Revision attribute from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Revision attribute in the EIWM Object Mapping area.

      Note: The attributes without a value or a mapping are displayed in red and an error message is displayed in the tooltip.

      Adding ClassID

      An object can have only one class ID.

      To add a class ID attribute:

      1. On the Drawings tab, click Class Mappings.

      2. Select the required class from the class list. The default mappings for the class, if any, are displayed in the EIWM Object Mapping area on the EIWM tab.

      3. Select the required Object ID node, right-click and select Add EIWM > ClassID.

      4. Select ClassID in the object tree. The ClassID area appears.

        Note: The mapping for the ClassID attribute can be added only once per object.

        Do one of the following:

        • If you want to specify the mapping value for the class ID directly, select the Constant option and enter a value in the Text box. The specified value is added to the EIWM Object Mapping area.

          Note: You can add the value to the list by clicking the Add icon. Such values are displayed in yellow in the list. Click the Delete icon to delete the selected value from the list. When you delete a value from the list, the mapping for the class ID is also deleted.

        • If you want to derive the mapping value from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The attribute is added to the EIWM Object Mapping area.

        • If you want to derive the mapping value from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the EIWM Object Mapping area.

        Important: The ClassIDs without a mapping are displayed in red and an error message is displayed in the tooltip. The ClassIDs which are not present in the current AVEVA™ Asset Information Management Dashboard (Asset Information Management) schema are displayed in yellow and a warning message is displayed in the tooltip. For information on how to view the AVEVA™ Asset Information Management Dashboard (Asset Information Management) server details and to download the latest schema updates, see Choose AVEVA AIM Schema & Enable Automapping .

        Adding a Characteristic Attribute

        You can add any number of Characteristic attributes to an object.

        To add a Characteristic attribute:

        1. On the Drawings tab, click Class Mappings.

        2. Select the required class from the class list. The default mappings for the class, if any, are displayed in the EIWM Object Mapping area on the EIWM tab.

        3. In the EIWM Object Mapping area, select the root of the object tree for which you want to add a characteristic attribute, right-click and select Add EIWM > Characteristic. The Characteristic attribute is added to the object tree and the Name and Value areas appear.

        4. For the Name area, do one of the following:

          • If you want to specify the value for the characteristic name directly, select the Constant option and enter a value in the Text box. The specified value is added to the Name field of the Characteristic attribute in the EIWM Object Mapping area.

            Note: You can add the value to the list by clicking the Add icon. Such values are displayed in yellow in the list. Click the Delete icon to delete the selected value from the list. When you delete a value from the list, the value is deleted from the object tree as well.

          • If you want to derive the value for the characteristic name from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Name field of the Characteristic attribute in the EIWM Object Mapping area.

          • If you want to derive the value for the characteristic name from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Name field of the Characteristic attribute in the EIWM Object Mapping area.

        5. For the Value area, do one of the following:

          • If you want to specify the value of the characteristic directly, select the Constant option and enter a value in the Text box. The specified value is added to the Value field of the Characteristic attribute in the EIWM Object Mapping area.

          • If you want to derive the value for the characteristic from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Value field of the Characteristic attribute in the EIWM Object Mapping area.

          • If you want to derive the value for the characteristic from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Value field of the Characteristic attribute in the EIWM Object Mapping area.

          Note: The characteristics without a value or a mapping are displayed in red and an error message is displayed in the tooltip. The characteristics whose name is not present in the current AVEVA™ Asset Information Management schema are displayed in yellow and a warning message is displayed in the tooltip. For information on how to view the AVEVA™ Asset Information Management server details and to download the latest schema updates, see Enable Automapping and Choose the AVEVA™ Asset Information Management Model.

          AVEVA™ Gateway for Unified Engineering enables you to specify the object's IncidentalClassID using a dedicated characteristic with the name IncidentalClassification. You can use this characteristic to define the IncidentalClassID for your object. The following image depicts an example use of the IncidentalClassification.

          The resulting EIWM file is as follows:

          Embedded Image (65% Scaling) (LIVE)

          When adding a characteristic attribute, if you have selected the value to be derived from the From Attribute option, you can specify if you want to omit those attributes that do not have a value. The Advanced Options area enables you to specify what must not be exported. For more information about how to use the options, see Advanced Options for Characteristic and Property Attributes in this section.

          Adding a Property Attribute

          You can add any number of Property attributes to an object.

          To add a Property attribute:

          1. On the Drawings tab, click Class Mappings.

          2. Select the required class from the class list. The mappings for the class, if any, are displayed in the EIWM Object Mapping area on the EIWM tab.

          3. In the EIWM Object Mapping area, select the root of the object tree for which you want to add a property attribute, right-click and select Add EIWM > Property. The Property attribute is added to the object tree and the Name, Value and Units areas appear.

          4. For the Name area, do one of the following:

            • If you want to specify the value for the property name directly, select the Constant option and enter a value in the Text box. The specified value is added to the Name field of the Property attribute in the EIWM Object Mapping area.

              Note: You can add the value to the list by clicking the Add icon. Such values are displayed in yellow in the list. Click the Delete icon to delete the selected value from the list. When you delete a value from the list, the value is deleted from the object tree as well.

            • If you want to derive the value for the property name from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Name field of the Property attribute in the EIWM Object Mapping area.

            • If you want to derive the value for the property name from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Name field of the Property attribute in the EIWM Object Mapping area.

          5. For the Value area, do one of the following:

            • If you want to specify the value of property directly, select the Constant option and enter a value in the Text box. The specified value is added to the Value field of the Property attribute in the EIWM Object Mapping area.

            • If you want to derive the value for the property from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Value field of the Property attribute in the EIWM Object Mapping area.

            • If you want to derive the value for the property from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Value field of the Property attribute in the EIWM Object Mapping area.

          6. For the Units area, do one of the following:

            • If you want to specify the value for the property units directly, select the Constant option and enter a value in the Text box. The specified value is added to the Units field of the Property attribute in the EIWM Object Mapping area.

            • If you want to derive the value for the property units from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The same is added to the Units field of the Property attribute in the EIWM Object Mapping area.

            • If you want to derive the value for the property units from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Units field of the Property attribute in the EIWM Object Mapping area.

            Note: The properties without a value or a mapping are displayed in red and an error message is displayed in the tooltip. The properties whose name is not present in the current AVEVA™ Asset Information Management schema are displayed in yellow and a warning message is displayed in the tooltip. For information on how to view the AVEVA™ Asset Information Management server details and to download the latest schema updates, see Enable Automapping and Choose the AVEVA™ Asset Information Management Model.

            Advanced Options for Characteristic and Property Attributes

            When adding a property or characteristic attribute, if you have selected the value to be derived from the From Attribute option, you can specify if you want to omit those attributes that do not have a value. The Advanced Options area enables you to specify what must not be exported.

            Do one or more of the following in the Advanced Options area depending on your requirements:

            • Select the Don't export empty/white string values check box if you do not want the attribute to be exported when the value is empty or is a white string. This check box is cleared by default.

            • Select the Don't export nullref attribute values check box if you do not want the attribute to be exported when the value is nullref. This check box is cleared by default.

            • Select the Don't export empty array values check box if you do not want the attribute to be exported when the value is an empty array. This check box is cleared by default.

            • Select the Don't export null/unset values check box if you do not want the attribute to be exported when the value is null or unset. This check box is cleared by default.

            Adding an Association Attribute

            You can add any number of Association attributes to an object.

            To add an Association attribute:

            1. On the Drawings tab, click Class Mappings.

            2. Select the required class from the class list. The mappings for the class, if any, are displayed in the EIWM Object Mapping area on the EIWM tab.

            3. In the EIWM Object Mapping area, select the root of the object tree for which you want to add an association attribute, right-click and select Add EIWM > Association. The Association attribute is added to the object tree and the Type and SourceID areas appear.

            4. For the Type area, do one of the following:

              • If you want to specify the association type directly, select the Constant option and enter a value in the Text box. The specified value is added to the Type field of the Association attribute in the EIWM Object Mapping area.

                Note: You can add the value to the list by clicking the Add icon. Such values are displayed in yellow in the list. Click the Delete icon to delete the selected value from the list. When you delete a value from the list, the value is deleted from the object tree as well.

              • If you want to derive the association type from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The attribute is added to the Type field of the Association attribute in the EIWM Object Mapping area.

              • If you want to derive the association type from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the Type field of the Association attribute in the EIWM Object Mapping area.

            5. For the SourceID area, do one of the following:

              • If you want to specify the source ID of the association directly, select the Constant option and enter a value in the Text box. The specified value is added to the SourceID field of the Association attribute in the EIWM Object Mapping area.

              • If you want to derive the value for the source ID from the value of an attribute, select the From Attribute option and select an attribute from the Attribute name list. The attribute is added to the SourceID field of the Association attribute in the EIWM Object Mapping area.

              • If you want to derive the value for the source ID from a PML expression, select the From PML option and enter a PML expression in the PML Expression box. The PML expression is added to the SourceID field of the Association attribute in the EIWM Object Mapping area.

              Important: The associations without a value or a mapping are displayed in red and an error message is displayed in the tooltip. The associations whose type is not present in the current AVEVA™ Asset Information Management schema are displayed in yellow and a warning message is displayed in the tooltip. For information on how to view the AVEVA™ Asset Information Management server details and to download the latest schema updates, see Enable Automapping and Choose the AVEVA™ Asset Information Management Model.

              Advanced Options for Association Attributes

              You can set the association owner for the element through the gateway. The following options are available:

              • This object: The object on which the association attribute is defined is consider the owner of the association. For example, if the association "is part of" is defined for a Nozzle, then the association is published as (for example)"Nozzle is a part of Equipment".

              • Referenced Object: The object which is referenced in the association is considered the owner of the association. For example, if the association "has parts" is referencing an Equipment, then association is published as (for example) "Equipment has parts Nozzle"

              • Is external reference: Select the check box if you want the association to be present in the output regardless of whether the referenced object exists or not.

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