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

AVEVA™ Gateways

Add File Node

  • Last UpdatedOct 24, 2024
  • 5 minute read

You can use the File node to specify the name of the output EIWM file for the objects. If an object is not added to a File node, the name generated EIWM file for the object is in the following format: <Name of the exported class>_<File Suffix>.xml

If an object is added to a File node, the generated EIWM file for the object is in the following format: <File Name>_<File Suffix>.xml. If you have added a folder name, a folder by the given name is created in the staging area.

To add a File node:

  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. Right-click anywhere on the empty space in the EIWM Object Mapping area and select Add File. The File node is added.

  4. Select File node. The Name, Template ID and Folder name areas are displayed.

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

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

    • 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.

  6. For the Template ID area, do one of the following:

    Note: The value of Template ID is added to each generated EIWM file as information about the file. For example, the template ID can be used by AVEVA™ Asset Information Management to find out which file is the latest.

    • If you want to specify the mapping value for the template 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.

    • 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.

  7. (Optional) For the Folder name area, do the following:

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

    • 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.

      Note: The nodes without a mapping are displayed in red. Invalid file name characters (* ? " < > |) are replaced with an underscore ("_").

Adding Information to File Node

To add information to the File node, you can either modify the default mappings or specify new mappings. Right-click the File node and select the required option.

You can add metadata, IF condition and object to a File node. For information about how to add metadata, see below. For information about how to add an IF condition, see Add Conditions for Attributes, and for information about how to add an object, see Map Object ID.

Adding Metadata to File Node

You can add metadata to the file by using the Add Metadata option.

To add metadata to the File node:

  1. Right-click the File node, and select Add Metadata. The Metadata node is added.

  2. Select the node. The name area is displayed.

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

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

    • 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.

      The metadata is added to the File node.

    Add Metadata for AVEVA Ingestion Service

    You can use the Add Metadata option to add metadata for AVEVA Ingestion Service. The options you specify here override the default options for AVEVA Ingestion Service and those specified through the General tab. For information on how to specify the AVEVA Ingestion Service options through the General tab, see Additional Settings for AVEVA Ingestion Service in Provide General Information.

    The following Name values are reserved for AVEVA Ingestion Service:

    • FILE_NAME - STRING

    • CONTEXT - STRING

    • SOURCE - STRING

    • TARGET - STRING

    • PUBLISH_ORIGINAL - true/false

    • PUBLISH_REFERENCE - true/false

    • PUBLISH_RENDITION - true/false

    • DOCUMENT_IDENTIFIER - STRING

    • REGISTER_IDENTIFIER - STRING

    • FILE_REVISION_KEY - STRING

    The following image shows three options for AVEVA Ingestion Service.

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