Registers configuration for 1D data load

Register’s structure

Class library will be divided into two parts (fragments):

1. Data model, upper ontology and mapping

2. Registers gateway configuration and AIM-A dashboard configuration.

This section describes all the configurations necessary to complete part two of the class library (fragment two).

Configuration will be done on Extensions tab of the global toolbar of ISM.

In the Registers Gateway configuration, fragment two is composed of these different parts:

3. Node Information Interface: configurations related to the Registers Gateway.

4. Views node: configuration of query forms.

5. Data Sources node: list of source systems.

6. Load Template node: Name of the data source systems. This is an example name, it will depend on the data sources system you are planning to use.

7. Cable, Equipment, Instrument, SoftObjects and all nodes below Load Template: Registers configurations for the system Load Template you are importing data from. Here is where each register needs to be defined.

8. Nomenclature: property of registers that indicates which nomenclature this register should follow for the mapping.

Each register has their own structure, as explained below:

9. Load Template node: Under Data Source node, add a node for each system you are importing data from.

10. Registers. For example, Cable: Definition of Registers node.

11. Columns node: list of column names present in the input sheet which you would want to add to the output XML file. Each column node must have a property or else ISM will not export the node if the node is coming from a composition.

    Each column also represents captured and interpreted attribute data based on mapped columns.

    Columns can be either property, characteristic or association.

12. Category: parameter of a register that groups data from different interfaces into a set.

13. RegisterType: parameter of a register that defines how a register should be read.

14. IDColumn: parameter of a register that creates an object with this ID.

15. NameColumn: parameter of a register that refers to a description column in the source file so that the tag will have a name in the EIWM XML file.

16. ClassColumn or ClassDefault: parameter of a register that specifies a column in the captured data to determine the class of each record.

More parameters can be added into the register’s configuration. Please refer to specific topics to see further details about parameters.

Mapping

Mappings are done in the Standards fragment in ISM.

Once register columns are added to InfoInterface, they can be mapped to attributes, classes and UoMs in ISM.

These may be considered alternate identifiers, similar in nature to an ID, and relate an attribute to standards and systems.

Nomenclature mapping in ISM for the Registers Gateway can hold multiple values for classes.

Attribute mapping example

Class mapping example

UoM mapping example

Configuration is specified in the columns listing as a property. Units of measure provide context to the values captured from the source data.

Tag classification

Class Classifications are done in the Registers configuration fragment in ISM as part of the parameters of each register.

The Registers Gateway will classify tags based on the following parameters:

• ClassExpression: this parameter will enable a class creation using value expressions that will change the result. For example, merging the value of different columns to create the class or creating the value following a condition.

  

• ClassColumn: this parameter specifies a column to determine the Class of each object record.

  

• ClassDefault: this parameter specifies a default class to assign to an object record when ClassColumn or ClassExpression does not assign a class.

  

  Note: ClassExpression parameter has the highest priority, followed by ClassColumn and finally ClassDefault.

Registers type

Registers are defined within ISM to capture structured data from source systems. They define how the data is captured and interpreted by the Registers Gateway when loading into AIM-A, therefore a single data source system can have multiple registers of varying types.

Registers type is included in the Registers configuration fragment in ISM as part of the parameters of each register.

There are four register types:

Primary

Standard register that creates an object using an ID column (Tags/Documents), classifies objects, captures, and interprets attributes based on a column listing, and data conditioning rules. For example:

Input file

Register configuration

17. Category = Tags will group data from different interfaces into a set and you can see it in the Tags output folder of the staging area.

18. Register Type = Primary defines how a register should be captured and interpreted. Primary Register classifies an object and creates the ID in AIM-A.

19. ClassColumn = Class specifies a column in captured data to use in determining the Class of each record.

20. NameColumn = Class refers to some description column in source file so that tags will have a name in the EIWM XML file.

Secondary

Standard register used to provide additional information (enriches data). It captures all fields from source files as attributes, does not define classification. You can add attributes or associations as part of this register. For example:

Input file

Register configuration

21. Adding Nominal current property (new attribute) to the existing primary register which has classified objects.

22. Register type = Secondary captures all fields from source files as attributes.

23. IDColumn = Tag specifies a column to determine the ID of each record.

Attribute

Special register only used for loading attribute data in name-value pair format. It is used where incoming data specifies a single object attribute per record in source files, and hence are required to specify Attribute Name, Value and (optionally) Unit columns in addition to an ID.

Input file

Tags which are present inside the file (second image) are already classified using the primary register (first image).

Register configuration

24. Register Type = Attributes specifies type of register to load attributes in name-value pair format.

