Auto-Generate UML Diagrams Based on Published Data - 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)

Tool map schema files do not provide complete information about what is published by an application. The Construct Schema View for Data Objects command addresses the lack of information by examining all the objects in a tool data file and generating a UML diagram for each class definition for which there is at least one instance in the data file. The Construct Schema View for Data Objects command is available on the shortcut menu in the Editable UML view.

Tool map schema files add to the logic built into the adapters for integrated applications. The tool map schema provides a way to extend and customize what is published. Tool map schemas are not intended to provide a detailed description of mapping for an application; much of what is published by that application can be hard-coded into the adapter. For example, the Smart P&ID map file contains no information about the relationships that are published by the software. The Smart P&ID application publishes a significant number of relationships. The logic for these published relationships is embedded in the Smart P&ID adapter.

Each UML displays the following:

  • A class definition displays all the interfaces and properties that exist for any of its instances within the data file. Interfaces and properties for a class definition that are not found in the data file are not included in the UML diagram.

  • Relationship definition for which there are relationships in the data file that apply to instances of the class definition are displayed in the UML diagram. The interface definitions at both ends of each relationship definition are displayed.

    If there are other relationships in the data file that apply to either of these interface definitions, then they are also added to the UML diagram regardless of whether they apply to the class definition for the UML diagram.

  • Interface definitions added as the result of displaying relationship definitions are connected to the class definition (through Realizes relationships) for the UML diagram as applicable.

    • For each interface definition added as the result of displaying relationship definitions that is not realized by the class definition, one or more class definitions that do realize that interface definition are added to the diagram.

    • If more than two class definitions realize the same interface definition, then the text "Realized by multiple class definitions" is added to the diagram.

A typical UML diagram generated using this command is shown below.

To view the published relationships in the Editable UML view, do the following:

  1. In the Desktop Client, check out the SmartPlant Schema CMF file.

  2. Open the CMF file and the tool map schema file using the Schema Editor.

  3. Open a data file for the appropriate integrated application.

  4. Generate the UML diagram in the Editable UML view using the Construct Schema View for Data Objects command.