Default publish and retrieve mapping is delivered with the integrated Hexagon SmartPlant Enterprise and AspenTech products, including Smart 3D, Smart Electrical, Smart Engineering Manager, Smart Instrumentation, Smart P&ID, and Aspen Basic Engineering. However, as you configure your integrated environment, you may need to modify the delivered authoring tool mapping to meet your integration requirements.
Reasons to Modify Mapping
Changes to the authoring tool mapping for a particular application may be required for a variety of reasons:
-
A class, property, enumerated list, enumerated list entry, unit of measure list, or unit of measure that exists in both the authoring tool map schema and the SmartPlant schema is not mapped.
-
A class, property, enumerated list, enumerated list entry, unit of measure list, or unit of measure that exists in the authoring tool map schema does not exist in the SmartPlant schema and therefore is not mapped.
-
A class, property, enumerated list, enumerated list entry, unit of measure list, or unit of measure that exists in the SmartPlant schema is not mapped in the tool map schema.
-
A class, property, enumerated list, enumerated list entry, unit of measure list, or unit of measure that exists in the authoring tool is not mapped correctly for your needs.
-
A property, enumerated list, enumerated list entry, unit of measure list, or unit of measure that your company needs to publish or retrieve does not exist in the authoring tool, the tool map schema, or the SmartPlant schema.
You may also need to create the mapping for a new authoring tool that you want to integrate. All authoring tools must have an authoring tool adapter, which is a small piece of authoring tool software, to be able to integrate.
Mapping Process Overview
Once the objects that you want to map exist in both the authoring tool map schema and the SmartPlant schema (whether they are created manually or automatically by synchronize), you are ready to define the publish and retrieve mapping for those objects. In the Schema Editor, you can map tool class definitions and their properties, enumerated lists, and unit of measure (UoM) lists.
Mapping for tool properties is performed by opening the map class definition that expose those map properties. The Schema Editor supports one-to-one, one-to-many, many-to- one, and many-to-many mapping for property definitions between tool objects (described by the tool map schema) and SmartPlant objects (described by the SmartPlant schema).
Mapping that involves many tool objects on one end of the relationship is handled by defining map edge definitions in the tool map schema. Map edge definitions define navigation across relationship edges in the tool map schema and are used to get from one tool object to related specific tool objects.
Mapping that involves multiple SmartPlant objects is done using edge definitions in the SmartPlant schema. Edge definitions define navigation across relationship edges in the SmartPlant schema and are used to get from one SmartPlant object to related SmartPlant objects.
Mapping for map enumerated lists or map UoM lists is defined from the map enumerated list or map UoM list. All mapping for enumerated lists and UoM lists is one-to-one.
-
The authoring tool adapter determines the objects that you can add to your authoring tool map schema and then map for publish and retrieve. For more information, see rules for your authoring tool in the tool documentation.
-
You can find individual mapping examples for authoring tools in the Authoring Tool Mapping section.