Overview
- Last UpdatedJan 15, 2025
- 3 minute read
The Registers Gateway captures, interprets and consolidates the required information and publishes the engineering information as EIWM XML files. The input files can be from various 1D sources such as, engineering design tools, operational data and document management systems (DMS). The output EIWM file can be loaded directly into AIM. The Registers Gateway is a text-only interface where you can provide the inputs as a command line argument.
Characteristics of the Registers Gateway
The following are characteristics of the Registers Gateway.
-
Transforms the extracted data from input files.
-
Regi.json file: declares the global variables and custom variables to support the Registers Gateway process.
-
Configuration file: contains instructions for the Registers Gateway to perform different operations such as Capture, Interpret, Consolidate and Publish.
-
Provides a detailed log describing general information about the processed data.
-
Uses ISM to design a query form to be used in AIM.
-
Uses ISM to define standards to process the input data.
-
Uses the configuration files to write to the reporting database.
Key Processes
Information is managed by four key processes.
-
Extract is responsible for extracting information, which may be either a delta or full update, as appropriate for the interface.
-
Capture manages the capturing of information and tracking of changes at an interface level. The capture of information requires an ID for each record – if an ID is not established the record will be omitted. Capture is greedy, recording as much information as is provided, and if a record with the same ID is encountered multiple times, the last encounter will win.
-
Interpret is responsible for interpreting (mapping) or reinterpreting information using the current (active) class library/standard from ISM and managing this state at interface level. The Interpret process maps captured fields to attributes and translates records to classified objects aligned with the class library (in the case of a primary register). If the active class library is changed (for example, adding new rules that were not known previously, or changing class library mapping rules for interfaces), then any captured information will be reinterpreted according to the new Active Standard when executing the next update. This explains why changes in the class library, even minor updates can result in significantly increased processing times during the execution of the next update. The interpret process may also generate attributes from ValueExpression rules defined on the register and define reference attributes (associations).
-
Consolidation is responsible for consolidating (combining) records from all registers within a category to form a holistic view of an object and tracking changes up to this state. This process combines all interpreted records with a matching ID in a single category into a consolidated record with a simple rule that a higher priority record (priority as defined by the information interface) will win over a lower priority, and a more recently updated record will win over an older record (when the priority is the same).
Additionally, the Registers Gateway supports withdrawing which allows an interface to be removed from one or more of the capture, interpret and consolidation processes.
Hardware Requirements
It is recommended that the following hardware requirements need to be met before working with the Registers Gateway.
|
Component |
minimum |
recommended |
|---|---|---|
|
Memory |
16 GB |
32 GB |
|
Hard Disk Drive |
80 GB |
|
|
CPU |
Intel® Xeon® processor, 3 GHz, Dual core |
Intel® Xeon® processor, 3 GHz, Quad core |
Data Formats
Register data may be updated from different formats. Multiple formats may be supplied in a single update transaction.
|
Format |
Description |
|---|---|
|
CSV Strict (RFC4180) |
CSV data is read using strict RFC4180 rules, optionally specifying an alternate separator, new line and quote strings (multi-character permitted). |
|
TAB Strict (RFC4180) |
Same as CSV Strict, with a TAB character separator. |
|
EXCEL |
XLS or XLSX files. |
|
CSV Relaxed |
CSV is read as Excel reads, which may in some cases read data incorrectly where quoting is incorrect. |
|
TAB Relaxed |
Same as CSV Relaxed, with a TAB character separator. |
|
EIWM XML |
AIM EIWM XML format, with root objects and datasets only. |
|
XML Simple |
XML is read with a simple XPath expression. |
|
JSON Simple |
JSON is read with a simple JPath expression. |