Table of Contents

Table of Contents - 2

SmartPlant Modeling and Mapping

SmartPlant Modeling and Mapping

Table of Contents - 3

1. Overview of SmartPlant _____________________________ 1-3

1.1

SmartPlant Components ____________________________________________________ 1-6

The SmartPlant Client ___________________________________________________________ 1-7

1.1.1

1.2

The SmartPlant Schema ___________________________________________________ 1-10

Authoring versus Integrated Schemas ______________________________________________ 1-15
Components of the Schema ______________________________________________________ 1-19
Introduction to Class Definitions __________________________________________________ 1-20
Introduction to Property Definitions _______________________________________________ 1-22
Introduction to Interface Definitions _______________________________________________ 1-24
Relationships _________________________________________________________________ 1-27

1.2.1
1.2.2
1.2.3
1.2.4
1.2.5
1.2.6

1.3

Authoring Tool Schemas ___________________________________________________ 1-28

1.4

Schema Mapping _________________________________________________________ 1-31

1.5

Introduction to the Schema Editor __________________________________________ 1-33

1.6

Using the Class VM Session ________________________________________________ 1-35

2. Using the Schema Editor ____________________________ 2-3

2.1

Starting the Schema Editor _________________________________________________ 2-4

2.2

Viewing an Open Schema File ______________________________________________ 2-10

Schema Tree/Properties View ____________________________________________________ 2-16
Schema Tree/Table View ________________________________________________________ 2-21
Schema Tree/Drag-Drop UML View_______________________________________________ 2-23
Interface Relationships__________________________________________________________ 2-28
Schema Tree/Viewable UML View ________________________________________________ 2-32
Editor View __________________________________________________________________ 2-36

2.2.1
2.2.2
2.2.3
2.2.4
2.2.5
2.2.6

2.3

Finding Schema Objects ___________________________________________________ 2-38

View Schema Find Tab _________________________________________________________ 2-38
Finding Objects from the Workflows Dialog
Box _______________________________ 2-45
Exiting the SmartPlant Schema Editor______________________________________________ 2-48

2.3.1
2.3.2
2.3.3

2.4

Custom Editable UML View _______________________________________________ 2-50

2.5

Change Object Display ____________________________________________________ 2-62

2.6

Change Object Color ______________________________________________________ 2-64

2.7

Placing Text in a View _____________________________________________________ 2-66

2.8

Erasing Displayed Relationships ____________________________________________ 2-70

2.9

Open a Package __________________________________________________________ 2-72

2.10

Erasing the View _______________________________________________________ 2-76

2.11

Exiting the Schema Editor _______________________________________________ 2-78

2.12

Activity 1 Using the Schema Editor ______________________________________ 2-81

2.13

Creating a Extension Schema _____________________________________________ 2-83

2.14

Activity 2 Creating a Extension Schema ___________________________________ 2-95

Table of Contents - 4

SmartPlant Modeling and Mapping

3. Meta Schema Concepts ______________________________ 3-3

3.1

Model Definitions__________________________________________________________ 3-5

3.2

Component Schemas _______________________________________________________ 3-8

Properties of a Component Schema ________________________________________________ 3-10

3.2.1

3.3

Interactive Activity Creating a Component Schema ___________________________ 3-11

3.4

Class Definitions _________________________________________________________ 3-19

Properties of a Class Definition ___________________________________________________ 3-20

3.4.1

3.5

Interactive Activity Creating a Class Definition ______________________________ 3-22

3.6

Interface Definitions ______________________________________________________ 3-29

Role Example _________________________________________________________________ 3-30
Interface Definitions and Relationships _____________________________________________ 3-32
Properties of an Interface Definition _______________________________________________ 3-35

3.6.1
3.6.2
3.6.3

3.7

Interactive Activity Creating Interface Definitions ____________________________ 3-37

3.8

Activity 1 Reviewing Schema Concepts _____________________________________ 3-49

3.9

Activity 2 Creating Objects and Relationships with Schema Editor ______________ 3-49

4. Creating Properties, Enumerated Lists, and Relationships__ 4-3

4.1

Property Definitions _______________________________________________________ 4-4

Properties of a Property Definition _________________________________________________ 4-5

4.1.1

4.2

Property Types ___________________________________________________________ 4-6

4.3

Interactive Activity Creating Property Definitions _____________________________ 4-7

4.4

Enumerated List Type ____________________________________________________ 4-38

