General Settings

General settings allow you to define the project name, description, log file path and configurations of project files. The General settings menu contains the following areas:

• General: Defines all the project related information and processing timeout details.

• Logging: Defines the log file path and log file name with log level information.

• Configurations: Defines configuration details relating to extract, transform and load.

  Note: A yellow triangle symbol near any of the panels indicates that some fields in that panel have unsaved changes or have invalid data, so you should open the panel, fix the invalid data, and save the settings within that panel.

Using Relative Paths in the Configurations

Use of relative paths for file locations makes it easier to re-use and share Gateway projects. Specify all paths in the project’s configurations in two ways by setting global paths or relative paths:

Example of Global paths in the Project file:

<transformerConfigLocator path="C:\TestProject\Configurations\TransformConfiguration.xml" />
<extractorConfigLocator path="C:\ TestProject \Configurations\ExtractConfiguration.xml" />
<loaderConfigLocator path="C:\ TestProject \Configurations\LoadConfiguration.xml" />
<log level="Warning" folderPath="C:\ TestProject\Logs" appendToLog="false" />

Example of Relative paths in the GUI:

Example of Relative paths in the Project file:

<transformerConfigLocator path=".\Configurations\TransformConfiguration.xml" />
<extractorConfigLocator path=".\Configurations\ExtractConfiguration.xml" />
<loaderConfigLocator path=".\Configurations\LoadConfiguration.xml" />
<log level="Warning" folderPath=".\Logs" appendToLog="false" />

Structure of the Project's Configuration and Mapping Files:

Assuming that the path of the project is C:\Projects\test1\test1.xml, set the other configuration files as follows:
Relative path is: .\Configurations\ExtractConfiguration.xml

Global path is: C:\Projects\test1\Configurations\ExtractConfiguration.xml

Relative Path is .\Logs

Global path is: C:\Projects\test1\Logs

Relative path is ..\Mappings\Patterns2d.xml

Global path is: C:\Projects\test1\Mappings\Patterns2d.xml

General Area

To add project-related information, such as the project name, project description and processing timeout details, use the fields in the General area.

To complete the project related information:

1. Type the Project Name and Project Description in the respective fields.

   Note: The Project Name is used as the name of the project configuration file and so cannot be empty.

2. Type the time in the Timeout (in minutes) box to define the maximum execution time of the project.

   Notes:

   • The Timeout value must be a non-negative integer. If set to 0 then no timeout is applied.

   • When processing a folder of more than one file, the timeout applies to the entire processing of all files in the folder. This behavior is modified when Separate Processing (see below) is configured to be true. In this case, the timeout applies to the time taken to process each file, and if a timeout fails on one of the files, the Gateway will continue to process any remaining file(s) in the folder.

3. Click Save Settings to save the general settings options.

Review from here: https://dev.azure.com/AVEVA-VSTS/Interoperability/_workitems/edit/4346780/

Logging Area

You can use the fields in the Logging area to specify different logging information such as warning and error messages. The Gateway produces a log file in the location defined by Log Path. The default location of Log Path is a Logs subfolder under the project file location.

If the Categorized Logs option is selected the Gateway will also create a JavaScript Object Notation (JSON) report file to display the same logging information as contained in the log text files, but groups the log entries by warnings, errors, severity, type, and so on. For more details about Categorized JSON reports, refer to For more details about Categorized JSON report, refer to Status Messages from the Gateway Processing.

Review ends here:

To specify the Logging information:

4. Type the log file path in Log Path box or click the Browse Path icon to specify the log file path.

   If the log folder path exists, it will create the logs in the specified log path. If the log folder path does not exist, it creates the folder automatically. The default name of the log file name is the name of the input file. The log files will be named as <input filename>.log.