25. AttributeNameColumn = AttName specifies the column used to determine attribute name for each attribute record.

26. AttributeValueColumn =AttValue specifies the column used to determine attribute value for each attribute record.

Association

Special register only used for loading or removing object associations within an interface.

Input file

Documents and Tags are already existing and classified in the system by other primary registers.

Register configuration

27. New association between Documents and Tags to be added to existing data.

28. Register Type = Associations adds new association to existing data.

Capture method

Captured method is included in the Registers configuration fragment in ISM as part of the parameters of each register. It specifies how data is captured.

Partial

Data is captured as partial updates and will only add or update data. Any deletes must be explicit. By default, Capture Method is set to Partial load. For example:

Register configuration

When CaptureMethod = Partial, the Registers Gateway will add new records and update existing ones with any modification done. In other words, it will update deltas. However, deletion of records will need to be specified.

Full

Data is captured as full updates and any missing data will be marked deleted until subsequently updated. For example:

Register configuration

When CaptureMethod = Full, the Registers Gateway will remove existing data and load the data sent to the cloud on the new transaction. In other words, it will overwrite existing data.

How to Delete Objects using Capture Methods

Partial method

Use Action column and "delete where" parameter. With DeleteWhere the object will be deleted permanently. It will not be found in the database. If the object is gone from XML it means it will be removed from AIM-A as well. For example:

Register configuration

29. DeleteWhere scans the Action column and if any of the column value starts with Del, Rem then it deletes that record based on the Value Expression put on the configuration (bullet 2).

30. When using DeleteWhere parameter, you must specify a value expression with a condition to be followed. For Microsoft Excel (xls or xlsx) data sources specifies a rule which limits sheets to be processed. In this case, the Registers Gateway will remove all objects that have, in column Action, a value that starts with Del or Rem.

Prioritizations

Prioritization is included in the Registers configuration fragment in ISM as part of the parameters of each register. Priority is used to prioritize one of same objects coming from various sources (classification prioritization) and control the attribute values population (attribute prioritization). Lower the priority number, higher the importance (0 is the highest value and 999999999 is the default value for the priority). When priority is not set, then the last changed is taken.

• Attribute Prioritization: Tag V-5096 is present in Source System1 and Source System2. The attribute "Description" has different values in both source systems. Source System1 register configuration will have Priority = 10 and Source System2 register configuration will have Priority =20. This means that the Registers Gateway will pick up Description attribute value from SourceSystem1 since it has the lowest number, therefore the highest priority.

• Classification Prioritization: Tag 43-BDV-2519 is present in Source System1 and Source System2 with different classifications in both source systems. Source System1 register configuration will have Priority = 10 and Source System2 register configuration will have Priority =20. This means that the Registers Gateway will pick up classification from SourceSystem1 since it has the lowest number, therefore the highest priority.

  

UOMs Configuration and Mapping

UoMs Interpretation is included in the Registers configuration fragment in ISM.

UoMs can be found in different places, depending on which, we will use one parameter or other:

UomDefault

Used when value is mentioned in one column and default unit is based on the column of the input file. For example:

Input file

Register configuration

UomDefault property is used to configure the value of the unit of measure of all data by default.

UomColumn

Used when values and units are mentioned in separate columns of the input file. For example:

Input file

Register configuration

UomColumn property is the name of the column of the input file which has the units. In this case, it is CableLength.

UomExpression

Value expression used when values and units are mentioned in the same column of the input file. For example:

Input file

Register configuration

UomExpression/ValueExpression are properties that will contain value expression to transform the data coming from the input file into the desired results. In this case, we will create a value expression to obtain from the same field as the value, and another value expression to only obtain the unit of measure (unit symbol).

PropertyValue and PropertyUom

Used on the global configuration. It assumes all units are provided in the same way. For example:

Input file

Register configuration

The configuration is set at a register level. The highest level at which this can be configured is at the Data Sources level. Since this configuration setting is inherited, you should be able to define them on the Source Systems level and will be inherited on each of the registers which are under it.

Customized Associations

The Registers Gateway is capable of creating new associations. Those customized associations will be defined in the extensions tab of the global toolbar in ISM in the Registers Gateway fragment.

Register configuration

31. Define the permissibility of new associations. In this case, the association is permissible for Functional Classes.

32. Define new associations: sourceRole, targetRole and association name.

Create a New Association

Add the entry for newly created Association "has main tag" under the enumeration of the association list to be used within the configuration (optional). Association lists are done in the Standards fragment in ISM.

Adding Associations on the Permissible Attributes

Make the new association permissible for the attribute to be used on the desired class that has the association and configure the association on the desired classes. Associations on permissible attributes are done in the Standards fragment in ISM.