Properties of an Enumerated List Type _____________________________________________ 4-43
Unit of Measure List Types ______________________________________________________ 4-45
Properties of a Unit of Measure List Type ___________________________________________ 4-47

4.4.1
4.4.2
4.4.3

4.5

Interactive Activity Creating an Enumerated List Property ____________________ 4-49

4.6

Relationship Definitions ___________________________________________________ 4-76

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

4.6.1
4.6.2

4.7

Shared Object Definitions __________________________________________________ 4-90

Properties of a Shared Object Definition ____________________________________________ 4-92

4.7.1

4.8

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

5. Creating EdgeDefs, Graph Defs, and View Defs __________ 5-3

5.1

Edge Definitions ___________________________________________________________ 5-4

Properties of an Edge Definition ___________________________________________________ 5-6

5.1.1

5.2

Interactive Activity Creating Edge Definitions _______________________________ 5-17

5.3

Graph Definitions ________________________________________________________ 5-32

Properties of a Graph Definition __________________________________________________ 5-34

5.3.1

5.4

Interactive Activity Creating Graph Definitions ______________________________ 5-36

SmartPlant Modeling and Mapping

5.5

Table of Contents - 5

View Definitions __________________________________________________________ 5-42

Properties of a View Definition ___________________________________________________ 5-44

5.5.1

5.6

Interactive Activity Creating View Definitions _______________________________ 5-46

Save the Changes to the Schema File ______________________________________________ 5-58

5.6.1

6. Viewing and Finding Data ___________________________ 6-3

6.1

XML Files Overview _______________________________________________________ 6-6

6.2

Opening and Viewing a Data File ____________________________________________ 6-8

Data File Tree/UML View _______________________________________________________ 6-12
Data Tree/Table View __________________________________________________________ 6-18
Data Tree/Properties View _______________________________________________________ 6-21

6.2.1
6.2.2
6.2.3

6.3

Finding Data Objects _____________________________________________________ 6-23

View Data Find Tab ____________________________________________________________ 6-23

6.3.1

6.4

Comparing Data Files _____________________________________________________ 6-29

Full Comparison ______________________________________________________________ 6-31
Detection of Tombstones ________________________________________________________ 6-43

6.4.1
6.4.2

6.5

Activity Viewing and Finding Data_________________________________________ 6-47

7. Introduction to Schema Mapping______________________ 7-3

7.1

Mapping Process Options ___________________________________________________ 7-9

7.2

Mapping Example Extending an Enumerated List ____________________________ 7-11

Extending the Authoring Tool Enumerated List ______________________________________ 7-12
Launching the CMF File ________________________________________________________ 7-17
Synchronize the Tool Data and Map File ___________________________________________ 7-24
Extending an Existing Enumerate List______________________________________________ 7-29
Mapping the Enumerate List _____________________________________________________ 7-34
Saving the Schema Changes _____________________________________________________ 7-39

7.2.1
7.2.2
7.2.3
7.2.4
7.2.5
7.2.6

7.3

Planning Changes to the SmartPlant Schema _________________________________ 7-43

7.4

Creating a Custom Interface for New Properties _______________________________ 7-46

7.5

SmartPlant Foundation Mapping Spreadsheets ________________________________ 7-51

7.6

Activity 1 Extending and Mapping an Existing Enumerated List ________________ 7-69

7.7

Activity 2 Creating the Custom Interface ___________________________________ 7-69

8. Mapping with SmartPlant P&ID ______________________ 8-3

8.1

Adding Simple Properties to the Tool Meta Schema _____________________________ 8-6

8.2

Updating the Tool Map Schema _____________________________________________ 8-10

8.3

Extend the SmartPlant Schema _____________________________________________ 8-16

8.4

Map the New Property for Publish __________________________________________ 8-24

8.5

Save the Schema Changes __________________________________________________ 8-27

Table of Contents - 6

SmartPlant Modeling and Mapping

8.6

Activity 1 Adding and Mapping a Custom Simple Property with SmartPlant P&ID 8-31

8.7

Adding a New Select List/Enum List _________________________________________ 8-33

8.8

Extend the Tool Map Schema ______________________________________________ 8-40

8.9

Extend the SmartPlant Schema _____________________________________________ 8-43

8.10

Map the New Property __________________________________________________ 8-47

8.11

Save the Mapping Changes _______________________________________________ 8-53

8.12

Activity 2 Adding and Mapping a Complex Property ________________________ 8-57

9. Extending the SmartPlant Database with Schema Changes _ 9-3

9.1

Validate the Schema Changes _______________________________________________ 9-4

