Basic Class Mapping

Diagrams User Guide

Diagrams : Utilities : Gateway Mapping : Engineering Mapping : Class Mapping : Basic Class Mapping

Standard class mapping allows mapping one class name to another.

class name of diagram elements that the data is mapped from. It is an element TYPE, which is typically used in Diagrams. This field is always required. There is also a special ALL value for this attribute (details in notes).

corresponding Class ID of EIWM Object in published data, that the data is mapped to. This attribute is only required for basic mapping.

modifier

an optional attribute which controls EIWM and SVG output behaviour:

•

untag - resulting EIWM object will not have tag hotspot (SVG) in related published drawing.

•

ignore - classes having this modifier will not be published at all (No EIWM object and no tag hotspot published for elements of this type).

•

onlytag - this modifier means that Only element tag hotspot (SVG) will be available after published and no EIWM information.

Basic mapping does not allow defining exact associations, context IDs and SVG Tags for elements, which are being published as EIWM Objects. In such case the publishing process will add default associations and context IDs depending on class (TYPE) of processed element. Defaults for each element TYPE are described in the following table:

All Diagrams elements from the table are outputted to the EIWM and SVG tag (if visible) by default. This behaviour can be changed by adding a specific modifier attribute to any class mapping.

Any default element publishing behaviours can be overridden when using advanced class mapping, which is described in the next section.

There is also one Diagrams element that is not listed in the table but also has its default behaviour:

SCDIAGRAM

Its diagram element which page is being currently published. Its default publish behaviour is:

•

Object ID - set to NAMN attribute of diagram

•

Associations - one "is fulfilled by" association with published SVG page document ($SVG_FILE_NAME$)

•

ClassID - set to $DOCUMENT_CLASS$

•

Context ID - set to $DEFAULT_CONTEXT$

•

Characteristics - four standard properties added to drawing object

•

InfoLocator - with value of current output SVG file ($SVG_FILE_NAME$)

•

InfoType - with value "image/svg+xml"

•

Date - with value of current date ($CURRENT_DATE$)

•

Version - with value of running gateway version ($GATEWAY_VERSION$)

•

It is outputted to EIWM - its EIWM Object is added at the beginning of each page EIWM file. This behaviour can be omitted by adding SCDIAG class mapping with modifier set to ignore to classmapping.xml file like this:

:Notes:


SCDIAGRAM	behaviour can also be overridden when using advance class mapping.
Term $DEFAULT_CONTEXT$	is the default context value taken from Gateway DiagramsConfig.xml file.
Term $DOCUMENT_CLASS$	is the document class setting taken from Gateway DiagramsConfig.xml file.
Term $CURRENT_SCPAGE$	is the Diagrams page element which is being published at the moment.
Term CE	is the Diagrams element which is currently (Current Element) being processed when publishing page.

Current default behaviour of drawings published to AVEVA NET Workhub Dashboard is to tag (hot spot) branch elements (tubes, fittings, instruments), with branch Object ID, with the exception of valves. This behaviour can be modified by using advanced class mapping described in later sections.

The special ALL value for the from attribute in class mapping can be used for overriding default Class ID for all unmapped elements if included in class mapping configuration file as shown below: