Define Retrieve Mapping for Tool Properties - Integration - Update 44 - Help - Hexagon

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

1. After you open the tool map schema that you want to edit in the Schema Editor, click View > Tool Schema.

2. Click Options on the View Schema dialog box.

3. 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.

4. In the tree view, expand the SPMapClassDef node.

   

5. In the tree view, double-click the map class definition that exposes the properties that you want to map.

Define Map Properties for the Map Class Definition

1. 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.

2. 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 Retrieve Mapping

1. In the Edit Map Class Definition dialog box, verify that the SmartPlant schema class definitions or interface definitions that map to the map class definition for retrieve operations are defined in the Retrieve to SmartPlant Class/Interface box.

   

   

   • If you need to add or modify class definitions or interface definitions, click beside the Retrieve to SmartPlant Class/Interface box, and select the SmartPlant schema class definitions or interface definitions that map to the map class definition for retrieve operations.

   • For retrieval, mapping should be defined using interface definitions rather than class definitions.

2. Under Retrieve map, click Map Properties to define property mapping for retrieve operations.

3. In the Tool Schema tree in the Map for Retrieving window, expand the tool map schema map class definition to which you want to map SmartPlant schema properties for retrieve.

   

4. In the SmartPlant Schema tree, expand the InterfaceDef node.

   The interface definitions that you see in the tree view are the ones you selected in the Retrieve to SmartPlant Class/Interface box in the Edit Map Class Definition dialog box. If an interface that you need does not appear in the tree, click Cancel and add it in the Edit Map Class Definition dialog box.

Define One-to-One Mapping for Retrieved Properties

1. If you want to do one- to-one mapping between a property in the SmartPlant schema and a property in the tool for retrieve, do the following:

   • In the top SmartPlant Schema tree, select the interface definition that exposes the property that you want to map for retrieve.

   • In the Tool Schema tree, expand the MapProperties node.

   • Drag a property from the Tool Schema tree to the Map Property Def column in the top table for the SmartPlant schema property that you want to map.

     

2. If you want to map to a tool property from a relationship in the SmartPlant schema, do the following:

   • In the top SmartPlant Schema tree, select the interface definition that exposes the property that you want to map for retrieve.

   • In the Tool Schema tree, expand the StartingMapEdgeDefs node.

     

   • Drag an edge definition from the Tool Schema tree to the Map Property Def column in the top table for the SmartPlant schema 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 Retrieved Properties

1. If you want to define one-to-many mapping between the SmartPlant schema and tool map schema, select the interface definition that is the starting point for the edge definition that you want to map for retrieve in the top SmartPlant Schema tree.

   

   In one-to-many mapping, one SmartPlant object corresponds to multiple tool objects.

2. In the Tool Schema tree, expand the StartingMapEdgeDefs node.

3. Expand the map edge definition in the Tool Schema tree to display the tool properties across that map definition.

4. Drag a tool property exposed by a map edge definition to the Map Property Def column in the top table for the SmartPlant schema 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 Retrieved Properties

1. If you want to define many-to-one mapping between the SmartPlant schema and tool map schema, select the interface definition that is the starting point for the edge definition that you want to map for retrieve in the top SmartPlant Schema tree.

   In many-to-one mapping, multiple SmartPlant objects correspond to one tool object.

2. In the bottom SmartPlant Schema tree, expand the interface definition that you selected in the top tree view.

3. Expand the Non-Special EdgeDefs for Role node.

   

4. Select the SmartPlant schema edge definition that you want to map in the tree view to display properties in the table below the tree view.

   

5. In the Tool Schema tree, expand the MapProperties node.

6. Drag a property from the Tool Schema tree to the Map Property Def column in the bottom table for the SmartPlant schema 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-Many Mapping for Retrieved Properties

1. If you want to define many-to- many mapping between the SmartPlant schema, and the tool map schema, select the interface definition that is the starting point for the edge definition that you want to map for retrieve in the top SmartPlant Schema tree.

   In many-to-many mapping, multiple SmartPlant objects correspond to multiple tool objects.

2. In the bottom tree, expand the node for the interface definition you selected in the top tree view.

3. Expand the Non-Special EdgeDefs For Role node.

4. Select the SmartPlant schema edge definition that you want to map in the tree view to display properties in the table below the tree view.

5. In the Tool Schema tree, expand the StartingMapEdgeDefs node.

6. Expand the selected map edge definition in the Tool Schema tree to display the property across that map edge definition.

7. Drag a property definition from the expanded edge definition in the Tool Schema tree to the Map Property Def column in the top table for the SmartPlant schema 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.

Save Retrieve Mapping for Properties

1. Click OK to save the retrieve mapping for the map class definition and return to the Edit Map Class Definition dialog box.

2. 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.

See Also

Create a Map Class Definition
Create a Map Edge Definition
Create a Map Enumerated List Definition
Create a Map Property Definition
Create a Map Unit of Measure List Definition
Add Objects to a Tool Map Schema
Define Mapping for a Tool Enumerated List
Define Publish Mapping for Tool Properties
Define Mapping for a Tool Unit of Measure List