Using View Definitions to Define Mapping - Integration - Update 44 - Help - Hexagon

Integration Help

Language
English
Product
Integration
Search by Category
Help
Smart 3D Version
12.1 (2019)
Smart Construction Version
2019(7.0)
SmartPlant Foundation / SDx Version
10
Smart Electrical Version
2019 (9.0)
Smart Materials/Smart Reference Data Version
2020 (10.0)
Smart P&ID Version
9 (2019)
Smart Review Version
2020 (15.0)
Smart Engineering Manager Version
10 (2019)
Smart Interop Publisher Version
13.1 (2019 R1)
Smart Isometrics Version
7.0(2019)
Spoolgen Version
9.0(2019)

Mapping directly against the SmartPlant schema requires a detailed understanding of that model. For many users, gaining this understanding can be an intimidating undertaking. Defining mapping using view definitions can offer a simpler alternative that can help bypass the need to have a detailed understanding of the SmartPlant schema model.

Mapping using view definitions is especially helpful because, if view definitions are configured, users are not required to search through interface definitions that a class definition realizes to find the properties that they want to map. Instead, the view definition defines pre-selected properties for an object, bypassing the need to understand what interface definition exposes which property.

The Publish and Retrieve tabs on the Edit window for map class definitions use view definitions for viewing and defining the mapping. The Overview tab on this Edit window allows the user to select the class or interface for publish and retrieve or the explicit view definition to use for publish and retrieve. If the user selects a class definition or interface definition for the mapping, the software determines if a view definition has been defined for mapping to this class or interface definition. If an existing view definition is found that is suitable for defining mapping, then that view definition will be used. If no view definition is found, then a view definition will be dynamically generated.

The SmartPlant schema contains a small set of predefined view definitions that you can use for mapping. However, not all objects for which you may want to define mapping have view definitions defined in the schema. Dynamically generated view definitions may not be as helpful as predefined view definitions for simplifying mapping.

The general approach for defining publish mapping using a view definition includes the following steps:

  • For each application map property, find a corresponding view definition property and map the application property to that view definition property.

  • When all application properties for which a corresponding view definition property was found have been mapped, evaluate the remaining application properties and determine which, of any, of those properties should still be mapped. For each application not mapped that should be mapped, either create a new property definition and add it to the view definition or find an existing property definition not in the view definition and add it to the view definition. In either case, after adding the property to the view definition, map the application property to the added view property.

  • After all map properties that should be mapped have been mapped, use the Set Application Properties Not to be Mapped button to mark the rest of the application properties as "not to be mapped" for publish and retrieve.

  • Evaluate the remaining view definition properties and determine if there are any view definition properties for which an application map property should be created. Create a new application property for each of these view properties (in some cases, the properties may exist on a related application class, and mapping across a map edge definition may be used instead of creating a new application property) and map that new application property to the view property.

  • After all view properties that should be mapped have been mapped, use the Set SmartPlant Properties Not to be Mapped button to mark the rest of the SmartPlant view definition properties as "not to be mapped" for publish and retrieve.

See Also

Tool Map Schemas