Advanced Class Mapping

Diagrams User Guide

Diagrams : Utilities : Gateway Mapping : Engineering Mapping : Advanced Class Mapping

Advanced class mapping allows greater control over EIWM Objects and SVG tags information.

Class mapping file class nodes can contain two types of sub nodes:

•

EIWM - where user can configure EIWM Object publish information for mapped Diagrams element. It is done by using resemblance of Object from EIWM schema with all its standard members and attributes.

•

SVG - where published element tag hotspot can be configured.

Each end node which cannot have members (marked with gray colour) can contain an attribute which controls the value of the node. There are four types of node attributes, each provides different source for the node value:

value

if a node contains this attribute with its value, the value will be simply passed to the resulting node in output EIWM or SVG file.

from_pml

this attribute allows the execution of a PML function on the current database element of class (TYPE) to which this mapping is provided. The result of this function will be placed in the resulting node in output EIWM or SVG file. Be aware that the PML function should always be formed so it will always return its value as text (string).

from_attr

using this attribute over node allows to query the current Diagram database element for a specific attribute given in the value. The value of the element attribute will be returned as string and placed in the resulting node.

from_id

Diagrams Gateway mapping processor keeps track on what EIWM Object ID has been paired with specific a Diagrams element. This attribute allows to get the Object ID for element given in the value and store it in the resulting node. This field accepts names of elements (Example: /EQUI-PUMP-1), as well as simple PML1 expressions pointing to elements in schematic hierarchy (Example: owner of owner).

Tip:

Tip: You can trace Object ID being paired with elements by looking into the log file (if it was enabled).

Each attribute can use special variables which might become useful when providing advanced mapping:


Variable name	Variable description
$GATEWAY_VERSION$	Running gateway version
$CURRENT_DATE_TIME$	Current date and time
$CURRENT_DATE$	Current date only
$DEFAULT_CONTEXT$	Default context name
$DOCUMENT_CLASS$	Document class name
$EIWM_FILE_NAME$	Current output EIWM file name
$SVG_FILE_NAME$	Current output SVG file name
$CURRENT_SCDIAG$	Current published diagram name
$CURRENT_SCPAGE$	Current published page name

Note:

The values of $DEFAULT_CONTEXT$ and $DOCUMENT_CLASS$ are taken from Gateway DiagramsConfig.xml file.