9.2

Check-in the Updated CMF File _____________________________________________ 9-9

9.3

Regenerate the Component Schemas _________________________________________ 9-10

9.4

Extracting Schema Changes from the CMF File _______________________________ 9-16

9.5

Load the Changes into the SPF Database _____________________________________ 9-19

9.6

Testing the Schema Changes _______________________________________________ 9-22

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

9.6.1
9.6.2
9.6.3

9.7

Activity Loading and Testing the Schema Changes ___________________________ 9-35

10. Mapping with SmartPlant Instrumentation _____________ 10-3

10.1
10.1.1
10.1.2
10.1.3
10.1.4
10.1.5
10.1.6
10.1.7

Modifying the Authoring Tools and Mapping the New List Values ______________ 10-4
Extending an Enumerated List in SmartPlant P&ID ___________________________________ 10-5
Extending the SPPID Tool Map Schema ____________________________________________ 10-9
Extending the SmartPlant Schema and Mapping the New Value ________________________ 10-13
Saving the Map File and Schema File Changes ______________________________________ 10-17
Extending an Enumerated List in SmartPlant Instrumentation __________________________ 10-20
Extending the SPI Tool Map Schema _____________________________________________ 10-25
Mapping New Enum Entries for SPI ______________________________________________ 10-30

10.2

Modifying the View Def _________________________________________________ 10-33

10.3

Save the Schema Changes _______________________________________________ 10-37

10.4

Loading the Schema Changes ____________________________________________ 10-40

10.5

Testing the SPI Mapping ________________________________________________ 10-45

Publishing a Change from SmartPlant P&ID________________________________________ 10-46
Retrieving a Change into SmartPlant Instrumentation _________________________________ 10-52

10.5.1
10.5.2

10.6

Activity 1 Extending an Existing Enumerated List _________________________ 10-61

10.7

Creating and Mapping a Custom Property in SmartPlant Instrumentation ______ 10-63

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

10.7.1
10.7.2
10.7.3

SmartPlant Modeling and Mapping

10.8
10.8.1
10.8.2
10.8.3

10.9

Table of Contents - 7

Test the Complex Property Mapping for SPI _______________________________ 10-85

Retrieve the P&ID Drawing_____________________________________________________ 10-86
Publish the Instrument Index ____________________________________________________ 10-91
Confirm the Published Data _____________________________________________________ 10-96
Activity 2 Adding a Custom Property to SmartPlant Instrumentation ________ 10-101

11. Mapping with SmartPlant SPEL _____________________ 11-3

11.1

Adding New Simple Properties ____________________________________________ 11-5

11.2

Updating the Tool Map Schema __________________________________________ 11-11

11.3

Modifying the Custom Interface__________________________________________ 11-15

11.4

Mapping the New Property ______________________________________________ 11-20

11.5

Saving Mapping Changes _______________________________________________ 11-25

11.6

Activity 1 Adding and Mapping a Simple Property ________________________ 11-29

11.7

Adding a New Select List/Enum List ______________________________________ 11-31

11.8

Adding Enum Extensions to the Tool Schema ______________________________ 11-38

11.9

Mapping Enumeration List Entries _______________________________________ 11-40

11.10

Mapping the Complex Property __________________________________________ 11-44

11.11

Save the Mapping Changes ______________________________________________ 11-47

11.12

Test Mapped Properties ________________________________________________ 11-49

11.13

Activity 2 Adding and Mapping a Complex Property _______________________ 11-61

12. Mapping for SmartPlant 3D Overview _________________ 12-3

12.1

Adapters ______________________________________________________________ 12-4

12.2

Map Files _____________________________________________________________ 12-5

General Mapping Information ____________________________________________________ 12-6
Publish Mapping ______________________________________________________________ 12-7
Retrieve Mapping ____________________________________________________________ 12-10

12.2.1
12.2.2
12.2.3

12.3

Extending the Application Schema _______________________________________ 12-12

12.4

Loading objects into SP3D ______________________________________________ 12-17

12.5

Mapping Configuratin for Retrieve in SP3D _______________________________ 12-21

12.6

Performing Auto-mapping for SP3D Retrieve ______________________________ 12-30

12.7

Retrieving Published Objects into SP3D __________________________________ 12-35

12.8

Mapping Configuration for Publish in SP3D _______________________________ 12-38

12.8.1

12.9

Testing the SP3D Publish Mapping _______________________________________________ 12-47

Activity Mapping SP3D Properties for Publish ____________________________ 12-61