7/28/2019 TSPE3242

1/7

7/28/2019 TSPE3242

2/7

Table of Contents - 2 SmartPlant Modeling and Mapping

7/28/2019 TSPE3242

3/7

SmartPlant Modeling and Mapping Table of Contents - 3

1. Overview of SmartPlant _____________________________ 1-31.1 SmartPlant Components ____________________________________________________ 1-6

1.1.1 The SmartPlant Client ___________________________________________________________ 1-71.2 The SmartPlant Schema ___________________________________________________ 1-10

1.2.1 Authoring versus Integrated Schemas ______________________________________________ 1-151.2.2 Components of the Schema ______________________________________________________ 1-191.2.3 Introduction to Class Definitions __________________________________________________ 1-201.2.4 Introduction to Property Definitions _______________________________________________ 1-221.2.5 Introduction to Interface Definitions _______________________________________________ 1-241.2.6 Relationships _________________________________________________________________ 1-27

1.3 Authoring Tool Schemas ___________________________________________________ 1-281.4 Schema Mapping _________________________________________________________ 1-311.5 Introduction to the Schema Editor __________________________________________ 1-331.6 Using the Class VM Session ________________________________________________ 1-35

2. Using the Schema Editor ____________________________ 2-32.1 Starting the Schema Editor _________________________________________________ 2-42.2 Viewing an Open Schema File ______________________________________________ 2-10

2.2.1 Schema Tree/Properties View ____________________________________________________ 2-162.2.2 Schema Tree/Table View ________________________________________________________ 2-212.2.3 Schema Tree/Drag-Drop UML View_______________________________________________ 2-232.2.4 Interface Relationships __________________________________________________________ 2-282.2.5 Schema Tree/Viewable UML View ________________________________________________ 2-322.2.6 Editor View __________________________________________________________________ 2-36

2.3 Finding Schema Objects ___________________________________________________ 2-382.3.1 View Schema Find Tab _________________________________________________________ 2-382.3.2 Finding Objects from the Workflows Dialog Box _______________________________ 2-452.3.3 Exiting the SmartPlant Schema Editor ______________________________________________ 2-48

2.4 Custom Editable UML View _______________________________________________ 2-502.5 Change Object Display ____________________________________________________ 2-622.6 Change Object Color ______________________________________________________ 2-642.7 Placing Text in a View _____________________________________________________ 2-662.8 Erasing Displayed Relationships ____________________________________________ 2-702.9 Open a Package __________________________________________________________ 2-722.10 Erasing the View _______________________________________________________ 2-762.11 Exiting the Schema Editor _______________________________________________ 2-782.12 Activity 1 Using the Schema Editor ______________________________________ 2-812.13 Creating a Extension Schema _____________________________________________ 2-832.14 Activity 2 Creating a Extension Schema ___________________________________ 2-95

7/28/2019 TSPE3242

4/7

Table of Contents - 4 SmartPlant Modeling and Mapping

3. Meta Schema Concepts ______________________________ 3-33.1 Model Definitions__________________________________________________________ 3-53.2 Component Schemas _______________________________________________________ 3-8

3.2.1 Properties of a Component Schema ________________________________________________ 3-103.3 Interactive Activity Creating a Component Schema ___________________________ 3-113.4 Class Definitions _________________________________________________________ 3-19

3.4.1 Properties of a Class Definition ___________________________________________________ 3-203.5 Interactive Activity Creating a Class Definition ______________________________ 3-223.6 Interface Definitions ______________________________________________________ 3-29

3.6.1 Role Example _________________________________________________________________ 3-303.6.2 Interface Definitions and Relationships _____________________________________________ 3-323.6.3 Properties of an Interface Definition _______________________________________________ 3-35

3.7 Interactive Activity Creating Interface Definitions ____________________________ 3-373.8 Activity 1 Reviewing Schema Concepts _____________________________________ 3-493.9 Activity 2 Creating Objects and Relationships with Schema Editor ______________ 3-49

4. Creating Properties, Enumerated Lists, and Relationships __ 4-34.1 Property Definitions _______________________________________________________ 4-4

4.1.1 Properties of a Property Definition _________________________________________________ 4-54.2 Property Types ___________________________________________________________ 4-64.3 Interactive Activity Creating Property Definitions _____________________________ 4-74.4 Enumerated List Type ____________________________________________________ 4-38

4.4.1 Properties of an Enumerated List Type _____________________________________________ 4-434.4.2 Unit of Measure List Types ______________________________________________________ 4-454.4.3 Properties of a Unit of Measure List Type ___________________________________________ 4-47

4.5 Interactive Activity Creating an Enumerated List Property ____________________ 4-494.6 Relationship Definitions ___________________________________________________ 4-76

4.6.1 Properties of Relationship Definitions ______________________________________________ 4-794.6.2 Interactive Activity Creating Relationship Definitions ________________________________ 4-82

4.7 Shared Object Definitions __________________________________________________ 4-904.7.1 Properties of a Shared Object Definition ____________________________________________ 4-92

4.8 Activity Creating Properties, Enumerated Lists and Relationships ______________ 4-93

5. Creating EdgeDefs, Graph Defs, and View Defs __________ 5-35.1 Edge Definitions ___________________________________________________________ 5-4

5.1.1 Properties of an Edge Definition ___________________________________________________ 5-65.2 Interactive Activity Creating Edge Definitions _______________________________ 5-175.3 Graph Definitions ________________________________________________________ 5-32

5.3.1 Properties of a Graph Definition __________________________________________________ 5-345.4 Interactive Activity Creating Graph Definitions ______________________________ 5-36

7/28/2019 TSPE3242

5/7

SmartPlant Modeling and Mapping Table of Contents - 5

5.5 View Definitions __________________________________________________________ 5-425.5.1 Properties of a View Definition ___________________________________________________ 5-44

5.6 Interactive Activity Creating View Definitions _______________________________ 5-465.6.1 Save the Changes to the Schema File ______________________________________________ 5-58

6. Viewing and Finding Data ___________________________ 6-36.1 XML Files Overview _______________________________________________________ 6-66.2 Opening and Viewing a Data File ____________________________________________ 6-8

6.2.1 Data File Tree/UML View _______________________________________________________ 6-126.2.2 Data Tree/Table View __________________________________________________________ 6-186.2.3 Data Tree/Properties View _______________________________________________________ 6-21

6.3 Finding Data Objects _____________________________________________________ 6-236.3.1 View Data Find Tab ____________________________________________________________ 6-23

6.4 Comparing Data Files _____________________________________________________ 6-296.4.1 Full Comparison ______________________________________________________________ 6-316.4.2

Detection of Tombstones ________________________________________________________ 6-43

6.5 Activity Viewing and Finding Data _________________________________________ 6-47

7. Introduction to Schema Mapping ______________________ 7-37.1 Mapping Process Options ___________________________________________________ 7-97.2 Mapping Example Extending an Enumerated List ____________________________ 7-11

7.2.1 Extending the Authoring Tool Enumerated List ______________________________________ 7-127.2.2 Launching the CMF File ________________________________________________________ 7-177.2.3 Synchronize the Tool Data and Map File ___________________________________________ 7-247.2.4 Extending an Existing Enumerate List ______________________________________________ 7-297.2.5 Mapping the Enumerate List _____________________________________________________ 7-347.2.6 Saving the Schema Changes _____________________________________________________ 7-39

7.3 Planning Changes to the SmartPlant Schema _________________________________ 7-437.4 Creating a Custom Interface for New Properties _______________________________ 7-467.5 SmartPlant Foundation Mapping Spreadsheets ________________________________ 7-517.6 Activity 1 Extending and Mapping an Existing Enumerated List ________________ 7-697.7 Activity 2 Creating the Custom Interface ___________________________________ 7-69

8. Mapping with SmartPlant P&ID ______________________ 8-38.1 Adding Simple Properties to the Tool Meta Schema _____________________________ 8-68.2 Updating the Tool Map Schema _____________________________________________ 8-108.3 Extend the SmartPlant Schema _____________________________________________ 8-168.4 Map the New Property for Publish __________________________________________ 8-248.5 Save the Schema Changes __________________________________________________ 8-27

7/28/2019 TSPE3242

6/7

Table of Contents - 6 SmartPlant Modeling and Mapping

8.6 Activity 1 Adding and Mapping a Custom Simple Property with SmartPlant P&ID 8-318.7 Adding a New Select List/Enum List _________________________________________ 8-338.8 Extend the Tool Map Schema ______________________________________________ 8-408.9 Extend the SmartPlant Schema _____________________________________________ 8-438.10 Map the New Property __________________________________________________ 8-478.11 Save the Mapping Changes _______________________________________________ 8-538.12 Activity 2 Adding and Mapping a Complex Property ________________________ 8-57

9. Extending the SmartPlant Database with Schema Changes _ 9-39.1 Validate the Schema Changes _______________________________________________ 9-49.2 Check-in the Updated CMF File _____________________________________________ 9-99.3 Regenerate the Component Schemas _________________________________________ 9-109.4 Extracting Schema Changes from the CMF File _______________________________ 9-169.5 Load the Changes into the SPF Database _____________________________________ 9-199.6 Testing the Schema Changes _______________________________________________ 9-22

9.6.1 Modify the P&ID Drawing Data __________________________________________________ 9-249.6.2 Publish the P&ID Drawing ______________________________________________________ 9-269.6.3 Checking the Published File for New Properties ______________________________________ 9-30

9.7 Activity Loading and Testing the Schema Changes ___________________________ 9-3510. Mapping with SmartPlant Instrumentation _____________ 10-310.1 Modifying the Authoring Tools and Mapping the New List Values ______________ 10-4

10.1.1 Extending an Enumerated List in SmartPlant P&ID ___________________________________ 10-510.1.2 Extending the SPPID Tool Map Schema ____________________________________________ 10-910.1.3 Extending the SmartPlant Schema and Mapping the New Value ________________________ 10-1310.1.4 Saving the Map File and Schema File Changes ______________________________________ 10-1710.1.5 Extending an Enumerated List in SmartPlant Instrumentation __________________________ 10-2010.1.6 Extending the SPI Tool Map Schema _____________________________________________ 10-2510.1.7 Mapping New Enum Entries for SPI ______________________________________________ 10-30

10.2 Modifying the View Def _________________________________________________ 10-3310.3 Save the Schema Changes _______________________________________________ 10-3710.4 Loading the Schema Changes ____________________________________________ 10-4010.5 Testing the SPI Mapping ________________________________________________ 10-45

10.5.1 Publishing a Change from SmartPlant P&ID ________________________________________ 10-4610.5.2 Retrieving a Change into SmartPlant Instrumentation _________________________________ 10-52

10.6 Activity 1 Extending an Existing Enumerated List _________________________ 10-6110.7 Creating and Mapping a Custom Property in SmartPlant Instrumentation ______ 10-63

10.7.1 Adding a Custom Property to SPI ________________________________________________ 10-6410.7.2 Adding the Custom Field to the Instrument Index Browser ____________________________ 10-6910.7.3 Mapping a Custom Field Value in SPI ____________________________________________ 10-75

7/28/2019 TSPE3242

7/7

SmartPlant Modeling and Mapping Table of Contents - 7

10.8 Test the Complex Property Mapping for SPI _______________________________ 10-8510.8.1 Retrieve the P&ID Drawing _____________________________________________________ 10-8610.8.2 Publish the Instrument Index ____________________________________________________ 10-9110.8.3 Confirm the Published Data _____________________________________________________ 10-96

10.9 Activity 2 Adding a Custom Property to SmartPlant Instrumentation ________ 10-101

11. Mapping with SmartPlant SPEL _____________________ 11-311.1 Adding New Simple Properties ____________________________________________ 11-511.2 Updating the Tool Map Schema __________________________________________ 11-1111.3 Modifying the Custom Interface __________________________________________ 11-1511.4 Mapping the New Property ______________________________________________ 11-2011.5 Saving Mapping Changes _______________________________________________ 11-2511.6 Activity 1 Adding and Mapping a Simple Property ________________________ 11-2911.7 Adding a New Select List/Enum List ______________________________________ 11-3111.8 Adding Enum Extensions to the Tool Schema ______________________________ 11-3811.9 Mapping Enumeration List Entries _______________________________________ 11-4011.10 Mapping the Complex Property __________________________________________ 11-4411.11 Save the Mapping Changes ______________________________________________ 11-4711.12 Test Mapped Properties ________________________________________________ 11-4911.13 Activity 2 Adding and Mapping a Complex Property _______________________ 11-61

12. Mapping for SmartPlant 3D Overview _________________ 12-312.1 Adapters ______________________________________________________________ 12-412.2 Map Files _____________________________________________________________ 12-5

12.2.1 General Mapping Information ____________________________________________________ 12-612.2.2 Publish Mapping ______________________________________________________________ 12-712.2.3 Retrieve Mapping ____________________________________________________________ 12-10

12.3 Extending the Application Schema _______________________________________ 12-1212.4 Loading objects into SP3D ______________________________________________ 12-1712.5 Mapping Configuratin for Retrieve in SP3D _______________________________ 12-21

12.6 Performing Auto-mapping for SP3D Retrieve ______________________________ 12-3012.7 Retrieving Published Objects into SP3D __________________________________ 12-35

12.8 Mapping Configuration for Publish in SP3D _______________________________ 12-3812.8.1 Testing the SP3D Publish Mapping _______________________________________________ 12-47

12.9 Activity Mapping SP3D Properties for Publish ____________________________ 12-61