Tags and Documents

Using the Registers Gateway configuration, we can customize summary views for tags and documents in AIM-A.

1. Status Badge can be created thanks to addition of statusCategory = TAGOPS on the extension of the Status Enumeration list.

2. Headers Name/Title and Type are populated from Name & CLassID of the EIWM XML file.

3. Parent and Location Headers are populated thanks to "is a part of" & "is located in" associations.

4. Aliases are populated thanks to "is identified by" association.

5. Attributes appear under different sub heads in the attributes section thanks to attribute grouping in ISM.

6. Links are populated thanks to addition of AIM-A extension properties on Links Attribute.

7. Parts/Components are populated thanks to "is an assembly including" association.

8. Documents and 3D Models are populated thanks to "is referenced by" association.

9. Events are populated thanks to "has event" association.

10. Activities and Tasks are populated thanks to "has task" association.

11. Relationship explorer is populated thanks to the different associations utilized.

Populate Name and Type

Headers Name/Title and Type are picked up from Name & ClassID of the EIWM XML file.

In order to publish, Name header, NameColumn property (parameter of each register) needs to be configured. Likewise, if we want to display Type Header, you need to configure ClassID property.

Name and type configuration should be done in the Registers configuration fragment in ISM.

Input file

Register configuration

In this case, a value expression is used to combine column Plant, Category and Function on the Name column.

Attribute grouping

Attribute’s grouping configured in ISM will be displayed in the AIM-A dashboard on the summary views of tags.

Attributes groups are done in the Standards fragment in ISM.

12. Look up list of attributes groups (enumeration tab).

13. Adding new group to the list.

14. Aspect = Enumerations.AttributeGroups defined.

    

15. Assign the desired group to each attribute.

    

16. Groups and their attributes will be displayed at a class level in ISM.

Populate Parent header and parts components

Parent Header is populated thanks to "is a part of" association.

Parts/Components are populated thanks to "is an assembly including" association.

Parent Header and Parts/Components configurations should be done in the Registers configuration fragment in ISM.

Input file

Register configuration

In this case, there is a ParentTag column that has the parent of each tag. In order to display the parents on the header of the summary views, we need to build associationType = is a part of. In addition, we could put a ValueExpression with the condition If ParentTag column is blank, then set it to System else set it to ParentTag (optional).

In order to publish Parts/Components, we would need to use opposite direction of the association of parent header, is an ‘assembly including’. This association needs to be configured within each register on a column level.

Populate location

Location Headers are populated thanks to "is located in" association.

Location headers configurations should be done in the Registers configuration fragment in ISM.

Input file

ISM configuration

An association between tag object and general object (for example, area) need to be created but both objects need to be created by a primary register. For example, Attribute Area code is permissible for Cable (electrical and signal cable ).

External links and views

Links are populated due to addition of AIM-A extension properties on the Links Attribute.

Links configurations should be done in the Registers configuration fragment in ISM.

Under External Views you can embed the content of the URL in an <iframe> HTML element. It streams and displays the image specified in the URL.

Input file

In this case, just read the links directly from the input register column.

ISM configuration

You must raise a CDO ticket to whitelist the URLs.

In order to configure the links, select DataType = Uri on the specific attribute that contains the links for tags.

The name given against the Link Button is what you will see in the AIM-A dashboard.

Hide Attribute will hide the attribute from the attributes panel, avoiding duplicating the attribute display in two places, that is, in the attribute panel and in the external view and links.

ExternalViewName gives you the flexibility to stream the contents of the URL to an embedded <iframe> HTML element in AIM-A. It is the name you see in the external view.

These three settings alone will take care of adding the new link button and external link.

Icons

The symbol used to represent objects can be changed. AIM-A has a repository of icons that can be used to customize the summary views of tags and documents. Icons configurations are done in the Standards fragment in ISM.

For example, list of icons to be used to customise summary views.

ISM configuration

In order to change default icon of a specific class type, it is necessary to use property ClassIcon = iconname.gif on a class level configuration within Extension tab.

Status badges

Status badges is a flag within the summary view of tags or documents that display the current status of the object. Value of the flags can be modified. For example, status of tags can be Active or Void. Or status for documents can be Current or Historical.

The values of these flags are not fixed. Each AIM-A dashboard can use the most appropriate ones according to the needs.

Status badges can also be used to show important information.

Part of Status Badge configurations should be done in the Registers configuration fragment and the other part should be done in the Standard fragment in ISM.

Input file

Status information can come in many forms – Active, A, ACTIVE. In this case, valueExpressions will be used to set the status attribute to Active or void instead of having Active, A, ACTIVE, Void statuses.

ISM configuration

For the Badge to get populated, on the Tag Status enumeration, under Extensions Tab -> under Intrinsic -> AIM-> add statusCategory = TAGOPS.

Note: If you want to change the colour of the status badge then you can specify colour = red, green, yellow, orange, etc for each list item. For example, for list item Active add under extensions-> AIM-> colour = green.

Map the list items in the lookup list against the Nomenclatures found on your input data.

Adding Validation Type = Enumeration and enumeration list = Tag Status is necessary in order to complete the configuration. Doing this, the attribute that contains the values to be displayed in the badge will be connected to the enumeration list.

Register configuration

In this case, a ValueExpression property under the Status column node of GeneralTag register was added. This ValueExpression reads the column Status and if it finds the status is ACTIVE/Active/A, then it sets to Active, otherwise it sets it to Void. Thanks to the previous configuration, the badge will be printed on the summary view.

Configure hyperlinks on attributes

Attributes with clickable hyperlinks can be created on the attributes panel of tag and document summary views. These links will connect an attribute with another object so it will simply redirect you to another object summary view.

Attributes hyperlinks configurations should be done in the Standard fragment in ISM.

ISM configuration

Hyperlinks on attributes will be created with a linkClass property on an attribute level within the Extension tab. LinkClass makes a clickable reference to another object without making an actual association in the data model between them. It will point the class ID as the root class which the attribute belongs to instead.