The following procedure is intended for authoring tools that do not deliver metadata adapters. To define publish mapping for tool properties, you must open the tool map class definition that exposes the properties that you want to map. If you have already opened your tool map schema and the map class definition that you want to define mapping for, you can skip to the Define Map Properties for the Map Class Definition section below and begin mapping.
-
While the Schema Editor provides flexibility for defining the types of mapping that are described in this section, the underlying authoring tool adapter ultimately defines whether the different types of mapping are supported. Therefore, you may be able to define mapping in the Schema Editor that is not supported by the authoring tool.
-
Before you define any mapping other than straightforward one-to-one mapping that does not involve tool map edge definitions or SmartPlant schema edge definitions, check the limitations of the authoring tool adapter to determine what types of mapping are supported. Authoring tool programmers who are defining mapping for their authoring tools should be aware that they are responsible for supporting, with the assistance of the Schema Component API, any Schema Editor-defined mapping that they need.
Open the Tool Map Schema and Map Class Definition that You Want to Modify
-
After you open the tool map schema that you want to edit in the Schema Editor, click View > Tool Schema.
-
Click Options on the View Schema dialog box.
-
On the View tab, select one of the Tree views or Editor views and then click OK.
If you do not see the View tab, the View dialog box is in Simple mode. Select the view that you want to use in the Form list instead.
-
In the tree view, expand the SPMapClassDef node.
-
In the tree view, double-click the map class definition that exposes the properties that you want to map.
Define Interface Definitions and Class Definitions for Publish Mapping
-
In the Edit Map Class Definition dialog box, verify that all the properties associated with this map class definition are defined in the Map properties box.
If the mapping option is either Include Generalized or Include Realized, then the properties that can be mapped for this class definition will include all
properties from the generalized or realized tool class definitions. These properties
will not appear in the Map properties box but will be displayed when the mapping is defined.
-
If properties are missing, click
beside the Map properties box, and select the authoring tool map properties for the class definition.
If the properties that you want to associate with the map class do not already exist
in the tool map schema, you can click Create in the Possible MapProperties dialog box to create them. For more information, see Create a Map Property Definition.
Define Interface Definitions and Class Definitions for Publish Mapping
-
In the Edit Map Class Definition dialog box verify that the SmartPlant schema classes definitions or interfaces definitions to which this tool class maps for publish are defined in the Publish to SmartPlant Class/Interface box.
-
If you need to add or modify class definitions or interface definitions, click
beside the Publish to SmartPlant Class/Interface box, and select the SmartPlant schema class definitions or interface definitions
to which you want to map for publish operations.
-
Most mapping between map class definitions and the SmartPlant schema should be done using SmartPlant interface definitions instead of class definitions. The authoring tool adapter defines whether an application supports mapping to interface definitions instead of class definitions.
-
If you map to interface definitions, you should map to the primary interface definitions for the SmartPlant objects that the tool class definition corresponds to.
-
If the authoring tool does not publish the map class definition, you are not required to select a SmartPlant schema class definition or interface definition for mapping.
-
-
Under Publish map, click Map Properties to define property mapping for publish operations.
-
In the Source tree in the Publish Map for Class Definition window, expand the SmartPlant class definition or interface definition to which you want to map tool properties.
Nodes in bold text are edge definitions to other objects in the SmartPlant schema.
Clicking + to expand the nodes displays the properties available across those edge
definitions. If the underlying tool adapter does not support mapping across edge definitions
(for example, one-to-many or many-to-many mapping), then any mapping defined using
properties exposed by expanding these edge definitions will not actually be used and
might cause the tool adapter to fail.
Define One-to-One Mapping for Published Properties
-
If you want to define one-to-one mapping between a property in the SmartPlant schema and a property in the tool, drag a property from the Source tree to the Maps to Property column for the tool property that you want to map.
-
You can map many properties from the SmartPlant schema to one property in the tool map schema by dragging and dropping more than one property onto the Maps to Property column for a single SmartPlant schema property. However, not all tool adapters support mapping one tool property to multiple SmartPlant properties.
-
You can map multiple tool properties to one SmartPlant property by dragging and dropping one SmartPlant property multiple times onto the Maps to Property column for different tool properties. However, not all tool adapters support mapping one tool property to multiple SmartPlant properties.
-
To find properties and edge definitions in the source tree, define search criteria under Source tree at the bottom of the window, and then click Find first node. You can click Find first node to go to the next node in the tree that matches the criteria you defined.
-
-
If you want to map a tool property to a relationship in the SmartPlant schema, drag an edge definition from the Scope tree to the Maps to Property column for the tool property that you want to map.
Not all tool adapters support this special type of mapping. See the mapping rules
for your authoring tool for more information.
Define One-to-Many Mapping for Published Properties
-
If you want to define one-to-many mapping between the SmartPlant schema and the tool, expand an edge definition in the Source tree.
-
Edge definitions in the Source tree are in bold text. When you expand an edge definition in the Source tree, the software displays the properties across that edge definition.
-
In one-to-many mapping, one tool object corresponds to multiple SmartPlant objects.
-
-
Drag a property definition from beneath the expanded edge definition node in the Source tree to the Maps to Property column for the tool property that you want to map.
Not all tool adapters support this special type of mapping. See the mapping rules
for your authoring tool for more information.
Define Many-to-One Mapping for Published Properties
-
If you want define many-to-one mapping between the tool map schema and SmartPlant schema, expand the map class definition tree, and then expand the StartingMapEdgeDefs node to see the properties for the map edge definition in the table view at the bottom of the window.
In many-to-one mapping, multiple tool objects correspond to one SmartPlant objects.
-
Drag a property from the Source tree to the Maps to Property column for the map edge definition property that you want to map.
-
If you want to define many- to-many mapping between the tool map schema and the SmartPlant schema, expand the map class definition tree, and then expand the StartingMapEdgeDefs node to see the properties for the map edge definition in the table view at the bottom of the window.
In many-to-many mapping, multiple tool objects correspond to multiple SmartPlant
objects.
-
Drag a property definition from beneath an expanded edge definition node in the Source tree to the Maps to Property column for the map edge definition property that you want to map.
Edge definitions in the Source tree are in bold text. When you expand an edge definition in the Source tree, the software displays the properties across that edge definition.
Not all tool adapters support this special type of mapping. See the mapping rules
for your authoring tool for more information.
Define Mapping Automatically
-
Click the Auto-correlate unmapped properties to allow the Schema Editor to automatically map unmapped properties to properties in the SmartPlant schema.
The Schema Editor uses the automation software that you select to do this mapping.
The automation software determines the rules used for mapping.
-
Click Auto-create unmapped properties to allow the Schema Editor to create SmartPlant schema properties that correspond to the unmapped tool properties and defines the mapping between the new SmartPlant schema properties and the tool properties.
The Schema Editor uses the automation software that you select to create these properties
and do the mapping. The automation software determines the type information to create
the properties and the rules used for mapping.
-
Click Auto-create relationship definitions to create relationship definitions in the SmartPlant schema based on your selections.
Save Publish Mapping for Properties
-
Click OK to save the publish mapping for the map class definition and return to the Edit Map Class Definition dialog box.
-
Click OK in the Edit Map Class Definition dialog box to save the updated map class definition.
-
Publish and retrieve mapping do not have to be the same for the map class definition or the map properties definitions.
-
Not all properties are mapped for both publish and retrieve.