5. Specify a Log Level to log all events greater than and equal to the specified severity level. For example, if you set the Log Level to Verbose, all errors, warnings and informational messages are logged.

   Note: The Log Level value is case-sensitive and must be one of the following: Error, Warning, Information and Verbose. The following table shows the severity standard for different Log Levels.

   Log Level	Severity
   Error	Indicates logs for an error message. An Error is an unexpected condition that is likely to result in erroneous information in the output.
   Warning	Indicates logs for an error and warning message. A Warning is a message or a notification that alerts you of a condition that may cause a problem in the future.
   Information	Indicates logs for an error, warning and other informational message. An Information is a message with a concise report of a object processing, timestamp, problem trigger, processing details and working of software modules
   Verbose	Indicates logs at all levels, that is, error, warning and informational messages. A verbose is a message that provides additional details about the activity start and end, dump data and the values of the variables and arguments that are used. This extra information is helpful during troubleshooting, but as it creates large log files this option should be avoided in normal runs.

6. Select the Append Logs box in the General settings Page to control the value of appendToLog in the configuration file. By default, the appendToLog value is deselected and false.

   The following two scenarios exist under Append Logs section:

   • If you select Append Logs box, then the first run of the Gateway project will create the log file and add messages to it. The value of appendToLog (in the project's Configuration file) is updated to true. On subsequent runs, that processes the same input source, the messages are appended to this existing log file.

   • If you deselect the Append Logs box, then each run of the Gateway project will delete the old log file if it exists and create a new log file and add messages to it.

     <log level="Warning" folderPath="C:\Users\<user_name>\Test\Logs_Appended" appendToLog="false" />

7. Click Save Settings to save the Logging area settings.

   After processing, the Gateway produces a Summary.txt file in the Project Logs folder, which contains statistics about the amount of extracted and loaded objects, project path, file processing information, number of errors and warnings and processing time.

   Statistic	Source	Description
   Number of entities extracted	Extractor	Number of engineering objects in Object Model after extraction.
   Number of SVG objects	SVG Loader	Number of 2D graphical objects in Object Model that were loaded into the output SVG file.
   Number of EIWM objects	EIWM Loader	Number of engineering objects in Object Model that were loaded into the output EIWM file. This may be different from the number of extracted engineering objects if transformation mapping has removed some objects or created new ones.

Configuration Area

To define the project configuration details, use the fields in the Configurations area.

To define the configuration settings:

8. Type the configuration details in the Extract, Transform, Load fields, respectively.

   • Extract: Provide the configuration file details to extract the engineering and graphics data from the input file(s). For new projects, a default configuration file for Extract is created, named as ExtractorConfiguration.xml.

     Note: The Extract path value must point to a valid extractor configuration file.

   • Transform: Provide the configuration file details to transform the extracted file. The configuration file for Transform is named as TransformConfiguration.xml.

     Note: The Transform path value must point to a valid transformer configuration file.

   • Load: Provide the configuration file details to load the extracted and transformed engineering file. The configuration file for Load is named as LoadConfiguration.xml.

     Note: The Load path value must point to a valid loader configuration file.

     For each specific setting, type the path of the configuration file (.xml file) or click File Selector at the end of the box. To modify the respective configuration files, click .

9. Click the icon to browse to the path of configuration settings.

10. Click Save Settings to save the Configuration field settings.

Note: Save Settings is applicable to all settings of the page. Save the settings after filling the required information in General settings.

Separate Processing

The processing of large source files can sometimes consume so much of the server’s resources that it results in system processing issues. To log these types of issues, the Gateway processing can be split between one process that loads the Gateway’s configurations and another process that executes the project defined by those configurations. This then allows the launch process to log any issue due to the executing process failing. It also allows the launch process to terminate the executing process due to a timeout or cancellation.

This function is enabled by setting <SeparateProcessing>true</SeparateProcessing>. As this is mainly relevant for only large input files, the default value is false.

Repeat processing on failure

When an executing process fails due to a temporary lack of server resources, such as when another process is using most of the resources and then terminates, then it’s possible that repeating the Gateway execution process may succeed when the system resources are available. When using Separate Processing, it’s possible to also control the number of times to attempt to retry a failed process:

<RepeatOnFailure>3</RepeatOnFailure>

The above setting means that after a failed processing of the Gateway, the executing process will be repeated up to 3 times.

Note: These settings are only available by editing the main Gateway project configuration file.