Work with the Registers Gateway

You can run a predefined set of operations by executing commands using the command line interface of the Gateway. You can also run custom operations that you create in Gateway.

Setting up the Configuration Files

You can set up the Input Folder Structure to run the Registers Gateway. This input folder contains the Configuration folder containing the regi.json file and config file.

• The regi.json file in the Configuration folder contains the staging area path and the source data path.

• The staging area folder contains the EIWM file to be imported into AIM and the Source data folder contains the input data in the form of .csv and .xslx files.

You can use the following input files to process in the Registers Gateway.

Regi.json File

Java Script Object Notation (JSON) file is used to send, receive, and store the data. It enables faster accessibility, memory optimization, contain easy-to-use syntax and tags in readable format. The JSON files are categorized to help you decide the types of actions to resolve any issues.

This .json file will be in the configuration folder under the root project folder and this can also be present at individual operational sub-folders such as ism, edw, and gateways.

The Register gateway first considers the regi.json file located at the operational sub-folders like ism, edw, gateways and then navigates upwards and considers regi.json file located at the project folder.

If same variables are present in both regi.json file then both regi.json files will be merged. The value from the regi.json present in operation folder will be considered for subsequent operation.

The regi.json file also contains other global variables like ClassLibraryPath and

LogPath, is used across the Registers Gateway application.

The following screenshot displays the structure of a regi.json file:

Config File

The Config file is an XML file located at the Configuration sub-folder. This file contains the definition of a pipeline.

The configuration files are a set of instructions for the Register Gateway to perform the following operations:

• Process the ISM Class Library

• Perform the Capture, Interpret, Consolidate and Publish steps

• Run gateways such as AC2D, DIG, and PID

• Publish data to the reporting database

The configuration file reads the variables from the regi.json file, from the staging area path. Configuration file picks up the raw data and processes it, as shown in the following screenshot:

Processing Configuration Files

This section describes about how to process the Configuration files, ISM, Engineering Data Warehousing (EDW) and Gateways.

Processing ISM Files

To run the Registers Gateway with the configuration to process ISM ClassLibrary, you need to have the Class library path defined in the regi.json file. ISM Class library config files must be under configuration\regi\ism folder.

Note: The regi.json file under regi folder contains the root file that contains the global variables. This file must have a ClassLibraryPath variable, which holds the path to the ISM ClassLibrary XML file.

Variables that are specific to ISM are stored in regi.json file located under ism folder (shell-bukom\configuration\regi\ism\regi.json), as shown below:

• Staging: This variable holds the path to which the output should be written when you process the ISM class library.

• LogPath: This variables indicates the path where logs will be written.

  

Command

The following command is used to execute the Register Gateway to process ISM ClassLibrary:

Syntax:

AVEVA.Registers.Gateway.exe <Path to project folder>\configuration\regi\ism\all.cfg

Example:

AVEVA.Registers.Gateway.exe D:

\av\Code\aveva.apx.registersgateway.configurations\shell-bukom\configuration\regi\ism\all.cfg

Processing the Engineering Data Warehousing (EDW)

EDW is a process which the reads the input data from CSV and .xslx files and applies the standards defined in the ISM and transforms these data into EIWM format. This processing of EDW configurations consists of four different stages: capture, interpret, consolidate and publish.

The Registers Gateway performs these operations at different stages by running the update-main.cfg file located in <Path to project folder> \configuration\ regi\edw folder. The update-main.cfg file executes the configurations related to each stage sequentially.

Alternatively, you can use the Gateway to process theses configuration files at stages independently. However, you must use the Registers Gateway to process the configurations files in all the four stages to generate the EIWM output.

The following are the four stages of processing of EDW configurations:

• Capture: To perform the Capture operation individually by running the Registers Gateway, you can use the capture.cfg file as an input configuration. Configuration path: <Path to project folder> \configuration\ regi\edw\capture.cfg

• Interpret: To perform Interpret operation individually by running the Registers Gateway, you can use by passing interpret.cfg file as an input configuration. Configuration path: <Path to project folder> \configuration\ regi\edw\interpret.cfg

• Consolidate: To perform Consolidate operation individually by running the Registers Gateway by passing consolidate.cfg file as an input configuration. Configuration path: <Path to project folder> \configuration\ regi\edw\consolidate.cfg

• Publish: Publish operation has the following two steps:

  • Publish the interpreted master source to the EDW AIM Staging Area. To perform this operation, publish-operational.cfg must be used. Configuration path: <Path to project folder> \configuration\ regi\edw\publish-operational.cfg

  • Publish the interpreted data sources to the EDW AIM Staging Area. To perform this operation, publish-interpreted-all.cfg must be used. Configuration path: <Path to project folder> \configuration\ regi\edw\publish-interpreted-all.cfg

Processing the Gateways

The Register Gateway executes different gateways like AutoCAD 2D (AC2D) Gateway, Document Indexing Gateway (DIG), P&ID Gateway and so on, to process different file types. As a pre-requisite, these gateways need to be installed to invoke the gateways. Register Gateway invokes the configuration files for respective gateways to process different Gateways. During the processing of configuration files, the Register Gateway will look for all the files in the input folder and execute the respective gateway against each file.

• Gateway Configuration Tool (GCT): GCT must to be installed as this can invoke different gateways internally such as AC2D and so on. By default, GCT executable file is present in the following system location: C:\ProgramFiles\AVEVA\AVEVA NET Gateways\Gateway Configuration Tool\GatewayConfig.exe.

  Syntax for AC2D:

  AVEVA.Registers.Gateway.exe <Path to project folder>\configuration\ regi\gateway\run_ac2d_folder.cfg

  Example:

  AVEVA.Registers.Gateway.exe D:

  \av\Code\aveva.apx.registersgateway.configurations\shell-bukom\configuration\ regi\gateway\run_ac2d_folder.cfg

• Document Indexing Gateway (DIG): To process the DIG gateway, the Registers Gateway needs to invoke the installer of DIG gateway. The executable (.exe file) for DIG is present in the below location:

  C:\Program Files\AVEVA\AVEVA NET Gateways\Document Indexing Gateway\AVEVA.NET.Document.Indexing.Gateway.exe

  Syntax for DIG:

  AVEVA.Registers.Gateway.exe <Path to project folder>\configuration\ regi\gateway\run_dig_folder.cfg

  Example:

  AVEVA.Registers.Gateway.exe D:

  \av\Code\aveva.apx.registersgateway.configurations\shell-bukom\configuration\regi\gateway\run_dig_folder.cfg

• Configuration files for gateways are located under project folder: Path to project folder>\configuration\regi\gateway.

  You can invoke the config file for different gateways such as PID, AC2D and DIG in the Registers Gateway and run those gateways.

  For example, to run the AC2D Gateway, the Register Gateway needs to invoke the run_ac2d_folder.cfg file. This config will invoke the run_ac2d_file.cfg internally. This config file can be located in the above folder location.

• Input for Gateways: Input files for gateways are placed in a folder (gateways\inputs) under a project folder, with a specific folder for each gateway: Path to project folder>\gateways\inputs.

  For example, the input file for AC2D gateway will be in the ac2d folder under Path to project folder>\gateways\inputs.