Provide 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 exporting models and reports.

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

3. For the Location box, specify a location for storing the log file.

   Note: If you do not specify a location for the log file, then the log file is not generated but the data is published to the staging area. However, if you specify an incorrect location, then the data is not published at all. The location specified here also also used for storing the summary of the export.

4. 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 icons corresponding to Models and Reports to select a location each for the models and reports. These location will be used for storing the output files after the data is 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 the location is 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, 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.

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

   

   The following options are available in the Defaults section:

   

   Provide the Topic for published content, and enter a timeout value in the Timeout[s] box.

   Note: Point to Timeout[s] field to see the description of the field and its upper and lower limits.

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

6. In the Options area, select the desired option from the Mapping mode dropdown list.

   

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

Additional Settings for AVEVA Integration Service

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

The following options are available in the Models tab:

Based on the selected class type in the Classes tab, column names are populated in the Available column name drop-down.

By default, the Auto append columns from context checkbox is enabled. When selected, it automatically includes all available columns in the output.

Note: If you want to manually select the column names to be exported, uncheck the Other settings checkbox.

Publish to Aveva Integration Service

Publish to Aveva Integration Service functionality in the gateway currently supports only the Engineering data source type. It does not support Generic data source.

In the Unified Engineering Browser Access (UE Online), it is currently only possible to create data sources of types other than Engineering. This limitation exists because Unified Engineering Online does not support On-Demand access from Unified Engineering. Unified Engineering – Browser Access only supports Generic data source type.

To resolve this issue, the recommended solution is to update the AIS SDK client to use a different data source type that is supported.

To publish to Aveva Integration service:

14. In the General tab, Select the Integration Service option from the Output area.

    2. Select the Authentication Type from the dropdown list NTLM and CONNECT.

       

    3. Enter the Data API URL in the specified box.

    4. Select the Data Source Name from the dropdown list after clicking on the refresh button.

       

       

    5. In the Defaults section, provide the Topic for the published content.

    6. Enter Timeout value if required.

15. In the Classes tab, select the DB Type from the drop-down list.

    7. Select the check box corresponding to the class you want to select for export.

       

    8. Image symbol adjacent to the selected class will not appear in AIS publish since it’s 1D data.

16. In the Models tab, select the required option from Append units of measurement area.

    

    9. The following options are available:

       1. None: Select this option if you want to use the default value from the grid.

       2. Column Headers: Select this option if you want to include Column Headers with unit of measurement.

       3. Cell Values: Select this option if you want to include unit of measurement inside the cell value.

    10. From the Available Column names drop-down, select the desired option.

        4. The column is added to the Column names area.

        5. Repeat the above step to add more column names.

    11. In Other Settings, When Auto-append columns from context is enabled, gateway will automatically generate all the required column names from the engineering data grids.

17. Click Save to publish.

    

18. Use the postman tool to view the published data