Providing General Information

The General tab on the Gateway Setup window enables you to provide a description for the configuration, specify a logging level and log location. You can also specify the staging areas for when exporting grids, DB views, drawings and datasheets.

To provide the general information about the configuration, do the following on the General tab:

1. In the Basic Information area, provide a description for the configuration in the Description box.

   

   Note: The description cannot exceed 500 characters.

2. Advance mode - Allows to configure explicit mappings for specific classes.

   

   • Enabling this option will switch the configuration to mode where each class has to be explicitly selected and configured in order to be published. During the publishing using such configuration:

     • Tags of classes which are not selected (or not meeting filters defined in selection) will be omitted from publishing.

     • Tags of classes which are selected (and meeting filter defined in selection) will be published according to rules defined in "Class Mapping" sections of the configuration.

   • Disabling this option will switch the configuration to simplified mode, where there is no need to select any classes or configure mappings for it. During the publishing using such configuration:

     • Any grid, datasheet, drawing or DB View tag will be published according to default publishing rules.

       Note: In case of specific EIWM output demands, default publishing rules can be modified by manipulating gateway dedicated PMLOBJ files. The content should be modified only by administrative users with PML scripting background knowledge:

       PMLLIB\common\objects\ieddatasheetpublisher.pmlobj

       PMLLIB\common\objects\ieddbviewpublisher.pmlobj

       PMLLIB\common\objects\iedgridpublisher.pmlobj

       PMLLIB\common\objects\iedtagsdrawingpublisher.pmlobj

3. In the Logging area, do the following:

   1. For the Level option, select the level of logging required for the configuration. The following levels are available:

      • Error: If you choose this option, only error messages are logged to the file.

      • Warning: If you choose this option, error and warning messages are logged to the file. This option is selected by default.

      • Information: If you choose this option, error, warning and information messages are logged to the file.

      • Verbose: If you choose this option, error, warning, information and verbose messages are logged to the file.

        

4. For the Location box, click the Browse icon and select a location for storing the log file.

5. In the Output area, do one of the following:

   • If you want to generate the output for AVEVA™ Asset Information Management, select the File System option, and then click the Browse icon to select a location each for grids, DB views, drawings, datasheets, and reports. This location will be used for storing the output files after the grids, DB Views, drawings, datasheets are exported by the gateway.

     

     Note: If you want the output files to be picked automatically for processing by AVEVA™ Asset Information Management, you must make sure that these locations are listed as watch folders in the Import Controller and the Generate 'trigger.start' file check box is selected in the Settings > Other tab. For more information about Import Controller, refer to the AVEVA™ Asset Information Management Workhub and Dashboard Installation Guide, and for information about the Generate 'trigger.start' file check box, see Specify Common Settings for Export.

   • If you want to generate the output for AVEVA Ingestion Service, select the Ingestion Service option, and then provide the URL of the AVEVA Ingestion Service in the End Point (URL) box and the location on the Cloud for storing the output in the Folder box.

     

     For more information about how AVEVA Ingestion Service works and how to use the Cloud for storing the output files, refer to the documentation of AVEVA Ingestion Service.

   • If you want to generate the output for AVEVA Integration Service, select the Integration Service option. Select the Authentication Type from the dropdown list, and then provide the URL of the Data API in the Data API URL box and select the Data Source Name.

     

     For more information about how to publish to AVEVA Integration Service, refer Publish to AVEVA Integration Service

     For more information about how AVEVA Integration Service works, refer to the documentation of AVEVA Integration Service.

6. In the Options area, do the following:

   2. Select the desired option from the Mapping mode dropdown list.

   3. If you want to publish only the delta changes, select the Publish changes only (delta mode) checkbox. Delta publishing allows the Engineering Gateway to publish only the data that has changed since the last successful publish run for a given configuration. This reduces publish time and resource usage by skipping elements that have not been modified.

      

Additional Settings for AVEVA Ingestion Service

Additional settings are available if you want to generate the output for AVEVA Ingestion Service.

The following options are available in the Defaults section:

• Context

• Source

• Target

• Publish original

• Publish reference

• Publish rendition

  Note: These parameters are required and used by AVEVA Ingestion Service. The gateway merely provides an option to set these parameters before publishing the data. You must have knowledge about these parameters before using them. For the descriptions of these options, and their possible and default values, refer to the documentation of AVEVA Ingestion Service.

The gateway enables you to specify rules for setting the metadata of output files so that they can be processed accordingly. You can specify the rules using the Metadata section:

To specify a rule for metadata:

7. From the Context list, select whether the rule must be applied for files of Models or Reports.

8. Click Add rule to add a new rule.

9. Provide the pattern of the file for which the rule must be applied.

   Note: You can specify the file extensions as a pattern. For example, you can specify "*.xml", "*.xlsx", or "*.csv" based on your requirements.

10. Click Add attribute to specify the attribute and the value.

11. Select an attribute from the Name list and type a value for the attribute in the Value column. The rule for the metadata attribute is added.

    Note: The Name list contains attributes that are used by AVEVA Ingestion Service. The gateway merely provides an option to set these attributes before publishing the data. You must have knowledge about these parameters before using them. For the descriptions of these attributes, and their possible and default values, refer to the documentation of AVEVA Ingestion Service.

    The attribute values specified here override any default or common values.

12. To add another attribute, repeat steps 4 and 5.

    Note: To remove an attribute, click the cross icon corresponding to the attribute.

13. To add another rule, repeat steps 2 through 6.

    Note: To remove a rule, click the cross icon corresponding to the rule.

It is possible to override any of these AVEVA Ingestion Service options by adding a Metadata node under the File node of EIWM mappings for the specific class. For information on how to override the AVEVA Ingestion Service options, see Add Metadata for AVEVA Ingestion Service in Adding File Node.

The gateway enables you to specify the connection settings of AVEVA Ingestion Service. The following options are available in the Connection section:

Note: Point to a field to see a description of the field and its upper and lower limits.

Configure Variables

The Variables expander in the General tab of the Configuration Editor allows you to define named variables that can be referenced in the Integration Service context configuration. Variables provide a flexible way to define reusable values for context properties.

Note: The Variables and Context settings are available in the Engineering, Draw, and Model Gateways.

Variable types

Three variable types are supported:

Variable name rules

Variable names must be unique within a configuration. It is not possible to define two variables with the same name.

Using environment variables in variable values

Environment variables can be referenced in variable values using the following syntax:

%{Your_Environment_Variable_Name}%

If the referenced environment variable does not exist, the %{Your_Environment_Variable_Name}% placeholder is not replaced and remains as-is in the value.

Note: The Variables editor supports environment variable references (%) only. Configuration variable references ($) cannot be used in variable values.

The !!gateway Global PML Object

At the start of each publish run, the gateway initialises a global PML object called !!gateway. This object can be used in PML variable expressions to retrieve information about the current publishing operation. The object is deinitialised at the end of the publish run.

Use !!gateway.GetString('<function>') to call gateway functions. The following functions are available:

Example PML expression to build a context label containing published table names:

'/Tables: [' + !!gateway.GetString('Bundle.GetTableNamesAsString()') + ']'

For a published run containing tables Equipment and Pipes, this expression evaluates to:

/Tables: [Equipment, Pipes]

To add a variable:

14. Open the export configuration in the Configuration Editor.

15. Select the General tab.

16. Expand the Variables section.

17. Select Add (+) and choose the variable type (Constant, Constant hint, or PML).

18. Enter a unique Name and provide the corresponding value or expression.

19. Save the configuration.

20. To edit a variable, select it in the Variables list and modify the name or value as required.

21. To remove a variable, select it in the Variables list and select Remove.

Important: If a variable is used as a context property and is subsequently removed, the context property is not automatically removed. This is intentional — it allows you to redefine a variable with the same name (for example, changing a constant variable to a PML variable) without losing its reference in the context. When publishing a configuration in this state, the value for the orphaned context property will be null.