100% found this document useful (1 vote)

3K views778 pages

SPF Admin Course - Modeling and Mapping PDF

Uploaded by

calebnelton

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

100% found this document useful (1 vote)

3K views778 pages

SPF Admin Course - Modeling and Mapping PDF

Uploaded by

calebnelton

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 778

SmartPlant Foundation Modeling and

Mapping
Course Guide

Version 4.X February 2010 DSPF-TP-100014A

SmartPlant Foundation Modeling and
Mapping
Course Guide

February 2010 Version 4.X

DSPF-TP-100014A
Copyright
Copyright © 2002 - 2010 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license
agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by
copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available
without proper authorization.

Restricted Rights Legend

Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c) of the
Contractor Rights in Technical Data clause at DFARS 252.227-7013, subparagraph (b) of the Rights in Computer
Software or Computer Software Documentation clause at DFARS 252.227-7014, subparagraphs (b)(1) and (2) of
the License clause at DFARS 252.227-7015, or subparagraphs (c) (1) and (2) of Commercial Computer Software---
Restricted Rights at 48 CFR 52.227-19, as applicable.
Unpublished---rights reserved under the copyright laws of the United States.
Intergraph Corporation
Huntsville, Alabama 35894-0001

Warranties and Liabilities

All warranties given by Intergraph Corporation about equipment or software are set forth in your purchase contract,
and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or
amendment of such warranties. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to
applicable technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in
this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance
with the terms of this license.
No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by
Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Trademarks
Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, SmartPlant Foundation, SmartPlant P&ID,
SmartPlant Instrumentation and INtools are registered trademarks of Intergraph Corporation. Microsoft and
Windows are registered trademarks of Microsoft Corporation. Other brands and product names are trademarks of
their respective owners.
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
1.1.1 The SmartPlant Client ___________________________________________________________1-7
1.2 The SmartPlant Schema ___________________________________________________ 1-10
1.2.1 Authoring versus Integrated Schemas ______________________________________________1-15
1.2.2 Components of the Schema ______________________________________________________1-19
1.2.3 Introduction to Class Definitions __________________________________________________1-20
1.2.4 Introduction to Property Definitions _______________________________________________1-22
1.2.5 Introduction to Interface Definitions _______________________________________________1-24
1.2.6 Relationships _________________________________________________________________1-27
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
2.2.1 Schema Tree/Properties View ____________________________________________________2-16
2.2.2 Schema Tree/Table View ________________________________________________________2-21
2.2.3 Schema Tree/Drag-Drop UML View ______________________________________________2-23
2.2.4 Interface Relationships _________________________________________________________2-28
2.2.5 Schema Tree/Viewable UML View ________________________________________________2-32
2.2.6 Editor View __________________________________________________________________2-36
2.3 Finding Schema Objects ___________________________________________________ 2-38
2.3.1 View Schema Find Tab _________________________________________________________2-38
2.3.2 Finding Objects from the Workflows Dialog Box _____________________________________2-45
2.3.3 Exiting the SmartPlant Schema Editor______________________________________________2-48
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-77
2.11 Exiting the Schema Editor _______________________________________________ 2-79
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
3.2.1 Properties of a Component Schema ________________________________________________3-10
3.3 Interactive Activity – Creating a Component Schema ___________________________ 3-11
3.4 Class Definitions _________________________________________________________ 3-19
3.4.1 Properties of a Class Definition ___________________________________________________3-20
3.5 Interactive Activity – Creating a Class Definition ______________________________ 3-22
3.6 Interface Definitions ______________________________________________________ 3-29
3.6.1 Role Example _________________________________________________________________3-30
3.6.2 Interface Definitions and Relationships _____________________________________________3-32
3.6.3 Properties of an Interface Definition _______________________________________________3-35
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
4.1.1 Properties of a Property Definition _________________________________________________4-5
4.2 Property Types____________________________________________________________ 4-6
4.3 Interactive Activity – Creating Property Definitions _____________________________ 4-7
4.4 Enumerated List Type ____________________________________________________ 4-38
4.4.1 Properties of an Enumerated List Type _____________________________________________4-43
4.4.2 Unit of Measure List Types ______________________________________________________4-45
4.4.3 Properties of a Unit of Measure List Type___________________________________________4-47
4.5 Interactive Activity – Creating an Enumerated List Property ____________________ 4-49
4.6 Relationship Definitions ___________________________________________________ 4-74
4.6.1 Properties of Relationship Definitions ______________________________________________4-77
4.6.2 Interactive Activity – Creating Relationship Definitions________________________________4-80
4.7 Shared Object Definitions __________________________________________________ 4-90
4.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-3

5.1 Edge Definitions ___________________________________________________________ 5-4
5.1.1 Properties of an Edge Definition ___________________________________________________5-6
5.2 Interactive Activity – Creating Edge Definitions _______________________________ 5-17
SmartPlant Modeling and Mapping Table of Contents - 5

5.3 Graph Definitions ________________________________________________________ 5-32

5.3.1 Properties of a Graph Definition __________________________________________________5-34
5.4 Interactive Activity – Creating Graph Definitions ______________________________ 5-36
5.5 View Definitions __________________________________________________________ 5-42
5.5.1 Properties of a View Definition ___________________________________________________5-44
5.6 Interactive Activity – Creating View Definitions _______________________________ 5-46
5.6.1 Save the Changes to the Schema File ______________________________________________5-58

6. Viewing and Finding Data ___________________________ 6-3

6.1 XML Files Overview _______________________________________________________ 6-6
6.2 Opening and Viewing a Data File ____________________________________________ 6-8
6.2.1 Data File Tree/UML View _______________________________________________________6-12
6.2.2 Data Tree/Table View __________________________________________________________6-18
6.2.3 Data Tree/Properties View _______________________________________________________6-21
6.3 Finding Data Objects _____________________________________________________ 6-23
6.3.1 View Data Find Tab ____________________________________________________________6-23
6.4 Comparing Data Files _____________________________________________________ 6-29
6.4.1 Full Comparison ______________________________________________________________6-31
6.4.2 Detection of Tombstones ________________________________________________________6-43
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
7.2.1 Extending the Authoring Tool Enumerated List ______________________________________7-12
7.2.2 Launching the CMF File ________________________________________________________7-17
7.2.3 Synchronize the Tool Data and Map File ___________________________________________7-24
7.2.4 Extending an Existing Enumerate List _____________________________________________7-29
7.2.5 Mapping the Enumerate List _____________________________________________________7-34
7.2.6 Saving the Schema Changes _____________________________________________________7-39
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
Table of Contents - 6 SmartPlant Modeling and Mapping

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
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-13
9.5 Load the Changes into the SPF Database _____________________________________ 9-16
9.6 Testing the Schema Changes _______________________________________________ 9-19
9.6.1 Modify the P&ID Drawing Data __________________________________________________9-21
9.6.2 Publish the P&ID Drawing ______________________________________________________9-23
9.6.3 Checking the Published File for New Properties ______________________________________9-27
9.7 Activity – Loading and Testing the Schema Changes ___________________________ 9-31

10. Mapping with SmartPlant Instrumentation _____________ 10-3

10.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-5
10.1.2 Extending the SPPID Tool Map Schema ____________________________________________10-9
10.1.3 Extending the SmartPlant Schema and Mapping the New Value ________________________10-13
10.1.4 Saving the Map File and Schema File Changes ______________________________________10-17
10.1.5 Extending an Enumerated List in SmartPlant Instrumentation __________________________10-20
10.1.6 Extending the SPI Tool Map Schema _____________________________________________10-25
10.1.7 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
10.5.1 Publishing a Change from SmartPlant P&ID _______________________________________10-46
10.5.2 Retrieving a Change into SmartPlant Instrumentation_________________________________10-52
SmartPlant Modeling and Mapping Table of Contents - 7

10.6 Activity 1 – Extending an Existing Enumerated List _________________________ 10-61

10.7 Creating and Mapping a Custom Property in SmartPlant Instrumentation ______ 10-63
10.7.1 Adding a Custom Property to SPI ________________________________________________10-64
10.7.2 Adding the Custom Field to the Instrument Index Browser ____________________________10-69
10.7.3 Mapping a Custom Field Value in SPI ____________________________________________10-75
10.8 Test the Complex Property Mapping for SPI _______________________________ 10-85
10.8.1 Retrieve the P&ID Drawing ____________________________________________________10-86
10.8.2 Publish the Instrument Index ____________________________________________________10-91
10.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-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
12.2.1 General Mapping Information ____________________________________________________12-6
12.2.2 Publish Mapping ______________________________________________________________12-8
12.2.3 Retrieve Mapping ____________________________________________________________12-11
12.3 Extending the Application Schema _______________________________________ 12-13
12.4 Loading objects into SP3D ______________________________________________ 12-19
12.5 Mapping Configuration for Publish in SP3D _______________________________ 12-29
12.6 Verify the SP3D Publish Mapping ________________________________________ 12-38
12.7 Activity – Mapping SP3D Properties for Publish ____________________________ 12-53
Table of Contents - 8 SmartPlant Modeling and Mapping
C H A P T E R 1
Overview/Review of
SmartPlant Integrated
Engineering Architecture
1-2 Overview/Review of SmartPlant Integrated Engineering Architecture
Overview/Review of SmartPlant Integrated Engineering Architecture 1-3

1. Overview of SmartPlant
SmartPlant supports the integration of engineering authoring tools, such as SmartPlant
P&ID, SmartPlant Electrical, SmartPlant 3D, SmartPlant Instrumentation, PDS, and
Aspen Basic Engineering. This integration addresses the flow of data as it moves from one
engineering application to another through its lifecycle.

Introduction of SmartPlant Modeling

SmartPlant is a software-based platform that allows
for integration of a wide-variety of engineering
functions that occur during the process plant life
cycle, from initial concept to decommissioning.
Tantamount to SPF is the facilitation of data flow as
data moves from one engineering software
application (such as piping & instrumentation
diagrams, electrical schematics, 3-D drawings, etc.),
to another.

© 2005. Intergraph Corp.

At the center of SmartPlant is SmartPlant Foundation, which provides the repository for
data published by the authoring tools. SmartPlant components make the exchange of data
from the authoring tools to SmartPlant Foundation and back possible.

Introduction of SmartPlant Modeling

SmartPlant Foundation (SPF) is based on a "hub-and-spoke"
model. An SPF data repository is at the hub and each
integrated software application is a spoke.

SPI

SPPID SP3D

SPF Data
Repository

3rd Party SPEL

SPMat

© 2005. Intergraph Corp.

SPF is a "loose integration" solution that allows each software application to maintain its
own data model, independent of the SmartPlant Foundation data model. The benefit of
"loose integration" is the flexibility to add or remove applications for any desired
configuration of SPF.

Overview of SmartPlant
The design of today’s SmartPlant provides the following features:
 Transfer of engineering data from one tool to another,
eliminating the manual reentry of data
 Management of change resulting from ongoing engineering in
upstream applications
 Accessibility of engineering information to other collaborators
without requiring the original engineering tools
 Recording of change in data as it moves through the plant
lifecycle
 Correlation of shared objects from multiple authoring tools.
For example, the full definition of a pump may come from
multiple disciplines (electrical, mechanical, and so on), and the
data comes from different authoring tools.
 Support for engineering workflows, especially versioning,
© 2005. Intergraph Corp.
All Rights Reserved.
approval/release, and configuration control

SmartPlant Architecture
SmartPlant Enterprise is functionality built on top of the
SmartPlant Foundation database. Each tool that integrates
with SmartPlant supports:
 The SmartPlant schema: A standard data definition
designed to facilitate the flow of engineering information
through its lifecycle. Each tool works with XML files that
are representations of this schema.
 Commands to publish, retrieve, subscribe, unsubscribe
and compare between the engineering tool and
SmartPlant Foundation database.
 An adapter that allows communication with SmartPlant.
Engineering tools Zyqad, SmartPlant P&ID, SmartPlant
Electrical, SmartPlant Instrumentation, and SmartPlant
3D, and PDS integrate with SmartPlant by providing an
© 2005. Intergraph Corp.
adapter.
All Rights Reserved.
1-6 Overview/Review of SmartPlant Integrated Engineering Architecture

The following graphic shows the architecture for SmartPlant. At the heart of the system is
SmartPlant Foundation (SPF). Each tool has an adapter (SmartPlant Adapter) that allows
for communication between the tool and the underlying SmartPlant Foundation database
and vault.

Authoring Tools
Aspen Basic Eng. SP P&ID SP Inst SP 3D SP Electrical SP Materials
Tool Tool Tool Tool
SmartPlant SmartPlant SmartPlant SmartPlant SmartPlant SmartPlant
DB PFD DB DB DB
Adapter Adapter Adapter Adapter Adapter Adapter
SmartPlant SmartPlant SmartPlant SmartPlant SmartPlant SmartPlant
Equipment Data Sheet
Client Client Client Client Client Client

Data
and/or
Picture

 View picture/document – Loaded

SmartPlant Foundation
into SPF with relationships Server
 XML contains definition of data –
Loaded into the SPF database
SPF Database

SPF
Vault
Document Data
Workflow
Management Management

SmartPlant Architecture
© 2008. Intergraph Corp.
All Rights Reserved.
Overview/Review of SmartPlant Integrated Engineering Architecture 1-7

1.1 SmartPlant Components

SmartPlant is comprised of the following components:
 SmartPlant Client – An ActiveX .dll that allows the authoring tools to register with
SmartPlant, connect to SmartPlant, and publish and retrieve data. After you install the
SmartPlant Client on the client computer with an authoring tool and register the
authoring tool project with SmartPlant, the SmartPlant Client is transparent to the
user.
 Schema Component – A suite of ActiveX components that provide functionality
surrounding the creation, parsing, validation, and comparison of the SmartPlant
schema and data.
 PDS Framework - uses the PDS Framework Manager to load documents exported
from PDS into the SmartPlant Foundation database.
1-8 Overview/Review of SmartPlant Integrated Engineering Architecture

1.1.1 The SmartPlant Client

The SmartPlant Client facilitates communication between the tool adapter and the
SmartPlant Server. The SmartPlant Client is a set of components that provide the client-
side services of SmartPlant. The SmartPlant common user interface is one part of the
SmartPlant Client along with the data services that manage the communications between
an application and the SmartPlant Server.

SmartPlant Client
The SmartPlant Client provides the methods for
communication between the tool adapter and the
SmartPlant Foundation Server.
The SmartPlant Client serves three roles:
 Communicates with SPF and returns the results of that
communication back to the tool adapter
 Calls interface methods on the tool adapter to perform
functions associated with the integration process
 Provides common user interface components that tools
may use to present a consistent UI across all SmartPlant-
enabled applications

© 2005. Intergraph Corp.

Common tools, such as Aspen Basic Engineering, SmartPlant P&ID, SmartPlant

Instrumentation, PDS, and SmartPlant 3D, as well as SmartPlant Electrical and
SmartPlant Materials, use the SmartPlant Client, the SmartPlant Adapter, and default
configuration included in order to communicate with SPF.

Tool
SmartPlant Client SmartPlant
Database

Adapter

Computer 1 SmartPlant
Client
SmartPlant
Adapter Tool
SmartPlant
Database
Adapter
SmartPlant
Tool SmartPlant Client
Database Client
Computer 3

Computer 2

SmartPlant Foundation

© 2005. Intergraph Corp.

The SmartPlant Client component work directly with a portion of the SmartPlant
Foundation software to share information. When a publish operation occurs, the
SmartPlant Foundation scheduler is responsible for loading the data from the published
XML files into the SPF database. The SmartPlant Foundation software is also responsible
for making sure that the files published from the authoring tool are placed in the
appropriate SPF vault.

SmartPlant Client
Computer 1 SmartPlant
Client

SmartPlant SmartPlant
Client Client

Computer 2 Computer 3

SmartPlant Foundation

Server
SPF
Database

SPF
Vault
© 2005. Intergraph Corp.
All Rights Reserved.

A different tool can then retrieve that same data for the next phase of design in the
engineering workflow.
Overview/Review of SmartPlant Integrated Engineering Architecture 1-11

1.2 The SmartPlant Schema

One of the key elements to full integration is to have a "schema", and enforce some kind
of rules between a "publisher" and a "retriever" of data. It should be simple for two
different systems to talk about something that they have in common, e.g., a motor, a
pump, a valve, etc. But it is really not that simple because each system has it's own idea of
what things are, and how they are used. A "schema" is simply another way of saying "a
diagrammatic representation, an outline or a model."
The SmartPlant schema describes the structure of data passed through SmartPlant along
with its rules.

SmartPlant Schema
The SmartPlant schema, effectively SPF data model,
model
provides the structure and semantics of the data that can be
published to, and retrieved from, the SPF data repository.

SmartPlant Foundation
Data Model =
Data Dictionary
© 2005. Intergraph Corp.
All Rights Reserved.
1-12 Overview/Review of SmartPlant Integrated Engineering Architecture

SmartPlant Schema
Models are used to convey the essence of what
you're talking about.

A model of a car isn't something that you really get

into and drive to the office, but it is "real-enough"
that you make the mental leap that it represents a car
strongly enough that you can actually "pretend" to
drive the car to work.
© 2005. Intergraph Corp.
All Rights Reserved.

If you think about the problem of integrating data from a lot of different software
applications, you can understand how a "model" of the data that is being passed around
might be a good way to simplify the discussion of "how do I get that valve from a P&ID
(piping diagram) into my 3-D program?"

SmartPlant Schema
A "model of a valve" is not a valve, but it can expose many
aspects of a valve, e.g., its flow-rate, its weight, its inlet size,
etc.

Some other program may not care about any of that, and just
wants to talk about the height of the valve, or about who
carries the valve "in-stock", so that it can be ordered quickly.

© 2005. Intergraph Corp.

SmartPlant Schema
Each SmartPlant Enterprise software program or "tool
tool" has
some conceptual model of a valve. When we say "tool", we're
talking about:
 SmartPlant Foundation for total information management
for the life of your plant.
 SmartPlant 3D our next generation, data-centric, rule-
driven engineering design solution.
 SmartPlant Electrical an application designed by electrical
engineers for electrical engineers.
 SmartPlant Instrumentation the industry-leading
instrumentation solution.

© 2005. Intergraph Corp.

SmartPlant Schema
SmartPlant Enterprise tools (con
(con’’t)
 SmartPlant P&ID for generating "intelligent" P&IDs and
management of related engineering data for use
throughout a plant's life.
 SmartPlant Markup a precision viewing and markup tool.
 SmartPlant Review for dynamically viewing 3D computer
models for in-depth review and analysis.

No one tool cares about "all" the possible attributes of a valve.

© 2005. Intergraph Corp.

So how does the data about "this particular valve" get “shared” between tools? Make a
"model of a valve", and share the model between the tools!

SmartPlant Schema
A "data model" is an abstract representation of the
objects that software tools can share, use, and think
about.

It makes it easy for each tool, because they can still

think about "a valve" in their own way.

It makes it easy for all tools because they can share

the concept of "this particular valve" by agreeing on
what the data model for a valve is.
© 2005. Intergraph Corp.
All Rights Reserved.

SmartPlant Schema
The SmartPlant schema defines the structure of the
SmartPlant Foundation (SPF) database, and is used as the
neutral format through which authoring tools publish and
retrieve data, independent of their specific data model.

Other functions of the SmartPlant schema include:

 Enumerated lists: engineering is full of lists of valid data
that can be applied to data values (and shared between
applications), i.e. types of valves, fluid codes, etc.
 Connectivity - engineering is as much about the
relationships between equipment as the equipment itself,
i.e. a vessel has a nozzles that connects to different
pipelines.
© 2005. Intergraph Corp.
All Rights Reserved.
Overview/Review of SmartPlant Integrated Engineering Architecture 1-15

SmartPlant Schema
SmartPlant schema functions (con’t)
 User-defined properties - Software applications provide
the means for users to specify user-defined variables.
Procedures must be established to assure that this data
is implemented in the SmartPlant schema.
 Support for Units-of-Measure, to allow clear flow of data
regardless of the units specified.
 Rules for evolving the schema, so changes to the
structure and semantics of the data can be made due to
new or changing requirements.
 Specific support for engineering concepts such
addressing process data, relationships between
equipment and nozzles, and so on.
© 2005. Intergraph Corp.
All Rights Reserved.
1-16 Overview/Review of SmartPlant Integrated Engineering Architecture

1.2.1 Authoring versus Integrated Schemas

Starting with SPF 2008, the SmartPlant schema is actually divided into two schemas, both
of which will be discussed in this class.
Both SmartPlant schemas are basically XML files, or a number of files. In an integrated
environment, this file describes the structure of the XML files generated by the authoring
tools in much the same way as a data dictionary describes the structure of a database. As
tools publish documents (data) in XML format, those documents must adhere to the
format defined by the schema to ensure that the XML data can be loaded into SmartPlant
Foundation and retrieved into the other authoring tools.
The other schema is used for objects that are not part of the integrated environment. While
this means objects that are not published and retrieved, that does not meant that this
schema is used only in standalone environements. Many objects that are integral parts of
SmartPlant Foundation are now modeled in this section of the SmartPlant schema, such as
non-pubished documents, users, functional areas and units, and so forth.
For the sake of simplicity, this text will frequently refer, generically, to the SmartPlant
schema, but to clarify, the first half of this course, the modeling chapters, will focus on the
basic concepts of modeling, using the non-integrated schema. The second half of the
course, the mapping chapters, will extend on the modeling concepts to illustrate, in the
integrated schema, how to extend the SmartPlant schema for the purpose of sharing data
between authoring tools – which can include SmartPlant Foundation.

SmartPlant Schema
The SmartPlant schema is actually divided into two schemas:
SPF / Authoring Schema
 Consists of many xml files, dividing the schema information
according to the applicable layer/container
 Managed in the Schema Editor tool using a configuration
(cfg) file
Integrated Schema
 Managed in the Schema Editor as a CMF file that is stored in,
and accessed through, SmartPlant Foundation
 Allows you to manage multiple versions of the schema to
support forward/backward compatibility with authoring tools

© 2005. Intergraph Corp.

The files used for managing the Authoring schema are stored in the installation folder
(..\SmartPlant\Foundation \2009\Models). Inside the Models directory, multiple folders
separate xml files according to the layer of the data in that file. These xml files can be
managed individually, or using configuration (cfg) files to group multiple xml file
together. You may open the cfg files and xml files directly from within the Schema Editor
application.

SmartPlant Schema
 The SmartPlant
schema for
Authoring is
divided into a
number of XML
files, for each
layer/container
containing objects
or data.
 Make changes and
extensions to these
files for objects that
will be part of SPF,
but not published
in an integrated
environment.
© 2005. Intergraph Corp.
All Rights Reserved.
1-18 Overview/Review of SmartPlant Integrated Engineering Architecture

The integration schema file is managed with a CMF file. This CMF allows you to manage
changes to multiple versions of the SmartPlant schema.
As of SPF version 2008, SPF is compatible with authoring tools versions 2007 SP4 or
later. For that reason, you will need to have multiple versions of the schema. For example,
if your integrated environment includes one or more version 2007 authoring tools, you
will need to have the SPF schema for versoin 2007 for mapping, but SmartPlant
Foundation version 2009 itself uses the 2008 version of the SmartPlant schema. You will
need to have both on your SPF server. Using the CMF, file you can write changes to
multiple versions of the schema at once.
The CMF file is managed by SmartPlant Foundation. To make changes to that file, you
will need to check out the file and (initially, at least) launch it from the SmartPlant
Foundation application.

SmartPlant Integrated Schema

 The SmartPlant
schema for
Integration is
managed using
one large file –
called the CMF
file – that is
under
document
management in
SmartPlant
Foundation.

© 2005. Intergraph Corp.

SmartPlant Schema
Because SmartPlant is intended to facilitate data exchange
from multiple engineering tools, the following rules apply to
the Integration schema:
 All schema data (data definitions) is defined as part of the
SmartPlant schema (CMF file)
 The SmartPlant schema describes everything that goes on
in SmartPlant
 A copy of the SmartPlant schema resides on the server(s)
 Component schemas are selective extracts from the
SmartPlant schema, and reside on every client
 All changes are made to the SmartPlant schema and then
propagated to the component schemas

© 2005. Intergraph Corp.

1.2.2 Components of the Schema

Both SmartPlant schemas contain specific schema objects that will define the data that
will be stored in the SmartPlant Foundation schema, regardless of where it was created,
and help user view the data once it is in the database.

SmartPlant Schema
Both the Authoring and Integrated SmartPlant schemas store
the following types of schema objects to define data.

SmartPlant Schema

Contains definitions of:

My serial number is VZ-012345. I was

manufactured on January 4, 2005. I may be ordered from a number of
different catalogs, as I am
manufactured by several different
companies.

I'm a mechanical device. I may be a

commodity
item.
I weigh 100 pounds, and my center of
gravity is at x=10.0, y=3.0, z=7.5
I have certain mechanisms that are
used to control the flow of fluid
through a pipeline.
I had a small leak last month. I was sent
back to the manufacturer and repaired.
My design pressure is 200 PSI. In the process plant that you
built last year, you used 40
valves exactly like me.
© 2005. Intergraph Corp.
All Rights Reserved.

Property Definitions (PropertyDef’s) are used to provide identification and naming of all
object classes. PropertyDef’s allow you to describe the class with respect to its position in
the hierarchy and provide inheritance of information to other classes. All property
definitions for a class are exposed through interface definitions and never directly by the
class.
1-24 Overview/Review of SmartPlant Integrated Engineering Architecture

Property Definitions
A property is a characteristic or attribute used to describe a
class.

SmartPlant Schema

© 2005. Intergraph Corp.

The property definitions that apply to a particular interface definition are defined by the
Exposes relationship between objects of type InterfaceDef and objects of type
PropertyDef.
For example, the IDocument interface definition exposes the following property
definitions:
 DocCategory
 DocSubType
 DocTitle
 DocType
These specific properties are a set of attributes that are always used together on an object
to describe the role an object can play – the role of being a document.
Property information can be used to determine the property type or, in other words, the
possible values for that property definition. Standard schema property types include
Boolean, integer, double, and string.
Property definitions of the enumerated property type (picklist) have a list of possible
string property values defined for them. A property definition of this type must match an
entry in the list of enumerated property values defined for the property type.
Overview/Review of SmartPlant Integrated Engineering Architecture 1-25

1.2.5 Introduction to Interface Definitions

The "valve" exposes certain "roles" to the universe, and the roles that a valve object
"realizes" are there for us to use, if we want to listen and understand. This is called a
"role-based" approach to classifying things - let them tell what they are (meaning what
roles the object thinks it fulfills).

Interface Definitions
Microsoft has been a leading proponent of the "role-based"
view of objects, and they implement this by using an artifact
called an interface.
interface

Interface
= a Role

The use of interfaces is common in Microsoft .NET technology.

Interfaces are just convenient "places" to group the tightly-bound properties of a role:
 A role is something that an object yields up to the universe, i.e., "I am a driver,
here is my 'driver-ness'."
 A role consists of closely-related properties, such as driver's license number,
expiration date, restrictions, picture.
 Properties that you purposefully keep together, such as on a driver's license, in
your wallet, in your purse, in your car.
 Because a role makes data retrieval easier, and less ambiguous.
If you want to get more technical - an interface could be thought of as a named table of
property definitions that are role-based.
Thus an interface definition is a named collection of property definitions. Interface
definitions expose the property definitions for class definitions. Each interface definition
represents a "role" for a class definition.
1-26 Overview/Review of SmartPlant Integrated Engineering Architecture

Interface Definitions
Interface definitions define different roles (functions) for a
class definition.

SmartPlant Schema

© 2005. Intergraph Corp.

By sharing specific interface definitions, class definitions can also share property
definitions, but not the data associated with the properties.

Interface Definitions
Classes can share interfaces/roles in the SmartPlant Schema.

SmartPlant Schema

© 2005. Intergraph Corp.

Different class definitions can share the same interface definitions, and therefore, the same
role. For example, every class definition in the schema shares the IObject interface,
which means that every class definition in the schema has the role of an object. When a
class definition has this role, it has an object name, an object description, an object
identifier, and any other property definitions exposed by the IObject interface.
1-28 Overview/Review of SmartPlant Integrated Engineering Architecture

1.2.6 Relationships
Relationships are associations between interface definitions in the schema. They identify
two specific objects that are related by a specific relationship type. The relationship type
identifies the interface definitions on the two objects that fulfill the roles associated with
the relationship type.

Relationships
Relationships are associations between interface definitions in
the schema.

SmartPlant Schema

© 2005. Intergraph Corp.

The relationship type also identifies the roles defined at both ends of the relationship. In
the schema, relationship definitions are defined between interface definitions, not between
class definitions. A relationship can only exist between objects that support (realize) the
interface definitions at each end of the relationship definition.
Overview/Review of SmartPlant Integrated Engineering Architecture 1-29

1.3 Authoring Tool Schemas

The engineering application tool user, such as the SmartPlant Instrumentation (SPI)
customer, does not need to understand and comprehend the SmartPlant schema to use
SPF. In fact, they are able to conduct their workflows without concern for database, data
model, and underlying architecture. The SmartPlant schema assures that data will be
stored and retrieved in a proper fashion in accordance with the defined structure and rules.
The SmartPlant integrated schema can be hard to understand, and the full schema file will
contain a great deal of information specific to only one or two authoring tools. Schema
Component exist to break the SmartPlant schema into smaller sections that make it easier
to manage, and faster for tools adapter to interpret when pubishing data. The Schema
Component is a set of .DLLs that assists the tools with the generation and subsequent
parsing of the XML data. The tool adapter interfaces with the Schema Component (the
main interface point) to read the SmartPlant schema.

SmartPlant Schema
The SmartPlant schema contains definitions for all authoring
tool components relevant to SmartPlant.
ABE
SPPID SmartPlant Schema
PIDComponent
EquipDataSheetComponent
PFDComponent
ControlSystemComponent SP3D
SPInst DimensionalDataSheetComp
InstrumentIndexComponent
P3DComponent
ELEComponent
PDSComponent
DocVersionComponent
SPElec EQLComponent PDS
ProcessDataComponent
GenericDocumentComponent
WBSComponent
IMLComponent
© 2005. Intergraph Corp. PBSComponent
All Rights Reserved.

The SmartPlant schema will then encompass the items and relationships for all the
authoring tools in order to facilitate the transfer of information from one tool to another.
This helps reduce the need to recreate data from one tool to the next.
The following defines the component schemas that encompass SPF:
 PBS stands for Plant Breakdown Structure. Plant breakdown is created in SPF
and retrieved into the tools to create an identical structure.
 WBS stands for Work Breakdown Structure, and like PBS, the objects are
created and published in SPF and retrieved by the tools.
1-30 Overview/Review of SmartPlant Integrated Engineering Architecture

 The GenericDocumentComponent contains the Document class and

represents a very generic document.
 The DocVersionComponent schema is all that is required to define the data
that appears in the metadata container for publish and retrieve.
 EQLComponent is the component schema required to support an Equipment
List application.
 ProcessDataComponent is a component schema defining the Instrument
Process Datasheet integration between SPF and SPI.
 IMLComponent is the component schema to support the Instrument Master
List application which functions as an instrument index.

A tool schema file, also known as a map file or a tool map file, describes the structure of
data as it is defined in the authoring tool database and how the authoring tool classes and
properties map into and out of the SmartPlant schema.

Authoring Tool Schemas

Tool map schemas or "Map files", describe the mapping
between an authoring tool's internal data model and the
SmartPlant schema.

When a document* is published, the authoring tool adapter,

with the help of the SmartPlant schema component API uses
the tool map schema to convert the data from the tool's
internal data model to the SmartPlant schema.

Note: * The word document is "overloaded" with meaning by

everyone. For our purposes, we're talking about an
XML file that contains data, under control of a schema.

© 2005. Intergraph Corp.

Authoring Tool Schemas

Each authoring tool is responsible for delivering a tool schema
which contains the definitions specific to that tool.
SmartPlant
Aspen Basic
SmartPlant P&ID Instrumentation
Engineering
SPPIDDataMap.xml INtoolsMap.xml

pfdmap.xml Map Classes Map Classes

Map Properties Map Properties
Map Classes Map Relationships Map Relationships
Map Properties Map Picklists Map Picklists
Map Map UOM’s Map UOM’s
Relationships
Map Picklists
Map UOM’s

© 2005. Intergraph Corp.

Some authoring tools, such as SmartPlant P&ID, will have one tool schema XML file
while other applications such as Aspen Basic Engineering has several tool schemas;
eqdmap.xml, pbsmap.xml, pfdmap.xml, pidmap.xml, and wbsmap.xml.

Authoring Tool Adapters

Each authoring tool that is part of SmartPlant
Enterprise has an authoring tool "Adapter", which
facilitates the sharing of data between the authoring
tool and SmartPlant Enterprise.

Tool adapters generate XML files for "publish"

operations, and consume XML files for "retrieve"
operations.

© 2005. Intergraph Corp.

1.4 Schema Mapping

Each authoring tool that uses configurable mapping has its own schema called a tool
schema. In order to make data publishing and retrieval easier, mapping is done between
the SmartPlant schema and the tool schema.

Schema Mapping
Every class in the tool schema that is to be published to
SmartPlant maps to a class, property, or picklist in the EF
Schema.
SmartPlant Schema
ClassToMapClass SPPIDDataMap.xml

Classes Map Classes

PropertyToMapProperty MapClassToClass

Map Properties
Properties
MapPropertyToProperty
Map Picklists
Picklists MapPropertyMapEnumList
Map UOM’s
UOM’s

© 2005. Intergraph Corp.

Integration with SmartPlant is done in a modular fashion with minimal impact to the
application itself. Each authoring tool delivers an adapter that supports the key
functionality to publish and retrieve data to SmartPlant. For tools that support
configurable mapping, a map must be defined between the applications internal data
structures and the SmartPlant schema. The Schema Component can be used to help
generate the necessary XML files to exchange data and assist with many of the integration
operations.
Overview/Review of SmartPlant Integrated Engineering Architecture 1-33

Mapping is not required, because there is some hard coding done in the tool adapter so
that the adapter can publish default data. However, without mapping, data retrieval can be
a big problem. If mapping is done correctly, a tool will be able to retrieve data from other
tools.

Tool Schemas

P&ID SPInst
Retrieve
ConstructionStatus ConstructionStatus
InsulationSpec
Retrieve
SmartPlant Schema

Publish
ConstructionStatus

ConstructionStatus
InsulSpec

2.1 Starting the Schema Editor

The Schema Editor is installed as part of the Schema Component installation. Intergraph
delivers two basic Schema Editor user interfaces for you to use. The developer was
designed for advanced users who are more familiar with the software and schema to use.
The standard mode is a newer user interface, designed to be more user friendly and easier
to navigate or users with less experience performing basic tasks.

Starting the SmartPlant Schema Editor

 To open the Schema Editor, click Start > All Programs >
Intergraph SmartPlant Foundation > SmartPlant Schema
Component > SmartPlant Schema Editor - Standard.
Standard

© 2005. Intergraph Corp.

Starting the SmartPlant Schema Editor

The configuration file is used to open the “master” schema
and any extension (another) schemas.

Meta
Schema file Schema file

Another Schema

© 2005. Intergraph Corp.

The SCHEMA_BootStrap.xml file defines the minimum SmartPlant Foundation

configuration to enable a user to launch the Desktop Client.
2-8 Using the Schema Editor

The SmartPlant schema is represented by a Unified Modeling Language (UML) model

entitled SmartPlant schema. A solid understanding of UML is needed to completely
comprehend and digest the complexities of the SmartPlant schema.

Unified Modeling Language

Data modelers have agreed to use symbols that
are part of a set of modeling practices called
Unified Modeling Language, or UML .
UML is used as a symbolic framework upon which
the ideas that are being modeled are expressed.
Even an experienced data modeler needs to know
what symbols represent what ideas.
The precise nature of the symbols (and symbolic
logic, in general) virtually guarantees that
ambiguity is minimized, and accuracy is
maximized.
© 2005. Intergraph Corp.
All Rights Reserved.

There were many attempts during the last 20 years to arrive at a "common" understanding
of how to represent ideas on a diagram. UML won the war because it is so easy to use,
and is extensible (for new ideas that might come along at any time).
In the Schema Editor, you can view any schema in .XML format. The many different
schema views in the Schema Editor provide different types of information that help you
understand how the schema works. For example, when you view the schema in any of the
tree views (except the schema tree/UML view and the schema hierarchy views) you can
typically see the schema class definitions.
As you expand nodes in the tree views, you can navigate the relationships in the schema
and view interface definitions, property definitions, and even instances of the class if
you also have a data file open in the Schema Editor.
The Schema Editor also provides graphical views of the schema. These views allow you
to see both static and dynamic UML diagrams containing the classes, relationships,
interfaces, and properties defined in the schema.
Using the Schema Editor 2-9

There are many other ways to view the schema in the Schema Editor depending on what
aspect of the schema that you want to understand.

Viewing a Schema File

The Schema Editor provides graphical views of the schema.
These views allow you to see both static and dynamic UML
diagrams containing the classes,
classes relationships,
relationships interfaces,
interfaces and
properties defined in the schema.
Some of the most useful ways to view the schema in the
Schema Editor are the following:
 Using the Tree,
Tree Tree/Table,
Tree/Table and Tree/Properties views
 Using the Tree/Viewable UML graphical view
 Using the Editor view
 Using the Editable UML views
 Using the Tree/MultiTab
Tree/MultiTab view

© 2005. Intergraph Corp.

2.2 Viewing an Open Schema File

Before you can begin viewing the schema or data files, you must first open the schema in
the Schema Editor.

Viewing a Schema File

 In the Schema Editor
window, click the
Schema tab (along the
left side of the window)
to view the base class
tree and search options.

© 2005. Intergraph Corp.

Shown below are some short explanations for the tabs visible in the Standard Workflows
window:
Active Tab
The Active tab allows you to select a startup file and view related files. You can also open
tool schema files, connect to SmartPlant Foundation for mapping, and synchronize tool
map schemas and tool metadata for tools with metadata adapters. You can also change the
active schema and open tool schemas from the Active tab.
Schema Tab
The Schema tab allows you to search the active schema for specific objects or browse the
schema in the tree view. When you select an object in the tree view, information for that
object is displayed on the active tab on the right side of the window.
Tool Schema Tab
The Tool Schema tab allows you to search the active tool schema for specific objects or
browse the schema in the tree view. When you select an object in the tree view,
information for that object is displayed on the active tab on the right side of the window.
Using the Schema Editor 2-11

Mapping Tab
The Mapping tab allows you to view loaded tool map schemas, expand them, and select
tool map schema objects for which you want to define mapping.
Schema Editor toolbars provide easy access to the most commonly used commands. You
can move the toolbars around in the Schema Editor window and dock them wherever you
want. For descriptions of the commands on the Schema Editor toolbars, see the
SmartPlant Schema Editor User's Guide delivered with the documentation.
Command buttons on the Schema Editor vertical tabs allow you to identify commands
easily with icons.

Schema Editor Icons/Toolbar

Click To
Click this to specify the startup file for the Schema Editor,
such as a session file, a CFG file, a CMF file, or an XML file.
Click this to select a schema file to open. If the selected
startup file contains a schema file, the name and path for
that schema file is displayed in the SmartPlant schema file
box.

Click this to select another schema file to open.

Click this to select the active schema file when multiple

schema files are open in the Schema Editor. The active
schema is the one that you are editing and searching.
Although you can see multiple schemas at once, you can
only edit one at a time.
© 2005. Intergraph Corp.
All Rights Reserved.
2-12 Using the Schema Editor

Schema Editor Icons/Toolbar

Click To (cont.)

Click this to search for schema objects or tool map schema

objects that match the criteria you define on the
corresponding tab.

Viewing a Schema File – Tree View

 Click the + next to a node in the
tree view to expand the
selected object type.

© 2005. Intergraph Corp.

The ClassDef object relationships are shown.

The view expands to show properties related to the class objects.

Using the Schema Editor 2-21

2.2.2 Schema Tree/Table View

The Schema Tree/Table view is a combination of the standard tree view with a table that
provides a different view of the information based on what you select in the tree view.
The table views are predefined by class to show the most useful information for each type
of object.
Click on the Table (hor) tab, and the Schema Tree/Table view is displayed.

Schema Tree/Table View

The object properties are displayed in the right pane in a
horizontal table.

© 2005. Intergraph Corp.

When you drag and drop an object to the UML view, you will be prompted to create either
a custom UML view or a default view. An example of creating a custom UML view will
be demonstrated later.

© 2005. Intergraph Corp.

2.2.4 Interface Relationships

In the previous chapter, relationships between interfaces were introduced. In the examples
used in this chapter, you will be exposed to different kinds of relationships that are used to
associate interfaces.
The two types of relationships used from interface to interface are:
 Relationship Definitions (RelDef) – these are user defined relationships defined by
the data modeler and are used to associate interfaces that are realized by different
class definitions (ClassDef’s).
 Implied (Relationship) – this type of relationship is thought of as a system default
relationship. It is used primarily for inheritance from one interface to another
interface where both are realized by the same ClassDef.

Interface Relationships
There are two kinds of relationships that can exist between
InterfaceDef’s.

RelDef
(Relationship Definition) User Defined

Implies
(Relationship (Default))

System Defined

© 2005. Intergraph Corp.

Both RelDef’s and Implied relationships can be used for object navigation or browsing,
but RelDef’s provide for more browsing control. This will be discussed in more detail in
chapter 5.

Interface Relationships
Each relationship has 2 ends, End 1 and End 2.

RelDef
(Relationship Definition) User Defined

Implies
(Relationship (Default)) Object navigation (browsing)
uses relationships.
System Defined
Forward +
End 1 End 2
Reverse -
End 1 End 2
© 2005. Intergraph Corp.
All Rights Reserved.

Either forward or reverse browsing is possible in the Desktop Client.

Interface Relationships
Each relationship has 2 ends, End 1 and End 2.

RelDef
(Relationship Definition) User Defined

Implies Right click on Equipment to

(Relationship (Default)) see Instruments:
Instruments
System Defined -ProcessEquipmentInstrument
Right click on an Instrument to
see Equipment:
Equipment
+ProcessEquipmentInstrument
© 2005. Intergraph Corp.
All Rights Reserved.
2-30 Using the Schema Editor

One of the primary functions of the Implies relationship is to allow an interface to inherit
properties and relationships from an associated interface. For example, the interface
IElecPowerConsumer exposes a property called AverageActiveLoad.

Interface Relationships
There are two kinds of relationships that can exist between
InterfaceDef’s.

RelDef
(Relationship Definition) User Defined

Implies
(Relationship (Default))

System Defined

© 2005. Intergraph Corp.

The property AverageActiveLoad will display as one of the Properties For Role for the
interface IInstrument.

Interface Relationships
There are two kinds of relationships that can exist between
InterfaceDef’s.

RelDef
(Relationship Definition) User Defined

Implies
(Relationship (Default))

System Defined

© 2005. Intergraph Corp.

Because IInstrument Implies IElecPowerConsumer, it also inherits AverageActiveLoad

as though this property was exposed by IInstrument directly.

Interface Relationships
There are two kinds of relationships that can exist between
InterfaceDef’s.

RelDef
(Relationship Definition) User Defined

erty
Prop
Implies
Is
lied
Imp (Default))
(Relationship

System Defined

© 2005. Intergraph Corp.

© 2005. Intergraph Corp.

Each type of relationship, such as <<Realizes>> or <<Implies>>, is shown inside angle

brackets between the selected object and other classes and interfaces in the UML view.

Schema Tree/Viewable UML View

The view changes to
display properties and
relationships for the
IInstrumentOcc
interface.

© 2005. Intergraph Corp.

Schema Tree/Viewable UML View

 Use the scroll bars to view all of the relationship information.

© 2005. Intergraph Corp.

To go back to the last UML view, click Back on the toolbar.

Schema Tree/Viewable UML View

 Use the Back button to return to the previous diagram.

© 2005. Intergraph Corp.

Schema Tree/Viewable UML View

The original default class diagram for the PIDDrawing object is
displayed.

© 2005. Intergraph Corp.

2.2.6 Editor View

In the Schema Editor, you can define new objects, such as classes or properties, in the
schema. To add objects to the schema, you can use the Editor view.

Click the Editor tab in the view pane.

Searching the Schema – Find Tree

 Select the desired classes from the list, and click OK.
2-44 Using the Schema Editor

In this example, the search is limited to the RelDef object class and any name that
contains the phrase doc.

Searching the Schema – Find Tree

 Enter any additional criteria and click the find button.

© 2005. Intergraph Corp.

The tree will display the search results. Again, expand nodes in the tree to see related
edges.

Searching the Schema – Find Tree

 Click the + next to RelDef to
expand the tree.

© 2005. Intergraph Corp.

Since the PIDComponent schema is used as a read-only file, in order to save custom
views, exit the Schema Editor and re-start it with a different schema file.
Once the view windows have been closed, use the File command on the main menu to
Exit from the Schema Editor.

Exiting the Schema Editor

 From the menu bar, select the File > Exit command.

© 2005. Intergraph Corp.

A Schema Editor dialog window will display to allow you to save a session file. For now,
we will not save sesson files, but they will be covered in depth in later chapters.

Exiting the Schema Editor

 Click No to save the session configuration information to a
file.

© 2005. Intergraph Corp.

Custom Editable UML View

 Enter a new UML view name, and click the browse button to
select a Package.

1
2

© 2005. Intergraph Corp.

The following defines the fields used in the New UML View Definition dialog box:
 UML view name – Specifies the name for the new custom UML view. This is a
required field.
 UML view description – This is an optional field used to give the new view a
description.
 Package – Use the browse button beside this field to select an existing package in
which to store the UML view. You can also create a new package to use in storing
your custom UML view.
Using the Schema Editor 2-55

The Possible PackageForUMLViewDef Values dialog will appear.

Custom Editable UML View

 To define a new UML view package, click the New button.

© 2005. Intergraph Corp.

The New Package dialog box appears.

view.

2.5 Change Object Display

By default when you drag and drop and object into a UML view, the dropped object will
display as a rectangle. If you have a UML diagram with quite a few objects, the display
can become cluttered. An option available to you is to change the display of the object
from the default rectangle to a circle.
To do this, right-click an object to display the shortcut menu.

Change Object Display

 Right-click an interface definition, and click Display as
circle on the shortcut menu.

© 2005. Intergraph Corp.

This operation will change the selected object display from a rectangle to a circle.

© 2005. Intergraph Corp.

A Place Text dialog box appears.

Place Text
 Enter the desired text, and specify any additional
parameters, such as text alignment. Click the Font button
to access an additional dialog for font settings.

© 2005. Intergraph Corp.

The Place Text dialog box allows you to set the font color and alignment (left, center or
right). Click the Font button to set the font parameters.

Place Text
 Select a Font, Font Style, Size and Color, and then click OK.

© 2005. Intergraph Corp.

© 2005. Intergraph Corp.

In order to show an example of using the Schema Editor in a different mode, use the exit
command.

Exit the Schema Editor

2.12 Activity 1 – Using the Schema Editor

Complete Chapter 2 - Activity 1 in the SPF Modeling and Mapping Activity Workbook.
2-82 Using the Schema Editor
Using the Schema Editor 2-83

2.13 Creating a Extension Schema

As part of the Schema Modeling and Mapping course, you will create the necessary
class, interfaces, properties and relationships in the hands on sessions in chapters 3, 4 and
5. Below is an example of a Pump object that will be modeled and eventually
implemented.

New Object – The Excel Import Pump

Excel Spreadsheet

We want to map a class for storage in SPF called:

Excel Import Pump

Name
Description

Pump Type (Picklist)

Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
Maximum Temperature

Hold Status (Picklist)

Model Definitions
A model definition (ModelDef)
is the schema information <<ModelDef>>
PlannedMaterialModel
used to describe the model.
The primary function of a
ModelDef is to identify those <<ModelClass>> <<ModelClass>>
objects that can be shared
through a ModelClass <<ClassDef>> <<ClassDef>>
PIDInstrument INDXInstrument
relationship.
Objects can only be shared if <<ModelClass>>
they exist within the same
ModelDef. Objects in different <<ClassDef>>
PIDProcessEquipment
ModelDefs can be related, but
cannot be shared.

© 2005. Intergraph Corp.

The only use for the ModelDef currently is to enforce a rule that ClassDefs must be in the
same ModelDef to participate in a Sharing relationship.
3-6 Schema Overview and Modeling New Classes

Model Definitions
ModelDefs define domains of data. There are seven
ModelDefs in the SmartPlant schema:
 MetaModel
 OrganizationModel
 WorkBreakdownModel
 FacilityModel
 PlannedMaterialModel
 TypicalMaterialModel
 ActualMaterialModel

© 2005. Intergraph Corp.

MetaModel - Used only by the ClassDefs in the meta-schema. You should never use this
model for Schema.
OrganizationModel - Like the name implies, this is intended for ClassDefs that are
organizational concepts. Examples would be User, Company, Department, Manufacturer,
Vendor, etc.
WorkBreakdownModel - For ClassDefs that provide organizations of work. This
includes the ClassDefs that you see in the WBS documents, such as Project and Contract,
as well as all the document ClassDefs defined in the schema.
FacilityModel - For ClassDefs that represent abstract concepts in a process plant.
Examples include Plant, Area, Unit, System, Discipline (although you might put
Discipline in the OrganizationModel instead.)
PlannedMaterialModel - For ClassDefs that represent real objects that you plan to
purchase to construct your design. This is the “design” arena in which engineering tools
like Zyqad, SPPID, and SmartPlant Instrumentation work. In a traditional SPF Model, this
would be the “tag”.
TypicalMaterialModel - For ClassDefs that represent real objects offered by
manufacturers or vendors. When an engineer goes looking for something to fulfill the
requirements of his design, he might look through a manufacturer catalog. This is the
domain of this model. In a traditional SPF Model, this would be the “model”, or “catalog”,
or “standard equipment”.
ActualMaterial - For ClassDefs that represent what is purchased and assembled to
construct the plant. In a traditional SPF Model, this would be the “asset”.
Schema Overview and Modeling New Classes 3-7

Evolution for objects is normally from planned facility (FacilityModel) to planned

material (PlannedMaterialModel) to actual material (ActualMaterialModel). Catalog parts
are part of the typical material model. Meta schema objects are part of the meta model.
The organization model contains objects that are outside the normal set of designed
objects; these objects describe the organization rather than the design. The work
breakdown model contains object associated with the work being performed rather than
the objects for that work.

Note: All ModelDefs are part of the meta schema and are therefore predefined.
3-8 Schema Overview and Modeling New Classes

3.2 Component Schemas

A Component Schema is a subdivision of the complete SmartPlant schema and is a set of
class definitions that are used within a specified domain or application area. Class
definitions tie a primary interface definition to a component schema. Class definitions and
interface definitions will be discussed in more detail later.
The component schema breaks up the SmartPlant schema into manageable chunks that
correspond almost one to one to a document type being published. At a minimum, there is
a component schema defined for each tool that publishes into SmartPlant. You can extract
component schemas from the SmartPlant schema using the Schema Editor.
One of the primary purposes of the component schema is performance. When a tool
indicates it is going to publish a certain document type, the SmartPlant Client loads only
the necessary component schema instead of the entire SmartPlant schema.

Component Schemas
A component <<CompSchema>>
schema PIDComponent

(CompSchema) is a
<<Componentization>> <<Componentization>>
set of class
definitions that are <<ClassDef>> <<ClassDef>>
PIDNozzle
PIDPipeline
used within a
specified domain or <<Componentization>> <<Componentization>>

application area. <<ClassDef>>

PIDInstrument
<<ClassDef>>
PIDProcessEquipment

For example, the

PIDComponent <<Componentization>>

schema contains all

the class definitions <<ClassDef>>
PIDInstrumentLoop
that are relevant to
P&IDs.
© 2005. Intergraph Corp.
All Rights Reserved.
Schema Overview and Modeling New Classes 3-9

Component Schemas
Component schemas contain the following:
 The set of class definitions that have a
componentization relationship with the component
schema
 The interface definitions realized by those class
definitions
 The property definitions exposed by those interface
definitions
 The property types that scope those property
definitions

© 2005. Intergraph Corp.

The component schemas are full of examples of shared objects that appear in more than
one component schema. Virtually all of the schema data defined in a component schema,
including class definitions, interface definitions, property definitions, and property types,
may be shared by one or more other component schemas.
The unique identity of an object is defined by its unique identifier (UID) and does not
depend in any way on its classification. Therefore, an object can be classified differently
by different components and still be one shared object in the SmartPlant Foundation
database. Shared object definitions will be discussed later in this chapter.
For example, if an object in one component schema is classified as class AA1 and the
same object with the same UID is classified as class AA2 by another component schema,
then the shared object in the SmartPlant Foundation database contains the information
associated with the union of classes AA1 and AA2.
Editing of the component schema should always be done against the SmartPlant schema
files from which the component schema files were generated rather than the component
schema files themselves (because they can be regenerated).
3-10 Schema Overview and Modeling New Classes

3.2.1 Properties of a Component Schema

Component schemas have the following properties:
 Name – Specifies the name of the component schema.
 Description – Specifies the description of the component schema.
 Class definitions defined by component schema – List all class definitions that have
a componentization relationship with the component schema. Because validation of
published XML is done using the component schema instead of the SmartPlant
schema, the component schema should contain all class definitions required to publish
a particular document type.
 Document type – Specifies which document types the component schema scopes.
This setting is currently optional because the SmartPlant Client queries the adapter for
this relationship during a publish.

Component Schemas

© 2005. Intergraph Corp.

3.3 Interactive Activity – Creating a Component

Schema
For the interactive activities in this chapter, we wil be creating a new component schema,
as well as all the necessary definitions to add some custom attributes to the schema. The
following slides will explain the process that you will use throughout this chapter to
accomplish this task.

New Object – The Excel Import Pump

Excel Spreadsheet

We want to map a class for storage in SPF called:

Excel Import Pump

Name
Description

Pump Type (Picklist)

Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
Maximum Temperature

Hold Status (Picklist)

© 2005. Intergraph Corp.

This is an example of Excel Import Pump that needs to be implemented. What you see
depicted above is a form that will be used to gather the necessary information about the
pump.
3-12 Schema Overview and Modeling New Classes

First, we will need a new Component Schema to contain the type of object to be added to
the SmartPlant Desktop Client.

New Object – The Excel Import Pump Step 1 – Create a Component Schema to store class defs
of objects that will be added through an import from
Excel.

Excel Spreadsheet
Component Schema: SPFExcelImportComponent

Want to map a class EIPump for Storage in SPF: <Comp Schema> SPFExcelImportComponent

Excel Import Pump

Name
Description

Pump Type (Picklist)

Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
Maximum Temperature

Hold Status (Picklist)

© 2005. Intergraph Corp.

Since a new type of object will be created, a new class of object must be defined, which is
called a Class Definition.

New Object – The Excel Import Pump Step 2 – Create a class definition for the Excel Import Pump.

Excel Spreadsheet

Want to map a class EIPump for Storage in SPF: <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

Name
Description

Pump Type (Picklist)

Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
Maximum Temperature

Hold Status (Picklist)

© 2005. Intergraph Corp.

In a couple of instances, the necessary attributes or properties needed to provide the

necessary information have already been defined in the system and associated with an
interface. Rather than re-define exisiting objects, you can reference the existing interface
and use its properties.

New Object – The Excel Import Pump Step 3 – Realize as many existing interfaces as are available
in the system that map your needs

Excel Spreadsheet

Want to map a class EIPump for Storage in SPF: <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

Name
Description
<interface> IObject
Pump Type (Picklist)
<property def> Name
<property def> Description
Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
Maximum Temperature

Hold Status (Picklist)

© 2005. Intergraph Corp.

You will also need to define new interfaces and properties to complete the mechanism to
capture all of the needed information for this new object type.

New Object – The Excel Import Pump Step 4 – Create new interfaces and properties for specifically
needed parts of the new item not covered by the schema,
separate them out into multiple interfaces for maximum reuse
i.e if a group of properties will be used elsewhere it needs its
Excel Spreadsheet own interface

Want to map a class EIPump for Storage in SPF: <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

Hold Status (Picklist)

© 2005. Intergraph Corp.

The various properties we need can be spread out across multiple interfaces to make it
easier to re-use the interfaces for more than one type of object.

Want to map a class ADC Design Change for

Storage in SPF:- <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

Name
Description
<interface> IObject
Pump Type (Picklist)
<property def> Name
<property def> Description
Tag Prefix
Tag Sequence Number
<interface> IEI_Pump
Tag Suffix
<property def> Pump Type
Maximum Pressure
Maximum Temperature
<interface> IEI_TaggedItem
Hold Status (Picklist)
<property def> Tag Prefix
<property def> Tag Sequence Number
<property def> Tag Suffix

© 2005. Intergraph Corp.

Want to map a class ADC Design Change for

Storage in SPF:- <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

<interface> IEI_Designed Item

<property def> Maximum Pressure

© 2005. Intergraph Corp. <property def> Maximum Temperature
All Rights Reserved.
Schema Overview and Modeling New Classes 3-15

A portion of the needed data can use a picklist or enumerated list.

<Comp Schema> SPFExcelImportComponent

<class def > EIPump

Want to map a class ADC Design Change for
Storage in SPF:-
<interface> IObject
Excel Import Pump
Name <property def> Name
Description <property def> Description

Pump Type (Picklist) <interface> IEI_Pump

Tag Prefix <property def> Pump Type

Tag Sequence Number
Tag Suffix <interface> IEI_TaggedItem

Maximum Pressure <property def> Tag Prefix

Maximum Temperature <property def> Tag Sequence Number
<property def> Tag Suffix
Hold Status (Picklist)
<interface> IEI_Designed Item

<property def> Maximum Pressure

<property def> Maximum Temperature

<interface> IEI_HeldItem
© 2005. Intergraph Corp.
All Rights Reserved. <property def> Hold Status

As part of defining a new class (ClassDef), a primary interface for the class should be
specified.

New Object – The Excel Import Pump Step 5 – Specify a primary interface that identifies the
“uniqueness” of the role for this class def

Excel Spreadsheet
<Class Def > EIPump

<realizes primary interface>

Want to map a class EIPump for Storage in SPF:

<interface> IEI_Pump
Excel Import Pump
Name
Description <implies> <implies>

Pump Type (Picklist)

<interface> <interface>
Tag Prefix IObject
Tag Sequence Number IEI_Tagged Item
Tag Suffix
<implies>
Maximum Pressure
Maximum Temperature
<interface> <interface>
Hold Status (Picklist) IEI_DesignedItem IEI_HeldItem

<interface>
IEI_PumpOcc
IEI_Pump is Primary as it scopes
EIPump in its entirety
© 2005. Intergraph Corp.
All Rights Reserved.
3-16 Schema Overview and Modeling New Classes

One of the last steps will be to specify the values used for the picklists.

New Object – The Excel Import Pump Step 6 – Scope the design status property using a “picklist”,
an enum list type and enum enums (entries)

Excel Spreadsheet
<interface>
IEI_Pump

<exposes>
Want to map a class EIPump for Storage in SPF:

<property def> EI_PumpType

Excel Import Pump
Name <scoped by>
Description

Pump Type (Picklist) <enum list type>

PumpTypes
Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
<contains>
Maximum Temperature

Hold Status (Picklist)

<enum enum> <enum enum>
Horizontal Vertical

© 2005. Intergraph Corp.

New Object – The Excel Import Pump Step 6 – Scope the design status property using a “picklist”,
an enum list type and enum enums (entries)

Excel Spreadsheet
<interface>
IEI_HeldItem

<exposes>
Want to map a class EIPump for Storage in SPF:

<property def> EI_HoldStatus

Excel Import Pump
Name <scoped by>
Description

Pump Type (Picklist) <enum list type>

HoldStatuses
Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
<contains>
Maximum Temperature

Hold Status (Picklist)

<enum enum> <enum enum>
Held Released

© 2005. Intergraph Corp.

Hands on:
Please follow along with the instructor in creating a new component schema. Do not close
your Schema Editor window as this activity will continue with additional components.
1. If you are not already logged into your VM session, log on to your operating
system as Administrator with a password of Training#1.

2. Click Start > All Programs > Intergraph SmartPlant Foundation >
SmartPlant Schema Component > SmartPlant Schema Editor - Standard to
start the Schema Editor.

3. Open the project schema XML file.

 Click the File > File Configurations >Open Configuration.
 Select the 904-EISchema.cfg file, and click Open (Path is D:\Program
Files\SmartPlant|Foundation\2009\Models\Core).
 Use the Editor view to perform your modeling tasks.
 Along the left side of the window, choose to view the Schema tab.
 Along the top of the window, choose to use the Editor viewer.

Creating a Component Schema

 Drag and drop CompSchema from the Create section of the
Editor window to the UML view window.

© 2005. Intergraph Corp.

4. In the Create section of the Editor view, find the CompSchema option. Drag
and drop it into the UML view area.

5. Provide the following information for the new component schema:

 Name – SPFExcelImportComponent
 Description – Schema Component for Excel Import

Creating a Component Schema

 In the New Component Schema dialog box, enter the
information to create a new Component Schema.

© 2005. Intergraph Corp.

3.4 Class Definitions

Class definitions are typically real-world objects like instruments, equipment, or pipe
runs. Class definitions have the following characteristics:
 Every instance of a class definition is instantiated by a class factory.
 Every class definition belongs to one and only one component schema.
 Every class definition has a primary interface definition that defines the set of
possible roles (interface definitions) for the class definition. Interface
definitions will be discussed in the next section.

Class Definitions
A class definition (ClassDef) is a <<ClassDef>>
named description of a set of objects PIDInstrument
that specifies the attributes (data
elements) and methods (member
functions) for those objects in the
schema. <<ClassDef>>
PIDInstrumentLoop

In the schema, ClassDefs can

represent physical things, such as
pumps and instruments, or
conceptual things, such as projects.
ClassDefs offer different roles with
which the software can interact.
ClassDefs expose or realize their
roles through abstract entities called
interface definitions.

© 2005. Intergraph Corp.

3.4.1 Properties of a Class Definition

The properties of a class definition include the following:
 Name – Specifies the name of the class definition.
 Description – Specifies a description of the class definition.
 Display name – Specifies the name that you want the user interface to use
when displaying the class definition.

Class Definitions

© 2005. Intergraph Corp.

 Delete shared object published by another tool – Specifies what happens

when SPF receives a delete instruction for a shared object. SPF either deletes
all ClassDefs/UIDs for the shared object or only the ClassDef/UID referenced
by the delete instruction. For example, a shared object CV-2001 is published
by SmartPlant P&ID as PIDInlineInstrument and by SmartPlant
Instrumentation as INDXInstrument. If SmartPlant P&ID publishes a delete
instruction and this option is false on the PIDInlineInstrument ClassDef, then
the UID for the PIDInlineInstrument object will be terminated in SPF and the
INDXInstrument object will remain in the SPF database. If the option is set to
true, both UIDs will be terminated in SPF.
 Model definition – Specifies the model definition to which this class
definition belongs. Class definitions can only participate in a sharing
relationship if they exist in the same model.
Schema Overview and Modeling New Classes 3-21

 Component schema – Specifies the component schema to which the class

definition belongs. A component schema is a subdivision of the SmartPlant
schema. There is typically one component schema per published document
type.
 Shared object definitions – Specifies the shared object definitions with
which this class definition has a sharing relationship. Shared object definitions
define the same object in different authoring tools.
 Class factory definition – Specifies the class factory used to create the class
definition. There is currently only one class factory in the SmartPlant schema:
SchemaCompFactory.
 Primary interface definition – Identifies the primary interface definition for
the class definition. The primary interface definition defines the set of possible
roles for a ClassDef and should imply everything that is known about the
ClassDef.
 Realized interface definitions – Identifies all interface definitions realized by
the class definition.
 Set Realized Interfaces Using Primary Interfaces – Displays the Identify
Realized Interfaces Using Primary Interface dialog box. This dialog box
allows you to select which optional interfaces implied by the class definition's
primary interface that you want the class definition to realize.
3-22 Schema Overview and Modeling New Classes

3.5 Interactive Activity – Creating a Class Definition

Next we will create the class def to represent our new type of object.

The following example shows how these different types of relationships are used.
Schema Overview and Modeling New Classes 3-29

3.6 Interface Definitions

An Interface Definition (InterfaceDef) is the most important concept in the meta schema.
An interface definition is a named collection of property definitions. Interface definitions
expose the property definitions for class definitions. Every interface definition is realized
by one or more class definitions. By sharing specific interface definitions, class definitions
can also share property definitions, but not the data associated with the properties.

Interface Definitions
An interface definition <<ClassDef>>
(InterfaceDef) represents a <<Realizes>>
PIDInstrument
<<Realizes>>

"role" for a class definition.

<<Realizes>>
<<InterfaceDef>> <<InterfaceDef>>
Different class definitions IInstrument ILoopMember

can share the same

InterfaceDefs, <<InterfaceDef>>
and therefore, the same IObject

roles.
<<InterfaceDef>> <<InterfaceDef>>
<<Realizes>>
IPlannedFacility IInstrumentLoop
For example, all ClassDefs
in the schema realize the <<Realizes>> <<Realizes>>

IObject interface.
<<ClassDef>>
PIDInstrumentLoop

© 2005. Intergraph Corp.

Just as in the real world, the role defines both the properties and relationships of an object.
Some interface definitions are defined to carry properties. Some are defined to carry
relationships. Others may be defined merely to indicate a role.

Note: SPF uses InterfaceDefs to define what methods are allowed on an object and what
workflows are appropriate. These special relationships are not available in the
Schema Editor, only within SPF Desktop Client.
3-30 Schema Overview and Modeling New Classes

3.6.1 Role Example

The following example looks at the behavior of a class def and interfaces in a generic,
non-industry example.

Interface Definitions - Role Example

A class definition
<<InterfaceDef>>
can offer up many IHuman
roles to the world <<Implies>>
through its
interface <<InterfaceDef>>
<<InterfaceDef>> IMan <<InterfaceDef>>
definitions. IFather IUncle
<<Realizes>>
For example, a <<Realizes>> <<Realizes>>

"Man" can play <<InterfaceDef>> <<Realizes>>

<<ClassDef>>
Man <<Realizes>> <<InterfaceDef>>
many roles, such ISon IHusband

as "Father", <<Realizes>> <<Realizes>>

"Son", "Uncle", <<InterfaceDef>> <<InterfaceDef>>

"Husband", IEmployee IDriver

"Employee",
"Driver", and so
on.
© 2005. Intergraph Corp.
All Rights Reserved.
Schema Overview and Modeling New Classes 3-31

The primary interface will imply all of the interfaces that are realized by the class def.

Interface Definitions - Role Example

A class definition
<<InterfaceDef>>
can offer up many IHuman
roles to the world <<Implies>>
through its
interface <<InterfaceDef>>
<<InterfaceDef>> <<Implies>> IMan <<Implies>> <<InterfaceDef>>
definitions. IFather IUncle

For example, a <<Implies>> <<Implies>>

"Man" can play <<InterfaceDef>>

<<ClassDef>>
Man <<InterfaceDef>>
many roles, such ISon
<<Implies>>
IHusband

as "Father", <<Implies>>

"Son", "Uncle", <<InterfaceDef>> <<InterfaceDef>>

"Husband", IEmployee IDriver

"Employee",
"Driver", and so
on.
© 2005. Intergraph Corp.
All Rights Reserved.

Associations between classes are made by creating relationships between interfaces.

Interface Definitions - Role Example

When a company
<<InterfaceDef>>
wants to interact IHuman
with a Man, the <<Implies>>
company does
not care that he is <<InterfaceDef>>
<<InterfaceDef>> IMan <<InterfaceDef>>
a son or an uncle. IFather IUncle
The company <<Realizes>>
<<Realizes>>
<<Realizes>>
only cares that <<ClassDef>>
the "Man" class <<InterfaceDef>> <<Realizes>> Man <<Realizes>> <<InterfaceDef>>
ISon IHusband
realizes the
<<Realizes>> <<Realizes>>
"IEmployee" role
for the company <<InterfaceDef>> <<InterfaceDef>>
IEmployee IDriver
to interact with.
<<EmployedBy>>

<<InterfaceDef>> <<Realizes>> <<ClassDef>>

ICompany Company
© 2005. Intergraph Corp.
All Rights Reserved.
3-32 Schema Overview and Modeling New Classes

3.6.2 Interface Definitions and Relationships

There are two relationships defined between ClassDef and InterfaceDef. The first (and
most common) is the “Realizes” relationship. We say that a ClassDef Realizes an
InterfaceDef. The Realize relationship may be required or optional. If it is required, the
Schema Component will insist that any instance of that ClassDef must realize an instance
of the required InterfaceDef.

Interface Definitions
InterfaceDefs define the <<ClassDef>>
PIDInstrument
relationships that an <<Realizes>> <<Realizes>>

object participates in. <<Realizes>>

<<InterfaceDef>> <<InterfaceDef>>
IInstrument ILoopMember
ClassDefs are said to
have a Realizes <<InterfaceDef>>
relationship with IObject

InterfaceDefs. <<Realizes>> <<InterfaceDef>>

<<InterfaceDef>> IInstrumentLoop

ClassDefs must also IPlannedFacility

have a PrimaryInterface <<Realizes>>

<<Realizes>>

relationship with one <<ClassDef>>

PIDInstrumentLoop
InterfaceDef.
<<PrimaryInterface>>
© 2005. Intergraph Corp.
All Rights Reserved.

The second relationship defined between ClassDef and InterfaceDef is the “Primary
Interface” relationship. The primary interface definition defines the set of possible roles
for a class definition and should imply everything that is known about that class
definition. Primary interface definitions, rather than class definitions, actually define the
objects in the schema. Class definitions fulfill a subset of the roles defined by the primary
interface definition.
The most relevant purpose for the Primary InterfaceDef is to define the full and
complete “roleness” of an object. It defines what an object “is” and everything that is
known about it. The IEquipmentOcc defines the what a piece of equipment is in the
schema and the IInstrumentOcc defines what an instrument is. This definition is
completed through the use of the Implies relationships. When you consider the complete
hierarchy of Implies under a Primary InterfaceDef, you know what that object “is”.
Schema Overview and Modeling New Classes 3-33

This definition of “roleness” is used in several ways in SmartPlant:

1. Validation – ClassDefs may not realize any InterfaceDef outside of the implies
hierarchy of the primary InterfaceDef.
2. Sharing – ClassDefs defined as shared must have the same primary InterfaceDef
or must imply the same. PFDProcessEquipment and PIDProcessEquipment have
the same primary InterfaceDef and are defined as shared. EQDReactorVessel does
not have the same primary InterfaceDef, but it does imply the same; i.e.
IReactorVesselOcc implies IEquipmentOcc. Therefore, EQDReactorVessel is
defined as shared with PFDProcessEquipment and PIDProcessEquipment.
3. Mapping – It is possible to map the SmartPlant Schema into the tool Schema by
ClassDef. But to do so, you might end up mapping the same interfaces and
properties over and over. For example, if your application retrieved equipment
tags, you would want to retrieve PFD, P&ID, and EQD. To map by ClassDef, you
would end up mapping to PFDProceeEquipment, PIDProcessEquipment, and
dozens of EQD* ClassDefs. If you map to IEquipmentOcc, you only do so once
and can retrieve any object which realizes that InterfaceDef.
So to summarize primary interface definitions:
1. A primary interface definition is a concept of “roleness” so for example,
IProcessEquipementOcc outlines all process equipment but
PFDProcessEquipment does NOT realize all of its hierarchy only the interfaces it
needs for the class.
2. ALL realize relationships between a classdef and interfaces are scoped by the
primary interface def AND ITS CHILD IMPLIES relations downwards.
3. An implies or primary interface concept is for modelling and mapping “a schema
concept” and bears no relation to instantiation in SPF (only realizes does this).
4. An interface must be realized to be used on a form.

One of the interface definitions that identify a role is IObject. This is the most common
interface in the system and has the properties of unique identifier, a name, and a
description. Every class definition in SmartPlant must realize IObject.
There are no relationships between class definitions, only between interface definitions.
That is because only the interface definitions are exposed to the outside world. The
underlying reason for modeling class definitions and interface definitions instead of class
definitions and relationships is because of the complexity of the relationships that can be
formed.
3-34 Schema Overview and Modeling New Classes

In a traditional class data model, relationships go directly from one class definition to
another. When the class hierarchy gets moderately deep, however, the relationships
become very hard to understand. The consequence is that the modeler moves the
relationships “up” in the hierarchy, which causes ambiguity in defining just what the
relationship represents. By grouping similar characteristics together and exposing them as
an abstract entity called an interface definition, it is easier to maintain precision in the
relationships.

Interface Definitions
InterfaceDefs can imply <<ClassDef>>
other InterfaceDefs. If an <<Realizes>>
PIDInstrument
<<Realizes>>
InterfaceDef implies
<<Realizes>>
another InterfaceDef, then <<InterfaceDef>> <<InterfaceDef>>
any ClassDef that realizes IInstrument <<Realizes>> ILoopMember

the first InterfaceDef can <<Implies>>

also realize the implied <<InterfaceDef>> <<InterfaceDef>>

InterfaceDef. ISolidItem IObject

For example, IInstrument <<Realizes>> <<InterfaceDef>>

implies the ISolidItem. <<InterfaceDef>>
IPlannedFacility
IInstrumentLoop

Therefore, any ClassDef,

such as PIDInstrument, that <<Realizes>>
<<Realizes>>
<<Realizes>>

realizes IInstrument must <<ClassDef>>

also realize ISolidItem. PIDInstrumentLoop

<<PrimaryInterface>>
© 2005. Intergraph Corp.
All Rights Reserved.

There is a relationship defined between InterfaceDefs called “Implies”. If an InterfaceDef

such as IFather implies another interface such as IMale, then any object that has the
IFather interface must also have the IMale interface. The Schema Component enforces
these rules.
The set of interface definitions directly or indirectly implied by an interface definition
defines the “role” for that interface definition. The Implies relationships between
InterfaceDefs, also referred to as implied interfaces, also defines the schema hierarchy,
which allows you to navigate through the schema almost endlessly.
In the schema, every interface definition, except for IObject, should imply the IObject
interface definition.
Schema Overview and Modeling New Classes 3-35

3.6.3 Properties of an Interface Definition

Interface definitions have the following properties:
 Name – Specifies the name of the interface definition.
 Description – Specifies a description for the interface definition.
 Display name – Specifies the name that you want the user interface to use
when displaying the InterfaceDef.

Interface Definitions

© 2005. Intergraph Corp.

 Specialization value – Determines the extent to which this interface identifies

the object. The higher the number, the more specific the interface is for
defining the object. The primary interface for a class definition should have
the highest specialization value. An interface definition should always have a
higher specialization value than any of the interface definitions that it implies.
However, this is not currently checked during validation.
 Interface icon – Specifies the icon that you want to use to represent this
InterfaceDef in the Schema Editor user interface.
 Property category – Defines the property category for properties exposed by
this interface. The property category helps organize properties in the
Properties window in SmartPlant Foundation and SmartPlant P&ID.
 Realized by class definitions – Lists the class definitions that realize this
InterfaceDef.
3-36 Schema Overview and Modeling New Classes

 Primary interface for class defs – Lists the class definitions for which this
InterfaceDef is the primary interface. Primary interfaces should imply
everything that is known about a particular class definition.
 Implies interface definitions – Lists all the InterfaceDefs that this
InterfaceDef implies. All class definitions that realize this InterfaceDef must
also realize all the InterfaceDefs this InterfaceDef implies.
 Implied by interface definitions – Lists all other InterfaceDefs that imply
this one.
 Exposed property definitions – Lists all property definitions that this
InterfaceDef exposes.
 Implementation of enumeration - Defines a relationship between an
enumerated entry that represents a classification hierarchy and the primary
interface of the objects the enumerated entry classifies. For example, a
primary interface, such as IPIDDrawing, should have a relationship with the
P&ID enumerated entry from the DocCategories enumerated list.
Schema Overview and Modeling New Classes 3-37

3.7 Interactive Activity – Creating Interface

Definitions
Next we will create an interface that will act at the primary interface of our new class def.

New Object – The Excel Import Pump Step 3 – Realize as many existing interfaces as are available
in the system that map your needs

Excel Spreadsheet

Want to map a class EIPump for Storage in SPF: <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

Name
Description
<interface> IObject
Pump Type (Picklist)
<property def> Name
<property def> Description
Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
Maximum Temperature

Hold Status (Picklist)

© 2005. Intergraph Corp.

Eventually, we will create implies relationships between our primary interface and each of
the other interfaces realized by our class def.

New Object – The Excel Import Pump Step 5 – Specify a primary interface that identifies the
“uniqueness” of the role for this class def

Excel Spreadsheet
<Class Def > EIPump

<realizes primary interface>

Want to map a class EIPump for Storage in SPF:

<interface> IEI_Pump
Excel Import Pump
Name
Description <implies> <implies>

Pump Type (Picklist)

<interface>
IEI_PumpOcc
IEI_Pump is Primary as it scopes
EIPump in its entirety
© 2005. Intergraph Corp.
All Rights Reserved.

11. Click the browse button beside the Primary interface definition field on the
New Class Definition form.

Creating a Primary Interface Definition

 Click the browse button beside the Primary interface
definition field.

© 2005. Intergraph Corp.

12. The interface we want to use is not the list because it does not exist yet. Click
the New button.

Creating a Primary Interface Definition

 Select the New button from the Possible
PrimaryInterfaceDef Values for EIPump dialog box.

17. The new interface is already selected in the Possible PrimaryInterfaceDef

Values for EIPump dialog box. Click OK to accept the selection.

Creating a Primary Interface Definition

 From the Possible PrimaryInterfaceDef Values for EIPump
dialog box, click OK.

© 2005. Intergraph Corp.

18. The new interface name now appears as the Primary interface definition field.
All required information has been provided. Click OK to create the class def.

Creating a Primary Interface Definition

 The Primary Interface Definition has been set; click OK to
create the class def.

22. From the Tree portion of the window, find the new EIPump class def in the
ClassDef section. Choose the Table (hor) view and review the interface
associated with the class def and the properties exposes by those interfaces.

ClassDef/InterfaceDef Properties
 Review your
changes.
Search for base
classes, and
find EIPump
under
ClassDef.
 Go to the Table
(hor) view to
see the
interfaces
related to the
class def and
any properties
exposes by
those
interfaces.
© 2005. Intergraph Corp.
All Rights Reserved.
Schema Overview and Modeling New Classes 3-47

23. Save the changes you made to the EISchema file. Click File > Save As >
Schema File.

Saving Schema Changes

 On the menu,
click File >
Save As >
Schema File to
save the
changes to the
EISchema.xml.

© 2005. Intergraph Corp.

24. Find and select the EISchema.xml file.

Saving Schema Changes

 Choose the project schema, EISchema.xml, and click Save.

© 2005. Intergraph Corp.

25. When prompted, choose to overwrite the file.

Saving Schema Changes

 Click Yes to save the changes to the project schema.

© 2005. Intergraph Corp.

3.8 Activity 1 – Reviewing Schema Concepts

Complete the Chapter 3 – Activity 1 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.

3.9 Activity 2 – Creating Objects and Relationships

with Schema Editor
Complete the Chapter 3 – Activity 2 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.
3-50 Schema Overview and Modeling New Classes
C H A P T E R 4
Creating Properties,
Enumerated Lists and
Relationships
4-2 Creating Properties, Enumerated Lists and Relationships
Creating Properties, Enumerated Lists and Relationships 4-3

4. Creating Properties, Enumerated Lists, and

Relationships
This chapter covers creating attributes, or properties. Properties can be added to the
interfaces that have been created to define a “role” for the associated class definition.
In some cases, there may be a requirement to use “picklists” from a user interface.
Picklist, or list boxes, can be accomplished by creating an enumerated list type that
contains entries called enum enums.
Finally, this chapter will cover thee ability to create additional relationships, or
relationship definitions, between custom interfaces and existing interfaces.
4-4 Creating Properties, Enumerated Lists and Relationships

4.1 Property Definitions

All property definitions for an object are exposed through its interface definitions and
never directly by the object, or class def. The property definitions that apply to a particular
interface definition are defined by the Exposes relationship between objects of type
InterfaceDef and objects of type PropertyDef.

Property Definitions
InterfaceDefs define <<ClassDef>>
and group <<PropertyDef>>
PIDInstrument
<<Realizes>>
the properties Name

associated with an <<Exposes>>

<<Realizes>>
<<InterfaceDef>>
object. ILoopMember
<<PropertyDef>> <<InterfaceDef>>
InterfaceDefs expose Description <<Exposes>> IObject

property definitions
(PropertyDefs). <<Exposes>>
<<InterfaceDef>>
IInstrumentLoop
A particular <<PropertyDef>> <<Realizes>>
UID
PropertyDef for a <<Realizes>>

given ClassDef is
typically exposed by <<ClassDef>>
one, and only one, PIDInstrumentLoop

InterfaceDef. <<PrimaryInterface>>

© 2005. Intergraph Corp.

For example, the IObject interface definition exposes, among other properties, the
following basic properties:
 UID - Unique identifier for the object. This identifier is only required to be unique
within the SmartPlant.
 Name - Name of the object
 Description - Description of the object
Some interface definitions exist to hold properties, and other interface definitions exist to
form relationships. Some interface definitions are defined for neither properties nor
relationships – they are defined only for a role.
Creating Properties, Enumerated Lists and Relationships 4-5

4.1.1 Properties of a Property Definition

Property definitions have the following attributes in the schema:
 Name – Specifies the name of the PropertyDef.
 Description – Specifies a description for the PropertyDef.
 Display name – Specifies the name that you want the user interface to use
when displaying the PropertyDef.

 Exposed by interface definitions – Lists the interface definition that exposes

this PropertyDef. PropertyDefs are exposed by one and only one
InterfaceDef.
 Scoped by property type – Specifies the property type that scopes this
PropertyDef. You can select from standard property types, like string, double,
integer, Boolean, and so on, or you can select an enumerated list or unit of
measure list to scope this property.
4-6 Creating Properties, Enumerated Lists and Relationships

4.2 Property Types

Each property type is actually a class definition in the meta schema that realizes
IPropertyType, which allows it to be a scoping property type for property definitions.

Property Types
Property types define the set
of possible values for a <<PropertyDef>> <<ScopedBy>> <<StringType>>
PropertyDef. DocTitle String32

The ScopedBy relationship

definition specifies the <<PropertyDef>> <<ScopedBy>> <<YMDType>>
property type that defines DocVersionDate YMD

acceptable values, or scopes,

a particular property
definition. <<PropertyDef>>
WaterCooled
<<ScopedBy>> <<BooleanType>>
Boolean

Every property definition is

scoped by one and only one
property type. All properties <<PropertyDef>>
MolecularWeight
<<ScopedBy>> <<DoubleType>>
Double
of that property definition
must be of that property type.

© 2005. Intergraph Corp.

Basic varieties of property types in the SmartPlant schema include the following:
 Boolean – Specifies that the property can have only one of two values: True
or False.
 Double – Specifies that the property is a double-precision floating point
number.
 String – Specifies that values for the property can contain alphanumeric
strings with some punctuation, such as periods (.), underbars (_), question
marks (?), and so on.
 YMD – Specifies that the property value is a date (year, month, day).
 EnumListType – Specifies that property values are defined by an enumerated
list.
 UoMList – Specifies that values for the property can be a numeric value
(double) combined with a unit of measure from the appropriate unit of
measure list, along with some optional criteria.
Creating Properties, Enumerated Lists and Relationships 4-7

4.3 Interactive Activity – Creating Property

Definitions

Want to map a class EIPump for Storage in SPF: <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

Hold Status (Picklist)

© 2005. Intergraph Corp.

Want to map a class ADC Design Change for

Storage in SPF:- <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

© 2005. Intergraph Corp.

Want to map a class ADC Design Change for

Storage in SPF:- <Comp Schema> SPFExcelImportComponent

Excel Import Pump <class def > EIPump

<interface> IEI_Designed Item

<property def> Maximum Pressure

<Comp Schema> SPFExcelImportComponent

<class def > EIPump

Want to map a class ADC Design Change for
Storage in SPF:-
<interface> IObject
Excel Import Pump
Name <property def> Name
Description <property def> Description

Pump Type (Picklist) <interface> IEI_Pump

Tag Prefix <property def> Pump Type

Tag Sequence Number
Tag Suffix <interface> IEI_TaggedItem

Maximum Pressure <property def> Tag Prefix

Maximum Temperature <property def> Tag Sequence Number
<property def> Tag Suffix
Hold Status (Picklist)
<interface> IEI_Designed Item

<property def> Maximum Pressure

<property def> Maximum Temperature

<interface> IEI_HeldItem
© 2005. Intergraph Corp.
All Rights Reserved. <property def> Hold Status
Creating Properties, Enumerated Lists and Relationships 4-9

7. Create a new interface with the following information.

© 2005. Intergraph Corp.

18. Create a new property with the following information:

 Name – EI_TagSequenceNo
 Description – Excel Import Tag Sequence Number
 Display name – EI Tag Sequence Number
 Exposed by interface definition – IEI_TaggedItem (This property will be
populated automatically.)
 Scoped by property type – string
19. Click OK to create the new property.

Create a Property Definition

 For the new property, provide a name, description, display
name, and property type. Click OK.

© 2005. Intergraph Corp.

20. The new property is added to the list of available properties. Click New to
create another new property.

Create a Property Definition

 ClickNew to create one more new property.

© 2005. Intergraph Corp.

© 2005. Intergraph Corp.

27. Create a new interface with the following information:

 Name – IEI_DesignedItem
 Description – Excel Import Designed Item Interface
 Display name – EI Designed Item
 Realized by class definitions – EIPump
 Implies interface defintions – IObject
 Implied by interface definitions – IEI_Pump
28. Click the browse button beside the Exposed property defintions field.

Create a Property Definition

 Provide the applicable information about the interface.

© 2005. Intergraph Corp.

29. No properties are available for selection. Click the New button to create a new
property.

Create a Property Definition

 Click the browse button beside the Exposed property
definitions field, and click the New button to create a new
property.

© 2005. Intergraph Corp.

© 2005. Intergraph Corp.

© 2005. Intergraph Corp.

4.4 Enumerated List Type

An enumerated list (EnumListType) is one of the property types that can scope property
definitions. Enumerated lists are sometimes called picklists. Each enumerated list contains
one or more enumerated entries (EnumEnum). Each enumerated entry represents a
possible value for a property scoped by that enumerated list.

Property Types - Enumerated List Type

Property definitions of the <<PropertyDef>>
DesignStatus
enumerated list type
(EnumListType) have a list <<ScopedBy>>

of possible string property

values defined for them in <<EnumListType>>
DesignStatus
an enumerated list.
Any value for a PropertyDef <<Contains>> <<Contains>>

of this type must match an

entry in the list of <<EnumEnum>>
Preliminary
<<EnumEnum>>
Final
enumerated property values
defined for the property
type. <<Contains>>

<<EnumEnum>>
Released

© 2005. Intergraph Corp.

Enumerated lists may be combined to form an enumeration hierarchy. When this happens,
a special property type (enumerated list level type) is used to describe all of the
enumerations at a given level in the enumeration hierarchy.
Creating Properties, Enumerated Lists and Relationships 4-39

Property Types - Enumerated List Type

Enumerated lists can be combined to form an enumeration
hierarchy.
All nodes in the hierarchy that are EnumListTypes are
enumerated entries for the EnumListType above them.
All EnumListType nodes must contain EnumEnums (list
entries) or other EnumListTypes (enumerated lists).

© 2005. Intergraph Corp.

For example, the typing of equipment consists of a multi-level hierarchy, where each level
down the hierarchy provides a more specific definition of the equipment. Every branch
node in a hierarchy is itself an enumerated list, as well as an enumerated value. Only the
topmost node in the hierarchy is not an enumerated value (just an enumerated list) and
only the leaf nodes in the hierarchy are not enumerated lists (just enumerated values).
4-40 Creating Properties, Enumerated Lists and Relationships

The following UML diagram presents the SmartPlant schema model for enumerated lists
and enumerated entries.

Property Types - Enumerated List Type

<<EnumEnum>>
PBS Document

© 2005. Intergraph Corp.

The PBS Documents EnumListType contains an EnumEnum called PBS Document.

Creating Properties, Enumerated Lists and Relationships 4-43

4.4.1 Properties of an Enumerated List Type

The following options are available when you create or edit an enumerated list type:
 Enumerated entries – Displays the enumeration hierarchy as you add child lists and
entries to the main enumerated list.
 UID – Displays the unique identifier for the enumerated list. The UID is automatically
assigned by the Schema Editor.
 Short description – Specifies a short description for the enumerated list. The short
description is used as the name for the enumerated list throughout the Schema Editor.
 Long description – Specifies a long description for the enumerated list.
4-44 Creating Properties, Enumerated Lists and Relationships

 Number – Specifies a number that can be used as a secondary key to identify the
enumeration.
 Metadata for enumeration – Defines a relationship between the enumerated entry
and another object or objects in the schema that provide more information about that
enumeration. This is frequently used to relate enumerations to interface definitions for
type hierarchies.
 Contained in – Identifies the names of other enumerated lists that contain this
enumerated list.
 Contains – Identifies the names of other enumerated lists and enumerated list entries
that this list contains.
 Scoped property definitions – Identifies the property definitions that have a
ScopedBy relationship with this enumerated list type.
 New Child List – Creates a new child list (EnumListType) under the selected node in
the enumeration hierarchy. When you select an enumerated entry and create a new
child list under it, it becomes an EnumListType object.
 New Child Entry – Creates a new child enumerated list entry (EnumEnum) under the
selected enumerated list in the hierarchy.
 Import Lists from Clipboard – Imports enumerated lists that you have copied from a
spreadsheet to the Clipboard into the Schema Editor. When you import lists, the
Schema Editor tries to map the contents of the Clipboard to the appropriate
enumerated list properties based on the imported values. You can change this mapping
manually in the Import from Clipboard dialog box.
 Import Entries from Clipboard - Imports enumerated list entries that you have
copied from a spreadsheet to the Clipboard into the Schema Editor. When you import
entries, the Schema Editor tries to map the contents of the Clipboard to the appropriate
enumerated entry properties based on the imported values. You can change this
mapping manually in the Import from Clipboard dialog box.
 New Sibling – Creates a new enumerated list or enumerated list entry at the same
level as the list or entry selected in the Enumerated entries tree.
 Delete – Deletes the selected node in the Enumerated entries tree.
Creating Properties, Enumerated Lists and Relationships 4-45

4.4.2 Unit of Measure List Types

The unit of measure (UoM) list type is specialization of the enumerated list type
(IUoMListType implies IEnumListType). A unit of measure list contains unit of measure
enumerated values (UoMEnum). A UoMEnum contains two conversion factors: A
(multiplier) and B (addend). These conversion factors are used to convert the value to SI
units.

Property Types - Unit of Measure List Type

The unit of measure list <<PropertyDef>>
OperatingTime
type (UoMListType) is a
special type of <<ScopedBy>>
<<HasDefaultSI>>
enumerated list with
additional semantic <<UoMEnum>> <<UoMListType>> <<UoMEnum>>
yr TimeUoM <<Contains>> s
information.
<<Contains>>

Each enumerated entry in

the UoM list has <<Contains>> <<Contains>>
conversion factors to
<<UoMEnum>> <<UoMEnum>>
convert from the SI units d min
for that list to the specific <<Contains>> <<Contains>>

units of measure selected

<<UoMEnum>> <<UoMEnum>>
by the user. wk h

© 2005. Intergraph Corp.

For example, the given unit (x) is multiplied by A and then B is added to that value to
determine the SI value (y = Ax + B).

NOTE: SI stands for International System of Units and is the modern metric system of
measurement. Long the language universally used in science, the SI has become
the dominant language of international commerce and trade. SI is the basis used
for the conversion of UOM’s.

A UoMListType is a composition of enumerated unit of measure entries. One entry in

every unit of measure list has a relationship of HasDefaultSI with the UoMListType,
which means that this entry is the default SI unit of measure for the list. For example, in
the TimeUoM list, "s" (seconds) is the default SI unit of measure for time.
A unit of measure list may have an associated enumerated list that identifies the possible
conditions for that unit of measure list. For example, the pressure unit of measure list has
4-46 Creating Properties, Enumerated Lists and Relationships

an associated enumerated list that identifies whether the pressure value is absolute or
gauge (@ Gauge).
A PropertyDef that is typed as unit of measure has a double precision floating point value
in the SI unit for that list. It can also have a preferred display unit of measure, a number of
significant digits, and uncertainty.
Creating Properties, Enumerated Lists and Relationships 4-47

4.4.3 Properties of a Unit of Measure List Type

The following options are available when you create a new enumerated list type:
 Name – Specifies the name of the unit of measure list.
 Description – Specifies a description for the unit of measure list
 Conditions list – Identifies the enumerated list that contains the possible conditions
for a property scoped by this unit of measure list. For example, the pressure unit of
measure list uses a conditions list that identifies whether the pressure value is absolute
or gauge.

 Scopes property definitions – Lists the property definitions that are scoped by this
unit of measure list.
4-48 Creating Properties, Enumerated Lists and Relationships

 Unit of measure entries – Displays the unit of measure entries for this list in tabular
format.
 UID – Displays the unique identifier for the selected entry in the list. The UID is
automatically assigned by the Schema Editor, but you can change it.
 Short description – Specifies a short description for the unit of measure list entry.
The short description is used as the name for the entry throughout the Schema Editor.
 Long description – Specifies a long description for the unit of measure list entry.
 A conversion factor – Specifies the multiplier used to convert from this unit of
measure to SI units. Conversions are done using y = Ax + B, where x is the value in
this unit of measure and y is the value in SI units.
 B conversion factor – Specifies the addend used to convert from this unit of measure
to SI units. Conversions are done using y = Ax + B, where x is the value in this unit of
measure and y is the value in SI units.
 Is default SI unit of measure? – Specifies whether this unit of measure is the default
SI unit of measure for this list.
 New – Adds a new unit of measure entry to the list.
 Delete – Deletes the selected unit of measure entry from the list.
 Test – Allows you to test conversions among units of measure in this list using the A
and B conversion factors defined for each unit of measure and any specified
conditions for each unit of measure.
Creating Properties, Enumerated Lists and Relationships 4-49

4.5 Interactive Activity – Creating an Enumerated

List Property

New Object – The Excel Import Pump Step 6 – Scope the design status property using a “picklist”,
an enum list type and enum enums (entries)

Excel Spreadsheet
<interface>
IEI_Pump

<exposes>
Want to map a class EIPump for Storage in SPF:

<property def> EI_PumpType

Excel Import Pump
Name <scoped by>
Description

Pump Type (Picklist) <enum list type>

PumpTypes
Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
<contains>
Maximum Temperature

Hold Status (Picklist)

<enum enum> <enum enum>
Horizontal Vertical

© 2005. Intergraph Corp.

New Object – The Excel Import Pump Step 6 – Scope the design status property using a “picklist”,
an enum list type and enum enums (entries)

Excel Spreadsheet
<interface>
IEI_HeldItem

<exposes>
Want to map a class EIPump for Storage in SPF:

<property def> EI_HoldStatus

Excel Import Pump
Name <scoped by>
Description

Pump Type (Picklist) <enum list type>

HoldStatuses
Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
<contains>
Maximum Temperature

8. Provide a name and description for the new list.

 Name – PumpTypes
 Long description – Pump Types

Creating an Enumerated List Type

 Provide a name for the
list that will contain
the values for this
property. Use the
Long description field
to provide more
description of the
purpose of the list.

© 2005. Intergraph Corp.

9. If you want, you can also replace the default UID value with a unique, but
more user-friendly value. This value will be used throughout the software to
indicate the list that scopes the property.
 UID – PumpTypes
10. When you have finished providing information about the list itself, you are
ready to start creating the values in the list. Click the New Child Entry button.

Creating an Enumerated List Type

 If you wish, you can
replace the default UID
value with a more
descriptive, but unique
value.
 Next, click the New
Child Entry button to
create the values within
the list.

© 2005. Intergraph Corp.

11. A new object appears in the tree, as a child of the new list.

Creating an Enumerated List Type

 A new level appears
in the list on the left.
Items at this level are
values contained
within the list – enum
enums.

© 2005. Intergraph Corp.

12. Provide a name, description, and unique UID for the list value, and then click
New Sibling to create another. The number field is optional, but may be used
to specify the order of the values in the list box.
 Name – Horizontal
 Long description – Horizontal Pump
 UID – HorizontalPump
 Number – 1

20. Provide the following information about the new interface.

 Name – IEI_HeldItem
 Description – Excel Import Held Item Interface
 Display name – EI Held Item
 Realized by class definitions – EIPump
 Implies interface defintions – IObject
 Implied by interface definitions – IEI_Pump
21. Click the browse button beside the Exposed property definitions field.

Creating an Enumerated List Type

 Provide the required information about the new interface,
and then click the browse button to find properties to
expose.

© 2005. Intergraph Corp.

22. Click the New button to create a new property.

Creating an Enumerated List Type

 Click the New button to create a new property to expose
on this new interface.

© 2005. Intergraph Corp.

23. Create a new property with the following information:

 Name – EI_HoldStatus
 Description – Excel Import Hold Status Property
 Display name – EI Hold Status
 Exposed by interface definition – IEI_HeldItem
24. Click the browse button beside the Scoped by property type field.

Creating an Enumerated List Type

© 2005. Intergraph Corp.

32. From the list of property types, find the new enumerated list. It should be
selected automatically. Click OK to choose it.

Creating an Enumerated List Type

 Choose the new enumerated list as the property type.

© 2005. Intergraph Corp.

33. Click OK to create the new property.

Creating an Enumerated List Type

 Click OK to create the new EI_HoldStatus property.

© 2005. Intergraph Corp.

34. The new property will be selected. Click OK.

Creating an Enumerated List Type

 Click OK to add the new EI_HoldStatus property to the new
interface.

© 2005. Intergraph Corp.

35. Click OK to create the new interface definition.

Creating an Enumerated List Type

 Click OK to create the new IEI_HeldItem interface.

© 2005. Intergraph Corp.

36. The new interface will appear in the UML window.

Creating an Enumerated List Type

 View the new interface in the UML window.

© 2005. Intergraph Corp.

Review of the EIPump shows that we have now modeled all the requirements for our new
class of pump.

Creating an Enumerated List Type

 From the tree, find the EIPump and view it with the
Properties view. Compare the list to the requirements

Excel Import Pump

Name
Description

Pump Type (Picklist)

Tag Prefix
Tag Sequence Number
Tag Suffix

Maximum Pressure
Maximum Temperature

Hold Status (Picklist)

The following graphic is an illustration of all the pieces modeled so far in Chapters 3 and
4.
4-74 Creating Properties, Enumerated Lists and Relationships

4.6 Relationship Definitions

All relationship definitions in the schema are of class RelDef, which is part of the meta
schema. A RelDef has two ends, End1 and End2. The positive direction for navigating
this relationship is from End1 to End2. The reverse direction is from End2 to End1. A
relationship can only exist between objects that support (realize) the interface definitions
at each end of the relationship definition.

Relationship Definitions
Relationship definitions (RelDef) are associations between
interface definitions. A RelDef will define two object instances
that fulfill the roles on each end of the relationship.
Relationship definitions also define cardinalities on each end
of the relationship.
The following is an example of a relationship showing
equipment components that can be associated with equipment
e.g. nozzles on a vessel.
Cardinality Relationship Name Cardinality
on End 1 on End 2

represents 2 represents a
or more Roles on Each End vessel
nozzles
© 2005. Intergraph Corp.
All Rights Reserved.

Cardinalities provide the constraints for relationships by defining the minimum and
maximum numbers of participants at each end of a relationship. For example, in the
EquipmentComponentComposition relationship there can be zero to many (0..*) objects
that have the role of Equipment Components but only zero or one (0..1) object that can
have the role of Equipment in each instance of the relationship. For example there could
be many nozzles and some may be associated to a vessel but that nozzle instance would
not be connected to more than one (i.e. multiple) vessel.
Creating Properties, Enumerated Lists and Relationships 4-75

When something is published, a Rel (relationship) is an instantiation of a RelDef.

Relationship Definitions

re
s ali
ze ze
ali s
re

<<Class>>
<<Class>> <<Class>>
<<Class>>

Rel
Rel
Instance
Instance
Object
Object UID=XX
UID=XX Object
Object
Instance
Instance Instance
Instance
UID=01
UID=01 UID=02
UID=02
Rel Obj1 Obj2
<<Rel Type>> Relationship
UID UID UID Properties

XX 01 02 EquipmentComponentComposition

© 2005. Intergraph Corp.

Relationship Definitions
Engineering tools can publish objects at different times.
Users can publish nozzles ahead of equipment.
The software has to decide “can this relationship be
resolved”? An example would be P&ID could publish
nozzles first and then vessels are published later. The
software would suppress errors because there is no harm
in doing this since the vessels CAN be published at a later
time.
When defining a relationship definition, End 1 and End 2
interfaces depends on which way users are going to
query.

© 2005. Intergraph Corp.

The locality of reference, which is shown as part of the role name, shows how this
relationship will be instantiated:
 “I’ve got to publish.”
 “You have to publish.”
 “Someone will publish someday.”

Relationship Definitions

Locality of Reference

- has been published by another component

+ must be in the same container as object 2
# must be published by the same tool

© 2005. Intergraph Corp.

4.6.1 Properties of Relationship Definitions

When you create or edit a relationship definition in the Schema Editor, you can define the
following options:
 Name – Specifies the name of the relationship definition.
 Description – Provides a more detailed description of the relationship
definition.

 Ordering – Specifies whether the relationship is ordered (optional). If objects

in a relationship are ordered, they can be ordered from end 1 to end 2 or from
end 2 to end 1, but not both. Ordering relationships is important when the
4-78 Creating Properties, Enumerated Lists and Relationships

sequence of the related objects is important. For example, the order of the
piping ports for a piping connector is important in understanding the logical
connectivity. Conditional ordering is not currently supported in SmartPlant.
 Abstract relationship – Indicates that the relationship definition is abstract.
An abstract relationship cannot be directly instantiated (no Rel objects can use
the abstract relationship definition). Abstract relationship definitions are used
for generic traversal operations. An abstract relationship definition must be
specialized by one or more concrete (standard) relationship definitions. (Note:
Do NOT publish abstract relationships.)
 Standard relationship – Indicates that the relationship definition is a standard
relationship. Standard relationships are also called concrete relationships.
Standard or concrete relationship definitions can be used for instantiated
relationships. A relationship definition can be either abstract or standard, but
not both.
 Specialization of abstract relationship definition – Specifies the name of
the abstract relationship definition of which this standard relationship
definition is a specialization. Any standard (concrete) relationship that is a
specialization of an abstract relationship is also treated as an instance of that
abstract relationship. For example, the PipingEnd1Conn, PipingEnd2Conn,
and PipingTapOrFitting concrete relationship definitions are all specializations
of the Connections abstract relationship definition. Therefore, a connection at
end 1 is a PipingEnd1Conn relationship and also a Connections relationship
(one Rel that is a specialization). A connection at end 2 is a PipingEnd2Conn
and also a Connections relationship; a tap/fitting connection is a
PipingTapOrFitting relationship and also a Connections relationship.
 End 1
• Interface definition – Identifies the interface definition at end 1 of the
relationship definition.
• Role – Specifies the name of the role for end 1 of the relationship.
• Minimum cardinality – Specifies the minimum number of participants allowed
on end 1 of the relationship. Possible values are 0, 1, and 2.
• Maximum cardinality – Specifies the maximum number of participants allowed
on end 1 of the relationship. Possible values are 1, 2, or * (many).
• Object at end 1 – Specifies whether hanging relationships are allowed for the
object at end 1 of the relationship. Objects can be required to be located in the
same container (typically a document) as the other object in the relationship, to be
published by the same authoring tool as the other object, or to be published by
another component.
• Filter out edge in display – Specifies whether you want to see the relationship
edge automatically created from end 1 to end 2 of this relationship in the Schema
Editor user interface. If this option is set to True, user access for this edge
definition can be controlled in the SPF client by user group security.
Creating Properties, Enumerated Lists and Relationships 4-79

 End 2
• Interface definition – Identifies the interface definition at end 2 of the
relationship definition.
• Role – Specifies the name of the role for end 2 of the relationship.
• Minimum cardinality – Specifies the minimum number of participants allowed
on end 2 of the relationship. Possible values are 0, 1, and 2.
• Maximum cardinality – Specifies the maximum number of participants allowed
on end 2 of the relationship. Possible values are 1, 2, or * (many).
• Object at end 2 – Specifies whether hanging relationships are allowed for the
object at end 2 of the relationship. Objects can be required to be located in the
same container (typically a document) as the other object in the relationship, to be
published by the same authoring tool as the other object, or to be published by
another component.
• Filter out edge in display – Specifies whether you want to see the relationship
edge automatically created from end 2 to end 1 of this relationship in the Schema
Editor user interface. If this option is set to True, user access for this edge
definition can be controlled in the SPF client by user group security.
 Delete object 2 when object 1 is deleted? – Indicates whether you want the
software to delete the object on end 2 of the relationship when the object on
end 1 is deleted.
 Delete object 1 when object 2 is deleted? – Indicates whether you want the
software to delete the object on end 1 of the relationship when the object on
end 2 is deleted.
 When object 1 is copied – Specifies what you want the software to do when
the object on end 1 of the relationship is copied. You can choose whether to
copy the object on end 2 as well, copy the object and relationship, leaving the
relationship pointing to the same object that the first relationship pointed to, or
not to copy the object or relationship at all.
 When object 2 is copied – Specifies what you want the software to do when
the object on end 2 of the relationship is copied. You can choose whether to
copy the object on end 1 as well, copy the object and relationship, leaving the
relationship pointing to the same object that the first relationship pointed to, or
not to copy the object or relationship at all.
4-80 Creating Properties, Enumerated Lists and Relationships

4.6.2 Interactive Activity – Creating Relationship

Definitions
1. Create a new interface. Drag and drop the InterfaceDef option from the Create
section of the Editor view into the UML window.

Create a Relationship Definition

 Create one more
interface definition by
dragging the InterfaceDef
option from the Create
list to the UML window.

© 2005. Intergraph Corp.

2. Create a new interface with the following information:

8. Provide information about each end of the relationship definition:

End 1
 Interface definitions – IEI_PumpOcc
 Role – Pumps (Excel)
 Role display name – Pumps (Excel)
 Minimum cardinality – 0
 Maximum cardinality – *
End 2
 Interface definitions – ISPFDocumentVersion
 Role – Document Versions (Design)
 Role display name – Document Versions (Design)
 Minimum cardinality – 0
 Maximum cardinality – *

Create a Relationship Definition

 In the middle section of the form, provide information
about the two ends of the relationship. First select the
interfaces that the relationship will join, then complete
additional information for each of the two ends.

© 2005. Intergraph Corp.

9. Click OK to create the relationship definition.

Create a Relationship Definition

 Finally, specify how the relationship should be managed
when each end is copied or deleted.
 When you are done, click OK to dismiss the form and create
the relationship definition.

© 2005. Intergraph Corp.

10. Create a second reldef to relate pumps to contracts.

Create a Relationship Definition

 Create another Reldef, by dragging and dropping the
RelDef option from the Create section of the Editor. This
relationship will relate our Excel pumps to contracts.

© 2005. Intergraph Corp.

11. Choose the pump as End 1 and the contract as end 2.

Create a Relationship Definition

© 2005. Intergraph Corp.

4.7 Shared Object Definitions

A shared object definition is used to group together similar classes that define the same
object in different domains. For example, in a Process Flow Diagram (PFD) a user places
a pump called P100 and publishes the document.

Shared Object Definitions

Shared object definitions
(SharedObjDef) are used to <<ModelDef>>
PlannedMaterialModel
group together similar
classes that define the same
object in different domains.
In concurrent engineering, <<ModelClass>> <<ModelClass>>

two different tools can create

<<ClassDef>> <<ClassDef>>
and publish the same object. PIDInstrument INDXInstrument
For example, instruments
can be created and
published in both SmartPlant <<ModelSharedObjDef>>

P&ID and SmartPlant

Instrumentation. <<Sharing>> <<Sharing>>

ClassDefs that can be shared

<<SharedObjDef>>
have a Sharing relationship SharedInstrument_PM
with SharedObjDefs.
© 2005. Intergraph Corp.
All Rights Reserved.

At the front end of the engineering process, not a lot of information is known about the
pump other than the following:
 Some kind of pumping function is required.
 The pump is connected to streams.
 The streams have a certain fluid code running through them.
 The pump needs to pump at a certain volume.
When the PFD is defined, the user does not know how the pumping function with these
general requirements will be accomplished. That information is left up to the P&ID
portion of the workflow. In the PFD, the user sees some interfaces and properties of the
pump, but not everything that defines the pump in SmartPlant.
Creating Properties, Enumerated Lists and Relationships 4-91

In SmartPlant P&ID, engineers start adding value to the design by adding more and more
information, such as the type of pump needed and so on. When SmartPlant P&ID
publishes the document containing the same pump (P100) as part of the workflow, the
users see more interfaces because the pump object is being enriched as it moves through
the design process. When the engineer updates the Equipment Data Sheet in Zyqad, there
are thousands of properties describing the same object, further enriching it.
In each tool, the pump (P100) is published with a different class definition, including
PFDProcessEquip, PIDProcessEquip, and EQDCentrifugalPump. However, a
SharedObjDef indicates that these three classes definitions all define the same object in
SmartPlant. The three class definitions coexist in a sharing relationship. The
SharedObjDef collects information to indicate this sharing relationship. If you look at the
realizes relationship for each class definition, you can see many of the same properties
because as the object moves from one tool to another, properties are updated and the
information is enriched.
When an object is created in the PFD, it has a unique identifier for the object (UID). For
example, PFD UID AA1 (P100) gets published. Then, SmartPlant P&ID retrieves P100,
some additional work is done, and it gets published as PID UID AA2 (P100).
The two publishes establish a “same as” relationship. The same as relationship indicates
that object AA1 is the same as object AA2.
4-92 Creating Properties, Enumerated Lists and Relationships

4.7.1 Properties of a Shared Object Definition

Shared object definitions have the following properties:
 Name – Specifies the name of the shared object definition.
 Description – Specifies the description of the shared object definition.

 Model definition – Specifies the model definition to which the shared object
definition belongs. Objects can only be shared if they exist in the same model.
 Shared by class definitions – Specifies the class definitions that have a sharing
relationship with this SharedObjDef.
Creating Properties, Enumerated Lists and Relationships 4-93

4.8 Activity – Creating Properties, Enumerated

Lists and Relationships
Complete the Chapter 4 – Activity 1 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.
4-94 Creating Properties, Enumerated Lists and Relationships
C H A P T E R 5
Creating EdgeDefs, Graph
Defs and View Defs
5-2 Creating EdgeDefs, Graph Defs and View Defs
Creating EdgeDefs, Graph Defs and View Defs 5-3

5. Creating EdgeDefs, Graph Defs, and View Defs

You will continue to add components to your data model in this chapter. This chapter will
cover the object to object navigation functionality that is used by the SmartPlant
Foundation Desktop client. For discussion purposes, we will refer to these object types as
navigation objects.
The ability to navigate from one object in the model to another object in the model can be
determined by Edge definitions. This allows you to specify which interface to start the
navigation, and which direction to use to see information associated with a different
interface.
Once these navigation edges have been defined, they can be grouped together to form a
Directed Graph definition. These are a connected network of edge definitions.
Finally a View definition is a way of filtering lists of properties that will be available in
the user interface.
These object types are not required in order to create data in the database. They will be
used only by SmartPlant Foundation once they have been loaded to the SPF Admin
database.
5-4 Creating EdgeDefs, Graph Defs and View Defs

5.1 Edge Definitions

Edge definitions are used to combine multiple relationships into a single definition and
have the following properties:
 A starting interface definition
 A path definition that specifies the relationships to traverse from the starting
interface definition along related interface definitions and the direction to
traverse those relationships (+ or -)

Edge Definitions
Edge definitions (EdgeDef) are
single or multiple relationship A
definitions with direction. In 1
the schema, an edge definition Re
+Rel1

is used to traverse from a l1

starting object to related -Rel1

objects. 2
B
Two implicit edges exist for 2
every relationship in the
schema. One that is positive Rel2
(going from end 1 to end 2 of
the relationship), and one that 1
is negative (going from end 2 C
to end 1). 1

© 2005. Intergraph Corp.

 Discrimination criteria that can be applied to objects at the end of the path
 Position criteria that can select a specific object from the set of objects that
satisfy the discrimination criteria at the end of the path
When you create an interface definition in the Schema Editor, the software automatically
creates a corresponding edge definition. This edge definition is given a UID and name that
is a combination of + and the UID for the interface definition. When you create a
relationship definition in the Schema Editor, two edge definitions exist: one for traversing
from end 1 of the relationship to end 2 and the other for traversing from end 2 to end 1.
In addition to these automatically generated edge definitions (implicit EdgeDefs), you can
explicitly define edge definitions for a variety of purposes in the Schema Editor. Explicit
edge definitions may be used to traverse across multiple relationships, to select only
certain objects from the destination end, or to do multiple relationship traversal and
selective discrimination.
Creating EdgeDefs, Graph Defs and View Defs 5-5

Edge Definitions
EdgeDefs collect one or
more relationship edges. A
1
EdgeDefs can specify Re
l1
+
EdgeDef 1
discrimination criteria, +Rel1, -Rel2
including position, to help 2
you filter the objects at the B
end of the path defined by 2 -
the EdgeDef.

Rel2
1
C

© 2005. Intergraph Corp.

5.1.1 Properties of an Edge Definition

Edge definitions have the following properties:
 Edge name – Specifies the name of the edge definition.
 Property category – Defines the property category for properties contained in
this edge definition. The property category helps organize properties in the
Properties window in SmartPlant Foundation and SmartPlant P&ID.
 Display name – Specifies the name that you want the user interface to use
when displaying the edge definition.
 Starting interface – Allows you to select the starting interface when you
create a new edge definition.
 Filter out edge in display – Specifies whether you want to see the edge
definition in the Schema Editor user interface. If this option is checked ( 4)
which is True, user access for this edge definition can be controlled in the SPF
client by user group security.
Creating EdgeDefs, Graph Defs and View Defs 5-7

 Path – Allows you to select the relationship edges that you want to include in
the edge definition. The set of edge definitions that appear here are the set of
interface definitions that apply to the end interface definition. As you click
nodes in the tree, the path for the edge definition updates beside the Path label
at the bottom of the dialog box. The UI allows you to include interface
definitions that are implied by the end interface definition in your edge
definition. Every edge definition starts at an interface definition and traverses
through one or more relationship definitions to another interface definition at
the other end. When you define a path for an edge definition, the set of edge
definitions that appear in the Current edge definition window are the set of
interface definitions that apply to the end interface definition. For example, if
you traverse the relationship definition from equipment to equipment
components, you will see the edge definitions that apply to the role of
equipment components. However, if you want to continue the path using
nozzles, which are a specialization of equipment components, then you can
select INozzleOcc from this list. Selecting INozzle for example, will allow
you to continue the path using the more specific nozzle edge definitions.
5-8 Creating EdgeDefs, Graph Defs and View Defs

The following UML diagram shows an EdgeDef that navigates from a piece of equipment
to the P&ID on which the piece of equipment appears:

You can also define discrimination criteria for edge definitions using the options on the
Filter tab.

Creating Edge Definitions

 The path from Contract
to Pump (Excel) is
displayed in the UML
left-hand pane.
 Go to the Filter tab of
the form.

© 2005. Intergraph Corp.

14. From the Filter tab, we will specify a criteria that pumps (the end point) must
meet in order to be returned by this edge def. Click the Add Filter button.

Creating Edge Definitions

 From the Filter tab, click the Add Filter button to
add a condition that must be met on the
destination end of the edge.

© 2005. Intergraph Corp.

© 2005. Intergraph Corp.

20. Click OK to finish creating the new edge definition.

5-32 Creating EdgeDefs, Graph Defs and View Defs

5.3 Graph Definitions

Graph definitions (GraphDef), also called Directed Graph Definitions in the schema, are
a connected network of edge definitions starting at a particular interface definition.

Graph Definitions
Graph definitions (GraphDef) are a set
of edge definitions with structure. A
1
1
Each GraphDef starts at an interface Ed
ge
Re De
definition and branches out from that

Rel3
l1 f 1 GraphDef 1
interface definition to related interface +Rel1, -Rel2, +Rel3
definitions. 2
2
B
Any edge that is tied to the starting D
2
interface definition or to any interface
definition implied by that interface

Rel2
definition can be used as part of the
GraphDef. 1

It is not necessary to create EdgeDefs C

for GraphDefs unless you need to

apply criteria.

© 2005. Intergraph Corp.

Graph definitions include the following:

 A relationship to its starting interface definition
 A definition of the directed graph
When you create a GraphDef, explicit EdgeDefs are not required unless you need to apply
criteria. One is example is the Equipment to Nozzle relationship. You must turn the one-
to-many relation into many one-to-one relationships using the position criteria. Another
example is the Equipment to Drawing relationship. If you want to put include the P&ID in
the GraphDef, you need to navigate that relationship, but you must apply criteria to get
only P&IDs instead of all drawings.
In SmartPlant Foundation, graph definitions are used to define default expansions and
alternate expansions for class definitions. They are also used to define datasheets for
SmartPlant. If the name of a class definition is the same as the name of a graph definition,
the graph definition is automatically used to define the default expansion for the class
definition. For example, when you expand an object in the tree view, the graph definition
with the same name as the class to which the object belongs defines the default expansion
that you see.
Creating EdgeDefs, Graph Defs and View Defs 5-33

While schema-based depictions of the data are useful to users who are familiar with the
underlying schema, other users need more user-oriented views of the data for it to be
meaningful.

View Definitions
View definitions (ViewDef) are properties extracted from possible
properties that a graph definition exposes. A view definition is
used to provide a different view of data from that provided by the
underlying schema.
1 A Properties

1 Name
GraphDef 1

Re Prop2
Rel3

l1 Prop3

2 Properties
2
Name
D B
PropB
2
Properties PropC
Rel2

Name
Prop2A
Prop3A Properties
1
OtherProp
C
Prop22

© 2005. Intergraph Corp. Prop33

View Definitions
ViewDefs are SmartPlant equivalents of relational
database views. A relational database view is a
combination of joins and projects where the joins are
used to retrieve the desired objects and the projects are
used to determine which properties (columns) to include
and what to call those properties.

© 2005. Intergraph Corp.

SmartPlant view definitions consist of the following:

 A relationship to its starting interface definition
 An identification of the directed graph definition that applies
 A definition of the projection of property definitions from the directed graph
definition
A view definition is based on a directed graph definition and, therefore, like the directed
graph definition, has a relationship to its starting interface definition. In actuality, this
interface definition is always the same interface definition as that for its directed graph
definition. The directed graph definition for the view definition defines the set of edge
definitions that will be traversed when the view corresponding to the view definition is
created.
In SmartPlant Foundation, view definitions are used to define what users see in the
Properties window when they select an object in the client. When you create ad-hoc
reports in the SmartPlant Foundation client, you can also select the view definition that
you want to use as the basis for the report as well as the properties from that view
definition that you want to include in the report.
You can also use view definitions to create alternate views for class definitions.
5-44 Creating EdgeDefs, Graph Defs and View Defs

5.5.1 Properties of a View Definition

The following options are available when you create or edit a view definition:
 View name – Specifies the name of the view definition.
 Comparison view - Specifies whether this view definition is used for comparison. A
comparison graph definition is a special type of view definition that is intended for
performing comparisons between the two sets of data described by the comparison
view definition.
 Map view – Specifies whether or not the view definition is to be used for defining
mapping between applications and the SmartPlant schema.
 View definition category – Currently not used
 Display name - Specifies the name that you want the user interface to use when
displaying the view definition.
 Graph name – Specifies the name of the graph definition that this view definition
contains.

 Current view definition - Displays the current view definition in text format. You
can edit the view definition manually in this box.
 Name – Specifies the name of the selected property when it appears in the view
definition. After you select the property that you want to add you can type a new
display name here.
Creating EdgeDefs, Graph Defs and View Defs 5-45
5-46 Creating EdgeDefs, Graph Defs and View Defs

5.6 Interactive Activity – Creating View Definitions

This interactivity activity demonstrates the process of creating a new view definitions for
use with the new EIPump class def.
1. Create a new view definition by finding the ViewDef option from the Create
section of the Editor view and dragging and dropping that option into the
UML view.

Create View Definition

 Drag and drop the ViewDef object type from the
Create section to the right pane.

Create View Definition

 You can review the UML view before you click OK.

© 2005. Intergraph Corp.

5.6.1 Save the Changes to the Schema File

Be sure to save the changes you have made to the your schema file. Use the File > Save >
Schema File command to save the changes to the EISchema file.

Results of Edges, Graphs, and Views

 Make sure all changes to the
schema is saved. Use the
File > Save > Schema File
command to save the
EISchema file.

© 2005. Intergraph Corp.

The UML diagram below shows all the changes that have been made to the schema.
5-60 Creating EdgeDefs, Graph Defs and View Defs
C H A P T E R 6
Viewing and Finding Data
6-2 Viewing and Finding Data
Viewing and Finding Data 6-3

6. Viewing and Finding Data

Many sessions in the Schema Editor are typically performed to view the data files and not
the schema files. When you want to view data files, you must open a schema file before
you can open the data file. To view data organized by schema classes, it is often useful to
view the data in terms of the schema.

Viewing a Data File

Many of the same views that are useful for viewing the schema
are also useful for viewing data files.
Some of the most valuable data views include:
 Data Tree/Viewable UML View
 Data Tree/Table View
 Data Tree/Properties View
 Data Tree View

© 2005. Intergraph Corp.

The data that can be viewed by the schema editor is the contents of the XML container
that gets created as a result of performing a Publish operation from one of the engineering
authoring tools.

For example, if drawing 128-5001 gets published from SmartPlant P&ID, the instantiation
of the objects can be viewed in the SmartPlant Foundation Desktop Client browser.

Published Data
List View of P&ID drawings that have been published.

© 2005. Intergraph Corp.

Using the Show Equipment command will show the published equipment objects.

Published Data
List View of related equipment that has been published.

© 2005. Intergraph Corp.

Using the Show Instruments command will show the published instrument objects.

Published Data
List View of related instruments that have been published.

© 2005. Intergraph Corp.

Using the Show Lines command will show the published pipeline objects.

Published Data
List View of related pipelines that have been published.

© 2005. Intergraph Corp.

6.1 XML Files Overview

© 2005. Intergraph Corp.

From the Data tab, open the data file to view.

 Click the + next to ABV-12815 to view
the related data.

© 2005. Intergraph Corp.

Viewing a Data File – Tree/Viewable UML

 Continue to drill down by clicking the
+ next to Piping Ports to view related
data.

© 2005. Intergraph Corp.

Select the object to be viewed in the right pane.

Viewing a Data File – Tree/Viewable UML

 Click Piping Port 1 to view the details for this object.

© 2005. Intergraph Corp.

© 2005. Intergraph Corp.

6.2.3 Data Tree/Properties View

The Tree/Properties view combines the same tree view used elsewhere in the Schema
Editor with a properties view that emulates display of properties in the right pane in
SmartPlant Foundation. This properties view identifies each interface for the selected
object with text on a shaded background. Following each interface are the properties
exposed by that interface and their values for the selected object.
The properties view is currently the only view in the Schema Editor that explicitly
converts enumerated property values from the UID of the enumerated entry to the name
associated with that entry. Other views display the UID for the enumerated entry as it
would appear in the XML file, such as @EE407.
The Tree/Properties view provides the most useful information when you use it to view
data, instead of the schema, tool schemas, or meta schema. If you select an object in the
tree view, you can see its interfaces in the properties view.
From the tree, find an object to view. Drill down to expand the tree to see other objects.

Data Tree/Properties View

 Click the + next to PIDProcessVessel
to view the related data.

© 2005. Intergraph Corp.

Select the object that you want to see in the Properties view.

Data Tree/Properties View

 Click T-103 to view the details in the right pane.

© 2005. Intergraph Corp.

6.3 Finding Data Objects

In the Schema Editor, you can locate particular objects in data files by defining search
criteria for the object that you want to find, including the name and description of the
object and its UID.

6.3.1 View Data Find Tab

To find an object in the Schema Editor, choose either the Edit > Find menu command or
use the Find tab in the View Data dialog box. This allows you to define search criteria
and to limit the scope of your search to the data files. Using the Find dialog box is
especially useful if you know part of the UID, name, or description of the object that you
want to find.
In the following example, click the Data File View button first, then click the Find tab in
the View Data dialog box.

Finding Data
 On the Find tab of the View Data dialog box, click the
browse button to display a list of classes.

© 2005. Intergraph Corp.

The Select Classes to Display dialog box appears.

Finding Data
 Select one or more classes and click OK.
OK

© 2005. Intergraph Corp.

In this example, the software searches for all PIDPipingComponent, PIDPipingConnector

and PIDProcessVessel objects that have *10* in the Name.

In this example, the software searches for all objects that that have *10* in the Name from
All classes. A Data Tree/Properties view displays the results of the search.

Finding Data
Expanding the tree shows related data objects.

© 2005. Intergraph Corp.

6.4 Comparing Data Files

In the Schema Editor, you can compare schemas, tool schemas, and data files with other
files of the same type. Comparisons are valuable for seeing changes from one version of
the schema to another, for seeing changes in data files as they are generated by the
Framework authoring tools, and for seeing differences between the schemas from
different authoring tools.

Comparing Files
There are three types of comparisons in the Schema
Editor:
 Full Comparison
 Detection of Tombstones
 Comparison Using Views

© 2005. Intergraph Corp.

Full Comparisons
A full comparison compares every object, relationship, and property in one file with the
file you select. When you do a full comparison, you can choose whether the software
displays the full results of the comparison, the comparison instructions only, or both the
comparison results and instructions.
After you perform a full comparison between files, you can view the modification
instructions generated by the software. These modification instructions define the changes
required to go from the objects in the file you selected for comparison to the objects in the
original file. For example, you can see which objects would be deleted, which ones would
be updated, and which ones would be created.

Expanding the tree shows UpdateInstruction objects.

Full Comparison - Instructions

 Click Insert_F-
Insert_F-12830LP to view the details in the right pane.

© 2005. Intergraph Corp.

Expand the tree to view other instructions such as UpdateInstructions.

Full Comparison - Instructions

 Click Update_P-
Update_P-110-
110-4”-1C0031-
1C0031-HS to view the details in the
right pane.

© 2005. Intergraph Corp.

Another way to view the results is by selecting the Comparison Results View button. This
button is available only after you compare two files, as shown previously.

Comparison Results - View

 To view the results, click the View button (next to
Comparison Results)
Results in the Workflows dialog box.

© 2005. Intergraph Corp.

Again, a View Data Instructions dialog box appears.

Comparison Results - View

 Click the view in which you want to display the comparison
results.

 Click OK.
OK

© 2005. Intergraph Corp.

A Data Instructions Tree/Properties window appears.

Detect Tombstones
 Click Compare > Detect Tombstones in the Workflows
dialog box.

© 2005. Intergraph Corp.

Choose the XML file version to be used for comparison.

Detect Tombstones
 In the Open Compare With Data File dialog box, select an
XML data file for comparison and click Open.
Open

© 2005. Intergraph Corp.

Now select the view format for the comparison results.

Detect Tombstones
 Click the view in which you want to display the comparison
results.

 Click OK.
OK

© 2005. Intergraph Corp.

A Data Instructions Tree/Properties window displays. The Schema Editor identifies items
as tombstones when they do not exist in one file you opened in the Schema Editor but do
exist in the other file you selected for comparison.

Detect Tombstones
 Click Delete_F-
Delete_F-12830LP to view the details in the right
pane.

© 2005. Intergraph Corp.

6.5 Activity – Viewing and Finding Data

Complete the Chapter 6 – Activity 1 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.
6-48 Viewing and Finding Data
C H A P T E R 7
Introduction to Schema
Mapping
7-2 Introduction to Schema Mapping
Introduction to Schema Mapping 7-3

7. Introduction to Schema Mapping

Schema Mapping provides a mechanism for the software to convert authoring tool data,
described by the tool map schema, to SmartPlant data, described by the SmartPlant
schema, and SmartPlant data back to tool data. Each tool that integrates with SmartPlant
supplies the mapping between that tool and the SmartPlant schema for both publish and
retrieve operations. The mapping is stored in the authoring tool map schema.
Mapping allows authoring tools to externalize the definition of mapping to isolate
authoring tools from changes in the SmartPlant schema. This mapping defines correlations
to the SmartPlant schema strictly using UIDs, which should not change.
In the Schema Editor, you can modify how authoring tool data maps into and out of the
SmartPlant schema by modifying the authoring tool mapping. Common modifications to
existing tool mapping are the extension of tool enumerated lists that are then mapped to
enumerated lists in the SmartPlant schema and the addition of custom properties.
In previous releases, mapping from the “tool schema” to the SmartPlant schema was done
based on the underlying SmartPlant schema objects (class, interface, property, and edge
definitions). This required the person doing the mapping to be intimately familiar with
that part of the overall SmartPlant schema. Feedback from SmartPlant users indicated that
this was a burdensome requirement, in that it required significant effort for an individual
to attain the appropriate level of knowledge of the SmartPlant schema.
To reduce the effort and knowledge required of the tool integrator defining the mapping, a
simpler, view-based approach is now available. This presents the user with a “business
object” view of the schema that is much easier to understand and utilize.
To simplify the mapping and to enable the definition of “transformations” associated with
the mapping, the GUI was enhanced to use a more graphical (versus tabular) approach to
the mapping. The overall complexity of the previous user interface was replaced by a
more intuitive, graphical approach.
7-4 Introduction to Schema Mapping

Overview of SmartPlant Mapping

The Schema Editor allows you to perform mapping
between Tool Map Schemas and the SmartPlant
Schema:
 The user interface used for mapping was specifically
designed to allow users to create mapping relationships, or
even to extend the SmartPlant Schema as necessary, in an
easy-to-use window.
 It incorporates ViewDefs and existing mapping
relationships to suggest possible SmartPlant Schema
changes.

© 2008. Intergraph Corp.

Overview of SmartPlant Mapping

 From within the Schema Editor tool, you can access the
Metadata Adapters that allow you to synchronize your tool
database structure and the applicable tool map file.
 Special features even allow you to automate the process of
creating and mapping new properties in the SmartPlant
Schema.

© 2005. Intergraph Corp.

Mapping with the Schema Editor

Any changes can be added to the tool meta-data (authoring
tool data base), then the tool map schemas and SmartPlant
schemas, and finally mapped in the tool map schema.

Tool
Meta-Data

Schema Import
SPF Wizard

EF
Schema

Schema
Editor

SPPID SPPID
Metadata Map
Schema
Adapter

SPPID
© 2008. Intergraph Corp.
All Rights Reserved.

The metadata adapter can be used to read the data definitions in the tool meta-schema. If
new definitions are found in the authoring tool database, the metadata adapter can extract
these new definitions and automatically add them to the tool map schema. This is called
synchronizing the tool meta-schema and the tool map schema and occurs when the
Schema Editor connects to SmartPlant and the tool map schema is opened.

After the tool meta-schema and tool map schema have been synchronized, new definitions
can be added to the SmartPlant schema (EFSchema) and then mapped via the Schema
Editor.
7-8 Introduction to Schema Mapping

Every tool uses a metadata adapter as illustrated by the figure below.

Mapping with the Schema Editor

Schema Import SPEL
SPF Wizard

SPEL
Map SP3D
EF Schema
Map
Schema
SPEL Schema
Metadata
SPI Adapter
Map
Schema

SPI SP3D
Schema
Metadata Metadata
SPI Adapter
Editor
Adapter
SP3D

App X
Metadata
Adapter SPPID
SPPID
App X Map
Metadata
Map Schema
Schema Adapter

App X

SPPID
© 2008. Intergraph Corp.
All Rights Reserved.
Introduction to Schema Mapping 7-9

7.1 Mapping Process Options

Mapping data from the authoring tool to SmartPlant and back requires one of the
following work processes. In some cases, extensions to the authoring tool already exist.
To complete this process, the same extensions have to be integrated throughout the
schemas.

Mapping with the Schema Editor

The recommended work process for
Add enum mapping is to add needed information
extension to into the tool first, then add it to the
Authoring Tool
SmartPlant schema and tool map file
1 using the Schema Editor.

Add enum
extension to Tool
Map Schema Add enum
extension to
SmartPlant
Schema Map enum
2 extension in Tool
Schema

© 2005. Intergraph Corp.

Another possibility is to use the schema editor and the metadata adapter to add any new
needed definitions to the schemas and the tool meta-schema from a single user interface,
the Schema Editor Map Environment.

Mapping with the Schema Editor

The other work process is to use the schema
Add enum
extension to editor to add new information to the tool meta
Authoring Tool schema, the schemas and perform the
mapping from a single UI.

7.2.2 Launching the CMF File

Before you can map a property, or in our current example, a select list value, from the tool
schema to the SmartPlant Schema and back, you must use the Schema Editor to add the
change to the SmartPlant schema.
The integration schema file is now stored in SmartPlant Foundation for change
management purposes. Before you can change that file, you need to find it in the Desktop
Client application, and check it out to make changes.
Find the schema, stored as a CMF file, using the Find > Integration > Schema
Documents command.

Synchronizing the Tool Data and Map File

 Launch the Desktop Client and find the CMF file, using the
Find > Integration > Schema Document command.

© 2008. Intergraph Corp.

Once you find the file, use the standard Edit > Check Out command from the shortcut
menu.

Synchronizing the Tool Data and Map File

 Using the Edit > Check out command from the shortcut
menu, check out the CMF file.

© 2008. Intergraph Corp.

Once you have checked out the file and copied the CMF file locally, right-click the
checked out version of the CMF file and use the Launch Schema Editor command to
open the Schema Editor, with the applicable connection information for this site.

Synchronizing the Tool Data and Map File

 Launch the Schema
Editor tool using the
Launch Schema Editor
command from the
shortcut menu of the
checked-out CMF file.

© 2008. Intergraph Corp.

This command opens the CMF file in the schema editor using a new session file. You can
save the session file at any time. Once it is saved, you can close the Schema Editor and
reopen it using that session file until you check the CMF file back into SPF.
When you launch the session file in the Schema Editor, you reopen that tool with the same
connections and interfaces active as when you saved the file. For example, using the
Launch Schema Editor command opens the schema editor, but it also connects to the
appropriate schema files for the site in which you are working. Reopening the session file
reconnects to that schema.
7-20 Introduction to Schema Mapping

Once you have launched the Schema Editor tool, you may close the SmartPlant
Foundation Desktop Client if you wish.
7-22 Introduction to Schema Mapping

When the Scheme Editor application opens, click File > Session Files > Save Session
File to save the session file with the following configuration. In the future, until you check
the CMF file back into SPF, you will be able to launch the Schema Editor and use this
session file to connect to the appropriate schema files without having to launch the file
from the Desktop Client again.
In addition to the information necessary to connect the Schema Editor tool to the site’s
CMF file, the session file also contains information for connecting to the metadata
adapters and tool map files for authoring tools with plants registered with plants in the site
from which you launched the CMF file.

Synchronizing the Tool Data and Map File

 From the File
menu, click
Session Files >
Save Session
File. This will
save the session
file with the
applicable
connection
information.

© 2008. Intergraph Corp.

From the Workflows menu, choose the Overall Workflows option.

Synchronizing the Tool Data and Map File

 From the Workflows menu, choose the Overall Workflow.

© 2008. Intergraph Corp.

Synchronizing the Tool Data and Map File

 On the
Synchronize
screen, click
OK to push the
changes you
made in the
Data Dictionary
tool to the
SPPID Tool
Map Schema.

 Open the Excel spreadsheet that contains the information
for the new fluid codes. Copy the information for the codes.

© 2008. Intergraph Corp.

Verify that the entry information was imported correctly.

Extend the SmartPlant Schema

 Click the Import Entries from Clipboard button on the New
Enumerate List dialog. They system will create the new
entries automatically. Click OK.

© 2008. Intergraph Corp.

Verify that the entries were added to the Corrosive value.

Extend the SmartPlant Schema

 Confirm that the entries were created properly, and click
OK to close the New Enumerated List dialog box.

© 2008. Intergraph Corp.

7.2.5 Mapping the Enumerate List

After you have created the new list and entries in the SmartPlant Schema, you are ready to
map the list for publish from or retrieval to the authoring tool using the Map
Environment.
Now that you have created the list in the SmartPlant schema, you should see the Corrosive
option on both sides of the middle pane. You can now select the properties on each side
and map them, using the Map button.
Be sure you select the Fluid System node in the top right-hand pane.

Map the New Select List Value

 Select Fluid System on the SmartPlant Schema side, and
find the value Corrosive on both sides. Click the Map
button to map the two.

to allow you to access map functions.

Map – creates a mapping relationship between two

objects selected in the window.

BiMap – allows you to create publish and retrieve

mapping at the same time.

Auto-map – provides suggestions of existing objects

that you might want to map to a selected item.
© 2008. Intergraph Corp.
All Rights Reserved.

Confirm that the mapping was created successfully by checking the bottom window.

Map the New Select List Value

 Confirm that the Corrosive fluid system is mapped.

© 2008. Intergraph Corp.

While the previous steps mapped the Corrosive value for the Fluid System list, we still
need to map the new values for the Fluid Code list.
Introduction to Schema Mapping 7-37

© 2008. Intergraph Corp.

7.3 Planning Changes to the SmartPlant Schema

Before you start extending the SmartPlant Schema to hold new information from
authoring tools, you should spend some time planning your changes. First, determine what
types of changes will be needed:
 Will you be publishing new classes of objects?
 Will you be sharing custom properties for existing objects?
 Do you need to add custom values to existing enumerate lists?

The way you will extend the SmartPlant Schema will be determined by what changes you
need to make. For example, we have just seen an example of extending an existing list.
However, if you want to create whole new classes of objects, you need to plan how to
model the new class – what interfaces should it realize, what properties should be
available, what objects should it have relationships to.
If you are extending an existing enumerate list, you need to find the existing list in the
SmartPlant Schema, and if you are adding custom properties to be shared, you need to
analyze the schema to determine what interface should expose the properties.

Schema Analysis
 In the remaining chapters, we will be adding
custom properties to SmartPlant Enterprise tools
and creating mapping to get that information into
SPF.

 Before we can add our new property to the

SmartPlant schema, we must decide what
interface should expose our property. We have
two choices:
– Existing/Delivered Interface
– Custom Interface (recommended)
© 2005. Intergraph Corp.
All Rights Reserved.

In the following chapters, we will see how to extend the SmartPlant Enterprise tools to
publish and retrieve custom properties. Before we can do that, we will need to determine
the best way to model those new properties in the SmartPlant Schema.
Two basic options are available: we can add the custom properties to existing interfaces or
we can create custom interfaces for our properties.
7-44 Introduction to Schema Mapping

In the first option, we would need to find an interface that is either already realized by the
class definitions for the objects we want to use the properties, or that can be added to any
of these class defs.

Schema Analysis
 Existing/Delivered Interface –find an existing interface
that is already realized by all the class definitions that you
want to have access to this property.
Method:
1. Create a list of all the objects that should have this
property and find the correlating class defs. Remember
that an object shared across multiple tools will have
multiple class defs: For example, an instrument from
SPPID is a PIDInstrument, but an instrument from SPI
is an INDXInstrument.
2. Compare the interfaces realized by each of these class
defs until you find an interfaces common to all. Add
the custom property to that shared interface.

© 2005. Intergraph Corp.

© 2008. Intergraph Corp.

Open the Create section of the Editor view.

Creating an Interface for Custom Properties

 From the Editor tab, find the InterfaceDef option in the
Create section.

© 2008. Intergraph Corp.

Create a new interface definition.

Creating an Interface for Custom Properties

 Drag and drop the InterfaceDef option into the work area.
Create a new interface for custom properties.

© 2008. Intergraph Corp.

For now, we only want to create the new interface. Later we will make sure it is realized
by the class defs using the properties and implied by the appropriate interfaces. Provide
the necessary information to create the interface – a name and implied interface definition
(IObject).

Creating an Interface for Custom Properties

 Click OK to save your changes to the ICustomInterface.
ICustomInterface
 Save your changes to the Schema file and the Session file.

© 2005. Intergraph Corp.

Save your changes to the file and save the session file so that you can connect with it
again later.
Introduction to Schema Mapping 7-51

7.5 SmartPlant Foundation Mapping Spreadsheets

SmartPlant Foundation mapping spreadsheets are available on Intergraph’s eCustomer
(http://crmweb.intergraph.com) under:
Download Software Updates > Products > SmartPlant Foundation > Technical Notes
and Documentation
If you don’t have an eCustomer login, you can request one at
https://crmweb.intergraph.com then click on the I'm a new user link, fill out the form,
and your eCustomer login will be provided.
7-52 Introduction to Schema Mapping
Introduction to Schema Mapping 7-53
7-54 Introduction to Schema Mapping
Introduction to Schema Mapping 7-55
7-56 Introduction to Schema Mapping
Introduction to Schema Mapping 7-57
7-58 Introduction to Schema Mapping
Introduction to Schema Mapping 7-59
7-60 Introduction to Schema Mapping
Introduction to Schema Mapping 7-61
7-62 Introduction to Schema Mapping
Introduction to Schema Mapping 7-63
7-64 Introduction to Schema Mapping
Introduction to Schema Mapping 7-65
7-66 Introduction to Schema Mapping
Introduction to Schema Mapping 7-67
7-68 Introduction to Schema Mapping
Introduction to Schema Mapping 7-69

7.6 Activity 1 – Extending and Mapping an Existing

Enumerated List
Complete the Chapter 7 – Activity 1 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.

7.7 Activity 2 – Creating the Custom Interface

Complete the Chapter 7 – Activity 2 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.
7-70 Introduction to Schema Mapping
C H A P T E R 8
Mapping with SmartPlant
P&ID
8-2 Mapping with SmartPlant P&ID
Mapping with SmartPlant P&ID 8-3

8. Mapping with SmartPlant P&ID

In the last chapter, the basic concepts of mapping were addressed. It was explained how
map files are used to help the adapters create and process html files that are published to
or retrieved from SmartPlant Foundation and move data between authoring tools and SPF.
This chapter illustrates how this process works using the SmartPlant P&ID tool as an
example. Two new properties will be added to the authoring tool and mapped. One
property is a simple, textual property type, and the other uses a brand new enumerated list.
The figure below shows the function of the metadata adapter with the schema editor.

Mapping SPPID with the Schema Editor

SPPID
EF Schema Map
Schema Editor Schema

SPPID
Metadata
Adapter

SPPID

© 2005. Intergraph Corp.

In this case, the new custom property will first be made in the SmartPlant P&ID
application using the Data Dictionary Manager tool. There is a specific reason for
approaching the problem in this manner. The property to be added could be used by
several different types of objects in SmartPlant P&ID: instruments, instrument loops,
nozzles, pipe lines, and so forth. Since the new property will be used as a “global” Plant
Item item type property, it can be added to the Plant Item table in the data dictionary,
which makes it available to other classes through inheritance. The PlantItem item type is a
classification that provides common relationships and attribution for all the types of
objects that may exist independently of any other object. This item type is derived from
the ModelItem class. The subclasses of ModelItem include all those types whose
existence is not dependent on another.
Once the new property has been added with the Data Dictionary Manager, the schema
editor is used to read this new property from the application, also called the tool meta
schema. This is accomplished by a part of the software known as the metadata adapter.
8-4 Mapping with SmartPlant P&ID

The task of the metadata adapter is to extract information from the meta schema and
automatically update the contents of the tool map schema so that the meta schema and the
tool map schema are synchronized.

Mapping SPPID with the Schema Editor

SPPID
Meta-Schema

SmartPlant
Schema

Mapping
SPPID Map
Schema

SPF
Database

© 2005. Intergraph Corp.

• Changes are added to the SPPID Meta schema via the Data Dictionary Manager
(new property defined).
• Any changes are automatically added to the SPPID Map Schema when the
schema editor synchronizes the schema files.
• The same changes are added to the SmartPlant Schema using the schema editor
Map Environment.
• Any unmapped changes to the schemas can be mapped using the schema editor in
preparation for publish/retrieve operations.

This allows for the smooth flow of published data from SmartPlant P&ID into the
SmartPlant Foundation database.
Mapping with SmartPlant P&ID 8-5

8.1 Adding Simple Properties to the Tool Meta

Schema
The procedure for adding properties to the authoring tools differs from tool to tool. The
following example describes the procedure for adding a new property to the SmartPlant
P&ID data model using SmartPlant Data Dictionary Manager (delivered with SmartPlant
Engineering Manager). For more information about adding properties to SmartPlant
P&ID, see the SmartPlant Data Dictionary Manager documentation.
To add a property to SmartPlant P&ID, open Data Dictionary Manager by clicking Start >
All Programs > Intergraph SmartPlant Engineering Manager > Data Dictionary
Manager.
The following example describes how to add a new property to the SmartPlant P&ID data
model. This property includes the following:
 A simple property without an enumerated list
When you open Data Dictionary Manager, the Database Tables view is already selected.
To select the database table to which you want to add a property, click the name of the
table in the list.

Add Properties to the Meta-Schema

 To define a new property, click Plant Item in the Database Tables
view to add the new property to the Plant Item table.

© 2008. Intergraph Corp.

After you select the table that you want, you can add a property to that table.

Add Properties to the Meta-Schema

 From the menu, select Edit > Add Property.

© 2008. Intergraph Corp.

The Add Property dialog box appears. Define information for the new property on the
Add Property dialog box.

Add Properties to the Meta-Schema

 In the Add Property
dialog box, define
attributes for the new
property, including the
Name,
Name Display Name,
Name
and Data Type.
Type

© 2005. Intergraph Corp.

Add Properties to the Meta-Schema

 Continue to define
attributes for the new
property, including the
Maximum Length,
Length
Display,
Display Filtering,
Filtering and
Category.
Category

 Click OK to add the new

property to the Plant
Item table.
© 2005. Intergraph Corp.
All Rights Reserved.

8.2 Updating the Tool Map Schema

Synchronizing the Tool Data and Map File

Add a Property
to Tool Map
Schema

Add a Property
to SmartPlant
Schema

© 2008. Intergraph Corp.

In the previous activity, we checked the CMF file out of SmartPlant Foundation and
launched the Schema Editor from that tool. Once it was open, we saved the session file so
that we could reopen it again later.
8-10 Mapping with SmartPlant P&ID

8.3 Extend the SmartPlant Schema

Now that the tool database and tool map file are synchronized, we are ready to create the
new properties in the SmartPlant Schema so that we have properties on the SmartPlant
side to which to map.
In the Map Environment, you can drill down beneath the SmartPlant P&ID node to view
the information in the P&ID map file.

Adding a New SmartPlant Property

 Once synchronization is complete, open the SmartPlant
P&ID Tool Schema in the Map Environment window.

© 2008. Intergraph Corp.

However, we are not ready to set up the mapping. We need to add our new property to our
new custom interface, but we first need to make sure that our custom interface is defined
so that the properties we expose with it are available to our class defs.

Adding a New SmartPlant Property

 Before we start adding custom properties to the SmartPlant
Schema, we should investigate where our custom interface
will be needed.
 We want to publish our System Code property for the
following types of objects from SPPID::
– Instruments
– Instruments Loops
– Nozzles
– Piping Components
– Process Equipment Components
– Piping Connectors
– Pipelines
© 2008. Intergraph Corp.
All Rights Reserved.

Once we have a list of the objects that we want to have our property, we need to perform
some research in the SmartPlant Schema to determine what class defs define those
objects.
Mapping with SmartPlant P&ID 8-17

Find the map class of the type of object and, using the Properties view, find the
SmartPlant class defs to which the map class is mapped.

Adding a New SmartPlant Property

 For each of these types of objects, we must investigate to
which Class the Map Class is mapped.
 Find the
Instrument
Map Class..
 Find the
MapClassto
Class property
to see what
Class it is
mapped to.

© 2008. Intergraph Corp.

Then, from the Schema tab on the left side of the window, find those class defs and
determine the primary interface for each applicable class def.

Adding a New SmartPlant Property

 From the Schema tab, find the PIDInstrument class def.
 Find the
Primary
Interface
Definition
property to
find the
primary
interface for
that class def..
 Repeat this
process for all
map classes
you want to
map.
© 2008. Intergraph Corp.
All Rights Reserved.
8-18 Mapping with SmartPlant P&ID

© 2008. Intergraph Corp.

Repeat the steps for additional map classes, such as Nozzle.

Find the properties on each side, and click the Map button.

Mapping New Properties

 Choose the Map Class Nozzle and select the Edit Form tab.
 Select System Code from both lists and click Map.

© 2008. Intergraph Corp.

Confirm the mapping before repeating the process for other map classes.

Mapping New Properties

 Verify that the property from the two schemas is mapped
at the bottom of the window.

© 2008. Intergraph Corp.

© 2008. Intergraph Corp.

8.6 Activity 1 – Adding and Mapping a Custom

Simple Property with SmartPlant P&ID
Complete the Chapter 8 – Activity 1 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.
Mapping with SmartPlant P&ID 8-31
8-32 Mapping with SmartPlant P&ID

 On the toolbar, click the Add Row button to add another
select entry.

1
© 2008. Intergraph Corp.
All Rights Reserved.

 From the menu, select File > Save.

© 2008. Intergraph Corp.

Clicking File > Exit closes Data Dictionary Manager.

Add New Property to Meta Data

 Select File > Exit from the menu.

On the Synchronize dialog box, push the changes from the Data Dictionary Manager to
the SPPID tool map file.

Add New Property/Enum List to Schemas

 Click OK from
the
Synchronize
dialog to have
the schema
editor read the
tool meta-
schema and
automatically
add the new
property/enum
extensions to
the tool map
schema.

© 2008. Intergraph Corp.

© 2008. Intergraph Corp.

8.10 Map the New Property

Next, choose the map class for which you want to publish the new property, and open the
Edit Form view.

Add/Map New Property to SmartPlant

 Choose the Instrument Map Class, and open the Edit
Form tab.

© 2008. Intergraph Corp.

The new property can be found in the tool map schema, but not the SmartPlant schema.

Add/Map New Property to SmartPlant

 On the Publish tab, the EngSystem property is available in
the tool map schema, but not the SmartPlant schema.

© 2008. Intergraph Corp.

The Auto-create button creates a new property in the SmartPlant schema and maps it to
the property selected in the tool map schema.

Add/Map New Property to SmartPlant

 This time, we will select the Auto-create button from
middle/right side of the window, to let the software create
the property for us.

© 2008. Intergraph Corp.

The system creates a new property with the following default values:
Interface Definition – the primary interface of the class def to which the active map class
is mapped. In our example, the default value for this field would be IInstrumentOcc, but
we will change that value to the interface we created to expose our new properties,
ICustomInterface.
Property Name – the name of the property from the tool map file with a prefix that is the
active map class. In this case, the default value for this field is Instrument_EngSystem, but
since this property will be used for other types of objects besides instruments, we will
change the value to EngineeringSys. The name of the property in the tool map file and the
name of the property in the SmartPlant schema do not have to match for a mapping
relationship to be created.
Property Type – the name of the select list that was used for the original property from
the tool. In this case, since we have an enumerated list type in the SmartPlant schema with
the same name as the select list used for the property in the tool, the system provides that
list as a default property type for our new property in the SmartPlant schema.

Add/Map New Property to SmartPlant

 In the Create and
Map Properties
dialog box, enter
the information
to create a new
SmartPlant
Schema
PropertyDef.
PropertyDef
 Be careful to
choose the
ICustomInterface
interface def.
 Click OK when
you are done.
© 2008. Intergraph Corp.
All Rights Reserved.
Mapping with SmartPlant P&ID 8-49

© 2008. Intergraph Corp.

8.12 Activity 2 – Adding and Mapping a Complex

Property
Complete the Chapter 8 – Activity 2 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.
8-56 Mapping with SmartPlant P&ID
C H A P T E R 9
Loading and Testing the
Schema Changes
9-2 Loading and Testing the Schema Changes
Loading and Testing the Schema Changes 9-3

9. Extending the SmartPlant Database with Schema

Changes
In the previous chapters, we have extended the SmartPlant schema to store information to
be published from SmartPlant P&ID. However, until those changes are pushed to the
SmartPlant Foundation database, the publish and load processes will not be able to
actually save the property to the SmartPlant Foundation database.
The following chapter illustrates how we will export the schema changes out of the CMF
file and import them into the database, using the Schema Import Wizard.

Schema Load Process

The Schema Import Wizard, available from within the
Desktop Client, is used by system administrators to
compare an XML file to the SmartPlant Foundation
database.

Once the comparison is complete, the administrator

can review the differences and choose which
changes to make to the database.

© 2008. Intergraph Corp.

Once the schema files have been validated, you will need to check in the checked out
schema file before doing anything else. The next steps in this section all require that your
changes be checked into the SPF system before they are started.

Schema Load Process

 Once you
have
completed
your changes
to the CMF
file and
verified that
there are no
validation
errors, make
sure the CMF
file is
currently
checked into
SPF.
© 2008. Intergraph Corp.
All Rights Reserved.

 Find the Generate Schema Files task.

© 2008. Intergraph Corp.

Specify that you want to compare the contents of the selected file against the database,
and find the file you just created to use for the comparison.

Schema Load Process

 Select Compare content of selected files against all
database items with a matching container ID, and find the
SCHEMA_EFSchema-Gen.xml file. Then click Next.

The Comparison window shows the differences found between the XML file and the
current SPF database. Select the changes you want to make, and click Next.

Schema Load Process

 Review the list of difference between the XML file and the
database. Select the check box for all changes you want
to make to the database, and click Next.

The Review Changes window shows the changes that have been loaded into the database.

Provide values for the new properties.

Testing the Schema Load

 Update the properties for the selected instrument.

Repeat the process for other objects in the drawing, such as nozzles.

Testing the Schema Load

 Update the properties for another object, a Nozzle.

Once you have modified the values multiple objects, save your changes to the drawing.

Testing the Schema Load

 Use the Save button to save the changes that have been
made.

9.6.2 Publish the P&ID Drawing

Use the SmartPlant > Publish command to initiate the publish process.

Testing the Schema Load

 Select the SmartPlant > Publish menu command.

In some cases, this command will require that you log into SmartPlant Foundation.
Provide a valid username for SPF.

Testing the Schema Load

 Enter a valid SPF user name and password and click OK to
have the tool log in and publish a document.

The standard Publish dialog command appears. Click OK to begin the publish process.

Testing the Schema Load

 Click OK to continue and publish the listed documents.

The following messages will appear during the publish process.

Choose which of the four attached files you want to copy out. You need only copy the
FileToolData XML file. Be sure to note where the file will be placed.

Testing the Schema Load

 On the Save Target As dialog box, choose data xml file and
specify the location where you want to save it.

You can open the data XML file and check to make sure you new data was published.
Open the file in an Internet Explorer window or another XML viewing application.

Testing the Schema Load

 From the My Documents folder find the file you checked out
and open it in an Internet Explorer window.

Search for your new custom properties in the XML file.

Testing the Schema Load

 Use the Find feature to find the custom properties in the
published data xml file.

Since the System Code property is a string value, you should find the value you provided
in SPPID. The EngineeringSys (name in SP schema) property is scoped by an
enumberated list; you will see the UID of the selected enum enum in the XML file.

Testing the Schema Load

 Review your new data in the file.

Testing the Schema Load

 Review your new data in the file.

9.7 Activity – Loading and Testing the Schema

Changes
Complete the Chapter 9 – Activity 1 in the SmartPlant Foundation Modeling and Mapping
Activity workbook.
9-32 Loading and Testing the Schema Changes
C H A P T E R 10
Mapping with SmartPlant
Instrumentation
10-2 Mapping with SmartPlant Instrumentation
Mapping with SmartPlant Instrumentation 10-3

10. Mapping with SmartPlant Instrumentation

This chapter will demonstrate how to further extend the SmartPlant schema for
SmartPlant Foundation along with the authoring tools (SmartPlant P&ID and SmartPlant
Instrumentation) that integrate with it to create in integrated engineering system.

Extending the SmartPlant Schema

This example will add the “preconstruction
preconstruction” status to the
existing Construction Status enumerated list.
The example includes SmartPlant Foundation and the
following authoring tools: SmartPlant P&ID and SmartPlant
Instrumentation

SmartPlant
SmartPlant P&ID
Instrumentation

10.1 Modifying the Authoring Tools and Mapping the

New List Values
There is no specific order to follow when extending the SmartPlant system. It may be
easier and more logical to add the new picklist values to the authoring tool first. Once that
has been accomplished, when extending the schema files, you will know exactly what
values must be added there. It is critical that the value added to the tool schema match
what has been added to the tool meta data.

Extend the Authoring Tools

Extend the picklists in

1
the authoring tools

SmartPlant P&ID

2
SmartPlant
Instrumentation

In this example, two authoring tools are being extended so both will be modified in order
to complete the extensions.
Mapping with SmartPlant Instrumentation 10-5

10.1.1 Extending an Enumerated List in SmartPlant

P&ID
The first step to extending the SmartPlant system is to add the new information in one of
the authoring tools. In the example in this chapter, the SmartPlant P&ID and SmartPlant
Instrumentation authoring tools are demonstrated.
For SmartPlant P&ID, start the Data Dictionary Manager for the plant where you want to
extend the construction status.

Extend the Enum List in SmartPlant P&ID

 To modify a picklist in
SmartPlant P&ID, open
Data Dictionary
Manager by clicking
Start > All Programs >
Intergraph SmartPlant
Engineering Manager >
Data Dictionary
Manager.

The Data Dictionary Manager application window will appear. Choose the Select Entry
list.

Extend the Enum List in SmartPlant P&ID

 To define a new entry for an existing select list, click the
Select Entry button.

Find Construction Status from the Select List.

Extend the Enum List in SmartPlant P&ID

 Choose the Construction Status existing select list in the
Selected list box.

Select the last entry in the list view and type “Preconstruction” as the Value and Short
Value.

Extend the Enum List in SmartPlant P&ID

 Enter a new Value and Short Value for the new
Construction Status entry.

Save the change to the select list.

Extend the Enum List in SmartPlant P&ID

 From the menu, select File > Save.

Close the Data Dictionary Manager.

Extend the Enum List in SmartPlant P&ID

 Select File > Exit from the menu.

10.1.2 Extending the SPPID Tool Map Schema

Before you can define mapping for these new entries in the tool map schema, the change
must be pushed to the tool map file. This is done automatically when the tool map schema
and the tool schema are synchronized, using the metadata adapter. Once the change exists
in the tool map file, the new value can be created in the SmartPlant schema, again using
the Schema Editor to add new entries to the existing enumerated list. After the entry has
been added, the schema must be saved and before publishing, the changes must be loaded
into the database.

Extend the SmartPlant Schema

Add the new enumerated

entry to the SPPID tool
map schema and the
SmartPlant schema and
map it Schema Editor

These steps will all be accomplished in the Schema Editor. If you currently have the CMF
file checked out, launch the Schema Editor and open the existing session file.
If you do not currently have the CMF file checked out, launch the SmartPlant Desktop
Client, and check out the CMF file. Then launch the Schema Editor from the shortcut
menu of the checked out CMF file.
10-10 Mapping with SmartPlant Instrumentation

Once in the Schema Editor and viewing the applicable session file, launch the Overall
Workflows and go to the Application Metadata tab. Click the SmartPlant button and
choose the Edit Engineering Tool Options command.

Extend the Enum List in the Schema

 From the Metadata Adapter tab, click the SmartPlant
button, and choose the Edit Engineering Tool Options
command.

Choose the SmartPlant P&ID map file and specify that you want to open the map file and
connect to the tool application schema. Click OK to begin the synchronization process.

Extend the Enum List in the Schema

 Choose the metadata adapter for SmartPlant P&ID, and
indicate that you want to launch the tool map schema and
connect to the tool meta schema.

The differences between the two schemas are displayed in the Synchronize form. For
each difference the user must select (each one has a system-determined pre-selection)
which synchronization action to perform.

Extend the Enum List in the Schema

 Click OK from
the
Synchronize
dialog to have
the schema
editor read the
tool meta-
schema and
automatically
add the new
enum
extension to
the tool map
schema.

10.1.3 Extending the SmartPlant Schema and

Mapping the New Value
In the Map Environment, drill down to the Map Enumerated Lists and find the
Construction Status list.

Extend the Enum List in the Schema

 In the SmartPlant P&ID tool map file, choose the
ConstructionStatus Map Enumerated List.

In the Edit Form view, go to the Publish tab.

Extend the Enum List in the Schema

 On the Publish tab
of the Edit Form, you
will find the new
value in the SPPID
tool map file, but not
in the SP Schema.

Find an existing enum enum, right-click on it, and use the Create New EnumEnum
command.

Extend the Enum List in the Schema

 In the SmartPlant Schema view def, drill down under
Construction state > New, and right-click on the New
option. Click Create New EnumEnum.

Provide information about the new enum enum that will be contained in the New
EnumListType.

Extend the Enum List in the Schema

 Provide a name and description for the new enum enum,
and confirm that it is contained in the New list. Click OK.

Click OK to create the new value.

Extend the Enum List in the Schema

 Find the
Preconstruction
values in the tool map
file and the
SmartPlant schema,
and use the Map
button to create the
publish mapping.

At the bottom of the window, confirm the mapping.

Extend the Enum List in the Schema

 Confirm the value was mapped properly.

10.1.4 Saving the Map File and Schema File

Changes
Save all the modified files.

Save Mapping Changes

 On the menu, click File
> Save All Modified
Files to save the
additions to the
SmartPlant schema
and the mapping to the
SPPIDDataMap file.

Extend the Enum List in SPI

 Choose a Unit from the Open dialog, and click OK.

From the SmartPlant Instrumentation application window, open the Instrument Index
module.

Extend the Enum List in SPI

 From the toolbar, click the Index button.

The Instrument Index Module window will appear. Click Tables > Instrument Statuses.

Extend the Enum List in SPI

 Next, choose Tables > Instrument Statuses from the menu.

The Instrument Statuses dialog will appear. Click the New button to create a new row.

Extend the Enum List in SPI

 Click New at the bottom of the dialog box to add a new row
to the grid.

Enter the new picklist information in the new row at the bottom of the dialog, and click
OK.

Extend the Enum List in SPI

 Enter “PRC” as a three-letter prefix in the Instrument
Status field.

You can now exit the SmartPlant Instrumentation application.

Extend the Enum List in SPI

The Synchronize dialog box shows the differences between the tool map file and the tool
meta schema. Click OK to update the tool map file.

Extend the SPI Tool Map Schema

 On the Synchronize dialog box, push the changes you
made to the SPI database to the tool’s map file. Click OK.

10.1.7 Mapping New Enum Entries for SPI

The enum entry “PRC” is automatically added to the tool map schema. Because the value
for Preconstruction has already been added to the SmartPlant schema (CMF file) when we
set up the mapping from SmartPlant P&ID, all that remains to be done is the mapping.
In the Map Environment window, drill down under SmartPlant Instrumentation to the
Map Enumerated Lists section, and find Construction Status.
From the Publish tab on the Edit Form view, find the new Preconstruction value in the
tool map file and the SmartPlant Schema, and click the Map button.

Map the Enum List in the Tool Schema

 Choose the Construction Statuses Map Enumerated List, and
from the Publish tab of the Edit Form, find the new value in the
tool map file and the SP Schema.
 Click the Map button to create the mapping.

Confirm that the status was mapped properly in the bottom of the window.

Map the Enum List in the Tool Schema

 Confirm that the values were mapped.

On the Retrieve tab, repeat the same steps.

Map the Enum List in the Tool Schema

 From the Retrieve tab
of the Edit Form,
repeat the process to
map the values.

Verify the mapping relationship was created properly for the retrieve.

Define Schema Mapping

 Again, verify that the mapping relationship was created.

Modifying View Defs

 Open the Edit Form for the PIDInstrument view definition.

 To confirm that you want to save the changes you have
made to the INtoolsMap.xml file, click Yes.

When prompted, save the changes to the CMF file. If you did not extend the view defs,
you will not be prompted to save this file.

Save Mapping Changes

 Verify the CMF file for the property addition and choose
Yes.

Once the modified files have been saved, you can close the Schema Editor.

Save Mapping Changes

 Confirm that all modified
files have been saved.
 Then, click File > Exit to
close out of the schema
editor.

 To manually regenerate the component schemas, right-
click the CMF file and use the Regenerate Schema Files
command.

10.5 Testing the SPI Mapping

The following sections step you through the process of testing the SPI mapping. Since we
want to test whether or not we can properly retrieve a value that has been mapped into
SPI, we need to make sure that the value has been published from another authoring tool.
That is the reason we set up the publish mapping from SPP&ID.
The first step of our test will be to publish the new value out of the SmartPlant P&ID tool
on an instrument. Once the data has been published, we will also test the SmartPlant
Instrumentation retrieve mapping by retrieving the P&ID drawing with the instrument and
running the To Do List tasks to update the construction status of the instrument.
10-46 Mapping with SmartPlant Instrumentation

10.5.1 Publishing a Change from SmartPlant P&ID

In this section, you will see an example of publishing a change to a P&ID instrument
using the new Construction Status picklist entry of Preconstruction. Then, to test the
SmartPlant capabilities, the changed instrument will be retrieved into SmartPlant
Instrumentation and the Construction Status value reviewed.

Publishing from SmartPlant P&ID

 To publish to SPF, open
Drawing Manager by
clicking Start > All
Programs > Intergraph
SmartPlant P&ID >
SmartPlant P&ID.

Use the File > Open command to open a list of P&ID drawings.

Publishing from SmartPlant P&ID

 Click File > Open from the menu bar.

The SmartPlant P&ID Open window will appear. The registered plant to be used for the
publish operation is SPFHSV. Drill down beneath that plant\area\unit, and find the
Aberrant.pid drawing.

Publishing from SmartPlant P&ID

 Select the drawing to be opened, and then click OK.

Locate an instrument that has been placed in this drawing. Update this existing instrument
by using the new value for the construction status.

Publishing from SmartPlant P&ID

 Change the construction status of one of the Instruments in
the properties grid.

Save the change that has been made before publishing this document to SPF. To perform a
publish operation, use the Publish command from SmartPlant P&ID.

Publishing from SmartPlant P&ID

 Select the SmartPlant > Publish menu command.

In certain situations, you may be prompted to log on to SPF. If prompted, provide a valid
SPF username and password.

Publishing from SmartPlant P&ID

 Enter a valid SPF user name and password and click OK to
have the tool log in and publish documents.

The Publish dialog box will appear.

Publishing from SmartPlant P&ID

 Click OK to continue and publish the listed documents.

A dialog box appears after some time to report success or failure of the publish operation.

Publishing from SmartPlant P&ID

 When the results dialog box appears, click Close.

Now that the document has been successfully published, exit from SmartPlant P&ID. In
the next section, this document will be retrieved into SmartPlant Instrumentation.

Publishing from SmartPlant P&ID

 From the menu, select File > Exit.

10.5.2 Retrieving a Change into SmartPlant

Instrumentation
Now that the instrument change has been published into SmartPlant, the document can be
retrieved by SmartPlant Instrumentation.

Retrieving Into SmartPlant Instrumentation

 To retrieve the publish, open SmartPlant Instrumentation.

The login dialog box will appear.

Retrieving Into SmartPlant Instrumentation

 Enter a User name and Password to logon to SmartPlant
Instrumentation.

When the Open window appears, choose a plant/unit from the displayed tree.

Retrieving Into SmartPlant Instrumentation

 Highlight the Plant/Unit to be opened, and click OK.

To perform a retrieve operation, use the Retrieve command from SmartPlant

Instrumentation.

Retrieving Into SmartPlant Instrumentation

 Select the SmartPlant > Retrieve menu command.

The SmartPlant Foundation login dialog will appear in some cases, if the system user does
not have an account in SmartPlant Foundation.

Retrieving Into SmartPlant Instrumentation

 Enter a valid SPF user name and password and click OK to
have the tool log in and retrieve documents.

When the retrieve dialog appears, enable the toggle box next to the previously published
document (from SPPID) to be retrieved by SmartPlant Instrumentation.

Retrieving Into SmartPlant Instrumentation

 Select a document to retrieve and click OK to continue.

A dialog box will appear after some time to report success or failure of the publish
operation.

Retrieving Into SmartPlant Instrumentation

 When the confirmation message appears, click Close.

The instrument changes are not automatically applied by SmartPlant Instrumentation. You
must display the To Do List, which contains a list of all the changes needed to incorporate
the information from the publish operation into the SPI database.

Retrieving Into SmartPlant Instrumentation

 From the menu, select the SmartPlant > To Do List.

To apply changes to the database, select the changes to be made, and click the Run
command.

Retrieving Into SmartPlant Instrumentation

 Highlight the To Do List tasks to be executed and click Run.

A status icon will be displayed in the left most column as tasks are completed.

Retrieving Into SmartPlant Instrumentation

Green check marks will appear next to successfully completed
tasks.

Once the tasks have been executed, use one of the browser windows to view the results.

Retrieving Into SmartPlant Instrumentation

 Select the Index option from the toolbar.

The Instrument Index Module window will appear.

Retrieving Into SmartPlant Instrumentation

 Next, select the Browse command from the bottom of the
Instrument Index Module window.

A Browser View window with instrument information will be displayed.

Retrieving Into SmartPlant Instrumentation

The newly added construction status, PRC, for the instrument
is displayed.

Now that the document has been successfully retrieved and the selected tasks executed,
exit from SmartPlant Instrumentation.

Retrieving Into SmartPlant Instrumentation

 From the menu, select File > Exit.

10.6 Activity 1 – Extending an Existing Enumerated

List
Complete the Chapter 10 – Activity 1 in the SmartPlant Foundation Modeling and
Mapping Activity workbook.
10-62 Mapping with SmartPlant Instrumentation
Mapping with SmartPlant Instrumentation 10-63

10.7 Creating and Mapping a Custom Property in

SmartPlant Instrumentation
In this section, the process of adding a new custom property to SmartPlant
Instrumentation (SPI) and then mapping that property to the SmartPlant schema will be
discussed. The type of property that will be added is a simple or string property, as it is
not possible to add a new custom enumerated list to SPI.
10-64 Mapping with SmartPlant Instrumentation

10.7.1 Adding a Custom Property to SPI

Before defining mapping for the new UDF in the tool map schema, the new SystemCode
property must be added to the tool map schema. Remember, this is done automatically
when we synchronize the tool map file and the tool meta schema using the tool metadata
adapter.
Note:
• Before starting the mapping process, you need to have access to
the CMF file. Since we are not making changes to the CMF
itself, that files does not have to be checked out of the Desktop
Client, but you must have access to the SmartPlant Schema in
order to create the mapping relationships.
In the following illustrations, we have already connected to the CMF file using an existing
session file, and the next step is to connect to the SmartPlant Instrumentation tool map file
and too meta schema.

Map the Property in the Tool Schema

 Launch the session file in the schema editor and open the
list of metadata adapters. Choose INtools, and click OK.

The Synchronize screen lists the differences between the two schemas.

Map the Property in the Tool Schema

 Click OK from
the
Synchronize
dialog to have
the schema
editor read
the tool meta-
schema and
automatically
add the new
property to
the tool map
schema.

In the Map Environment, find the Map Class TEFRetrieve_PIDDrawing_Instrument,

which represents instruments published on a P&ID drawing and retrieved into SPI.
Notice that this map class is already mapped to the IInlineInstrumentOcc and
IInstrumentOcc interfaces, and remember that our ICustomInterface interface is already
implied by the IInstrumentOcc interface. Because of this we can already create the
mapping necessary for us to publish and retrieve the status code.

Map the Property in the Tool Schema

 Find the TEFRetrieve_PIDDrawing_Instrument map class,
and open the Edit Form.

In the Edit Form view, open the Retrieve tab. Find the custom property in both the tool
map file and the SmartPlant Schema, and click the Map button.

Map the Property in the Tool Schema

 Select the UDF property from the left pane and the
SmartPlant property from the right pane, and click the Map
button.

Confirm the retrieve mapping relationship in the bottom of the window.

Map the Property in the Tool Schema

 Verify that the enum entries from the two schemas are
mapped at the bottom of the dialog and click OK.

To create the mapping to publish the SystemCode property back out of SmartPlant
Instrumentation, return to the list of map classes and find
TEFPublish_InstrumentIndex_Instrument.
This time, from the Edit Form view, open the Publish tab. Find the SystemCode property
in the tool map file and the SmartPlant schema, and use the Map button.

Map the Property in the Tool Schema

 To create the mapping relationship for Publishing the System
Code data out of SmartPlant Instrumentation, find the
TEFPublish_InstrumentIndex_Instrument map class, and
repeat the steps as before on the Publish tab.

Confirm the publish mapping relationship in the bottom of the window.

Map the Property in the Tool Schema

 Verify that the enum entries from the two schemas are
mapped at the bottom of the dialog and click OK.

Even though we were able to create the mapping relationship because of the Implies
relationships that already existed, we still have to make some modifications to the
ICustomInterface and update the applicable component schemas if the SPI adapter will be
able to process the integrated data.

Modifying the Custom Interface

 The custom interface needs to be realized by some
additional class defs if we want to publish and retrieve the
information in SPI.
 We want to publish/retrieve our System Code property for
the following types of objects in SPI:
– Instruments
– Instrument Loops

Compare this list of objects to the SmartPlant Schema to determine which class defs they
correspond with, and for each class def determining the primary interface. Actually, the
Implies interface relationships already exist, but you must make sure that the involved
SmartPlant schema class defs realize the ICustomInterface.

Modifying the Custom Interface

 For each of these types of objects, we must investigate to
determine the corresponding SPF class def and the primary
interface of each of these class defs.
 The following table indicates the results of this research:
Map Class SPF Class Def Primary Interfaces
Instruments INDXInstruments IInstrumentOcc
InstrumentLoop INDXLoop IInstrumentLoop

 Before saving the CMF file, make sure the ICustomInterface

is realized by the above class defs and is implied by the
above interfaces.

Once the custom interface is modified, save the changes to all modified files.

Saving Schema Changes

 On the menu, click
File > Save All
Modified Files to
save the schema
changes.

Save the new property and the mapping relationships to the SPI map file.

Save Mapping Changes

 To confirm that you want to save the changes you have
made to the INtoolsMap.xml file, click Yes.

When prompted, save the changes to the CMF file.

Save Mapping Changes

 Verify the CMF file for the property addition and choose
Yes.

Once your changes have been saved, close the Schema Editor.

Save Mapping Changes

 On the menu, click File > Exit
to close out of the schema
editor.

10.8 Test the Complex Property Mapping for SPI

Now, after we have added our custom property to SPI, we can test the mapping to get that
information into and out of that tool. Since we have already published values for the
System Code property for instruments in the P&ID drawing, we do not have to re-publish
that document.
However, we do need to repeat the procedure to retrieve that document into SPI. When we
retrieved the P&ID drawing in the previous example, SmartPlant Instrumentation was not
configured to retrieve or process the System Code property. Since the mapping now exists
for System Code, we need to retrieve the drawing again.
10-86 Mapping with SmartPlant Instrumentation

10.8.1 Retrieve the P&ID Drawing

From the SmartPlant Instrumentation application, use the SmartPlant > Retrieve
command.

Retrieving Into SmartPlant Instrumentation

 From within SmartPlant Instrumentation, click the
SmartPlant > Retrieve menu command.

On the Retrieve dialog box, find the P&ID drawing and activate its check box. You may
have to select the All documents radio button in the Show section of this dialog to see the
P&ID drawing in the list.

Retrieving Into SmartPlant Instrumentation

 Choose the document to retrieve, and click OK to continue.

Dismiss the confirmation box when the retrieve operation is complete.

Retrieving Into SmartPlant Instrumentation

 When the confirmation dialog box appears, click Close.

Open the To Do List using the SmartPlant > To Do List command.

Retrieving Into SmartPlant Instrumentation

 When the retrieve process is completed, click SmartPlant >
To Do List.

Review the list of updates and find the instrument for which you published a SystemCode
value.

Retrieving Into SmartPlant Instrumentation

 Double-click on one of the tasks to be executed to see its
properties.

View the properties for the instrument.

Retrieving Into SmartPlant Instrumentation

 Review the new value to be updated by the To Do List task
and click OK.

Cancel the Properties window, and run the tasks in the To Do List.

Retrieving Into SmartPlant Instrumentation

 Highlight the To Do List tasks to be executed, and click
Run.

View the value for the System Code property.

Retrieving Into SmartPlant Instrumentation

 The newly added property for the instrument, SystemCode,
is displayed.

Provide new values for System Code for one or more instruments.

Retrieving Into SmartPlant Instrumentation

 Make changes to the data to be published back out of SPI.

10.8.2 Publish the Instrument Index

Once you have added new data for instruments in the System Code property, you are
ready to publish those changes back out of SPI.
From the Instrument Index Browser window, click the Print button on the bottom
toolbar.

Publishing from SmartPlant Instrumentation

 To publish the Instrument Index, click the Print button on
the bottom toolbar of the Instrument Index Browser window.

If prompted to view the report before printing, click Yes.

Publishing from SmartPlant Instrumentation

 When prompted, indicate that you do want to review the
report before printing.

From the bottom toolbar of the Report Preview window, click the Revisions button.

Publishing from SmartPlant Instrumentation

 When the
report
opens, click
the
Revisions
button on
the bottom
toolbar.

On the Revisions dialog box, click New to create a new revision of Instrument Index
Report.

Publishing from SmartPlant Instrumentation

 On the Revisions dialog box, click New to create a first
revision of the document.

On the Revise form, choose a revision scheme and a starting major revision. Click OK to
reserve the revision in SmartPlant Foundation.

Publishing from SmartPlant Instrumentation

 On the Revise form, choose a revision scheme and specify
the revision with which to start. Click OK to create the first
revision.

Once the revision has been reserved, use the SmartPlant > Publish command to publish
the report.

Publishing from SmartPlant Instrumentation

 Once the revision has been created, dismiss the Revisions
dialog box, and then click SmartPlant > Publish.

Confirm the information as it appears on the Publish dialog box, and click OK.

Publishing from SmartPlant Instrumentation

 Click OK to continue and publish the listed documents.

Close the confirmation box when the publish process is complete.

Publishing from SmartPlant Instrumentation

 When the confirmation dialog box appears, click Close.

10.8.3 Confirm the Published Data

When the publish process is complete, you can check the published XML data file for the
new values in the new property.
From SmartPlant Foundation Desktop Client, find the document you just published from
SPI. Use the Find > Published Data > Published Documents command.

Publishing from SmartPlant Instrumentation

 From the
Desktop Client,
use the Find >
Published Data
> Published
Documents
command to
find the
published
document.

Find the Instrument Index document published from SPI. Use the File > Save Target As
command from the shortcut menu to save out a decrypted copy of the file for viewing.

Publishing from SmartPlant Instrumentation

 Right-click on
the published
Instrument
Index
document
and click
Files > Save
Target As.

From the Save Target As dialog box, select only the check box of the FileToolData XML
file. Be sure to note where the file will be placed when copied locally.
10-98 Mapping with SmartPlant Instrumentation

Open the checked out data file in Internet Explorer or another XML viewer.

Publishing from SmartPlant Instrumentation

 Open the published XML data file in Internet Explorer.

Use the Find functionality to find your custom data.

Publishing from SmartPlant Instrumentation

 Using the Find functionality to find your custom property in
the data xml file.

Check to make sure all your changes were published.

Publishing from SmartPlant Instrumentation

 Using the Find functionality to find your custom property in
the data xml file.

10.9 Activity 2 – Adding a Custom Property to

SmartPlant Instrumentation
Complete the Chapter 10 – Activity 2 in the SmartPlant Foundation Modeling and
Mapping Activity workbook.
10-102 Mapping with SmartPlant Instrumentation
C H A P T E R 11
Mapping with SmartPlant
Electrical
11-2 Mapping with SmartPlant Electrical
Mapping with SmartPlant Electrical 11-3

11. Mapping with SmartPlant SPEL

In the last chapters, the concept of extending the delivered schema was introduced along
with using the SmartPlant Schema Editor to perform the necessary mapping. In the
examples, new enumerated list items and enumerated lists were created, as well as
properties to use those lists and string properties. The process involved using the a tool
application to add the desired list entries to the tool’s application meta schema. The next
step was to use the Schema Editor and the tool’s meta data adapter to read the new
enumerated additions and automatically synchronize those additions with the tool map
schema. The final steps were to add the new entries to the SmartPlant Schema and map
the two schemas together using the schema editor Map Environment.
In this chapter, we will do the same kind of steps to make addition to the SmartPlant
SPEL application and the SPEL tool map schema. The same properties that we added to
SPPID will be propogated forward for use in SPEL and then will be mapped. The goal is
to created the properties and mapping so that these values can be shared between SPPID
and SPEL using SmartPlant Foundation as an integration tool.
Again, there are two different methods for making these changes. However, in this chapter
we will focus on the “outside-in” approach, where changes are made on the tool side and
then moved forward into SPF.
The figure below shows the function of the metadata adapter with the schema editor.

Mapping SPEL with the Schema Editor

SPEL
EF Schema Map
Schema Editor Schema

SPEL
Metadata
Adapter

SPEL

As in the previous examples, the desired change will first be made in the SmartPlant
SPEL application using the Data Dictionary Manager tool. There is a specific reason for
approaching the problem in this manner. The property to be added could be used by
several different types of objects in SmartPlant SPEL; Electrical Motor, Cable, Wire,
Instrument, etc. Rather than add the same property multiple times, if the new property will
be used as a “global” Plant Item item type property, then it can be added to the Plant Item
table in the data dictionary but be available to other classes through inheritance. The
PlantItem item type is a classification that provides common relationships and attribution
for all the types of objects that may exist independently of any other object. This item type
is derived from the ModelItem class. The subclasses of ModelItem include all those types
whose existence is not dependent on another.
Once the new property has been added with the Data Dictionary Manager, the schema
editor will be used to read this new property from the application database, which is also
called the tool meta schema. This is accomplished by a part of the software known as the
metadata adapter. The task of the metadata adapter is to extract information from the meta
schema and automatically update the contents of the tool map schema so that the meta
schema and the tool map schema are synchronized.
Mapping with SmartPlant Electrical 11-5

11.1 Adding New Simple Properties

The procedure for adding properties to the authoring tools differs from tool to tool. The
following example describes the procedure for adding a new property to the SmartPlant
SPEL data model using SmartPlant Data Dictionary Manager (delivered with SmartPlant
Engineering Manager). For more information about adding properties to SmartPlant
SPEL, see the SmartPlant Data Dictionary Manager documentation.
To add a property to SmartPlant Electrical, open Data Dictionary Manager by clicking
Start > All Programs > Intergraph SmartPlant Engineering Manager > Data
Dictionary Manager.
As we have been working in the SPPID database with the Data Dictionary Manager tool,
you will need to use the File > Open Database command to open the SmartPlant
Electrical database.

Add Properties to the Meta-Schema

 Open the SmartPlant Electrical Database in SmartPlant
Engineering Manager.

Choose the SmartPlant Electical application.

Add Properties to the Meta-Schema

 Select SmartPlant Electrical under Application type, and
click Open.

The following example describes how to add a new simple property to the SmartPlant
SPEL data model.
When you open Data Dictionary Manager, the Database Tables view is already selected.
To select the database table to which you want to add a property, click the name of the
table in the list.
After you select the table that you want, click Edit > Add Property to create a property in
that table.

Add Properties to the Meta-Schema

 To define a new property, click Plant Item in the Database
Tables view to add the new property to the Plant Item table.
 From the menu, click Edit > Add Property.

The Add Property dialog box appears. Define information for the new property you want
to create.
In this example, we will be adding a new property called SystemCode1, because the
SmartPlant Electrical database already contains a property called SystemCode.

Add Properties to the Meta-Schema

 In the Add Property
dialog box, define
attributes for the new
property, including the
Name,
Name Display Name,
Name
and Data Type.
Type

Provide a name, a description, data type, and maximum length. Additionally, you can
specify a category to make it easier to find out property in the authoring tool.

The new property is now in the Plant Item table.

Add Properties to the Meta-Schema

The new SystemCode1 property appears in the Plant Item
table.

Save your changes to the SmartPlant Electrical meta schema.

Add Properties to the Meta-Schema

 From the menu, click File > Save.

Click the File > Exit command to close the Data Dictionary Manager.

Add Properties to the Meta-Schema

 Click File > Exit from the menu.

11.2 Updating the Tool Map Schema

Once the changes are part of the tool’s meta schema, you need to make sure the new
properties are part of the tool map file. To update the tool map file, use the Metadata
adapter, which is access through the Schema Editor.
Typically, you would then need to add the new property to the SmartPlant schema, also
using the Schema Editor. However, in this case, we already created the property to the
SmartPlant Schema when we mapped the property from SPPID. Once we have updated
the tool map schema, we will need to make sure that our custom interface is available for
use on the applicable class defs, and we will be ready to create our mapping.

Adding a New SmartPlant Property

Add a Property
to Tool Map
Schema

Add a Property
to SmartPlant
Schema

To synchronize our tool map file with our tool meta schema, we will use the metadata
adapter and the schema editor.
Even though our System Code property aleady exists in the SmartPlant Schema, we will
need to make changes to ICustomInterface. So we need to check out and launch the
plant’s CMF file from the SmartPlant Foundation Desktop Client.
In the following example, we have already been working with the checked out CMF file
and will open the Schema Editor in the Developer mode and launch the saved session file.
11-12 Mapping with SmartPlant Electrical

From the Overall Workflow, and use the Session Files button to access the Open Session
File command.

Synchronizing the Tool Data and Map File

 On the Schema tab, click the Session Files button and
choose the Open Session file command.

Launch the session file with the applicable connection information to the plant schema.

Synchronizing the Tool Data and Map File

 Find the EFSchema.eds file in your My Documents folder,
and open it.

From the Application Metadata tab, click the SmartPlant button, and choose the Edit
Engineering Tool Options command.

Synchronizing the Tool Data and Map File

 From the Metadata Adapter tab, click the SmartPlant
button, and choose the Edit Engineering Tool Options
command.

Select the SmartPlant Electrical tool map file, and indicate that you want to connect to
both the tool map file and the tool application schema.

Synchronizing the Tool Data and Map File

 Choose the metadata adapter for SmartPlant Electrical, and
indicate that you want to launch the tool map schema and
connect to the tool meta schema.

The Synchronize screen shows the differences in the two schemas and allows you to
choose what changes you want to make to correct these discrepencies.

Synchronizing the Tool Data and Map File

 On the
Synchronize
screen, click
OK to push the
changes you
made in the
Data Dictionary
tool to the
SPEL Tool Map
Schema.

11.3 Modifying the Custom Interface

Now the tool map schema is synchronized with the tool application schema and contains
the new property that we will want to map. But before we can map the property to the
System Code property that already exists in the SmartPlant schema, we need to make
some modifications to our custom interface that exposes the System Code property, to
make it available to our SmartPlant Electrical objects.
The Map Environment window is displayed by default when the synchronization process
is complete.

 Verify the tool map schema name for the mapping changes
and choose Yes.

If you saved your changes to the CMF file when you finished extending the
ICustomInterface, you will not be prompted to save the CMF file again, as the mapping
relationships are stored in the tool map file.
However, if you did not save your changes earlier, the following prompt will appear.

Save Mapping Changes

 Verify the CMF file for the property addition and choose
Yes.

Once the schema file has been saved exit the Schema Editor.

Save Mapping Changes

 On the menu, click File > Exit
to close out of the schema
editor.

11.6 Activity 1 – Adding and Mapping a Simple

Property
Complete the Chapter 11 – Activity 1 in the SmartPlant Foundation Modeling and
Mapping Activity workbook.
11-30 Mapping with SmartPlant Electrical
Mapping with SmartPlant Electrical 11-31

11.7 Adding a New Select List/Enum List

In the last section, we saw how to extend the SmartPlant Electical data structure to add a
new simple property and to how to map the new simple property into SmartPlant
Foundation.
In this section, we will see how to do the same extension and mapping for our new
complex property with its custom list of values.
To add a new property to SPEL that uses a select list, begin by launching the Data
Dictionary Manager.

Add New Select List to Meta Data

 Click the Select List button on the left side of the
application window.

Before we can create our new property, we must first define the new pick list that it will
use as its data type.
11-32 Mapping with SmartPlant Electrical

You can add a new select list by typing the name of the list in the blank row at the bottom
of the Select List table.
Mapping with SmartPlant Electrical 11-33

All that is required to define a new select list is the name of the select list. To define
entries for the new select list, click the Select Entry button. Add the first select entry to
the list by typing it in the first row of the table. Click the Add Row button at the top of the
window to add a new empty row and continue adding your new entries until you have
defined them all.

Add New Select List to Meta Data

 The select list that was highlighted when you clicked the
Select Entry button appears in the Selected list box.
 In this table, define the options that will be available in the
enumerated list.

When you have defined all your entries, click the Database Tables button to return to the
screen where you will add your new property that will use the select list you just created.

new property.

When you click OK, the list of properties for the Plant Item table updates with the new
property.
Mapping with SmartPlant Electrical 11-37

After adding the property, save the changes to the SmartPlant Electrical database.

Add New Property to Meta Data

 From the menu, click File > Save.

Then click File > Exit, to close the Data Dictionary Manager.

Add New Property to Meta Data

 Click File > Exit from the menu.

Map the first value in the picklist by dragging and dropping the value from one column to
the other.

Mapping New Properties

 Find the first
picklist value
(AA) in the
SmartPlant
Electrical map
file list, and drag
and drop it onto
the
corresponding
value in the
SmartPlant
Schema list.

Verify that the mapping was completed successfully.

Mapping New Properties

 Confirm that the
mapping
relationship was
created.

Mapping New Properties

 Confirm the mapping relationship was created.

Repeat these steps for all the map classes where you want to publish the new property.

Mapping New Properties

 Use the same
process to map
the EngSystem
property for the
SignalRun map
class.

11.11 Save the Mapping Changes

Again, the additions to the mapping information will need to be saved to the tool map file.
You will be prompted to save the changes to the tool map schema.

Save Mapping Changes

 On the menu, click File
> Save All Modified
Files to save the
additions to the
SmartPlant schema
and the mapping to the
SPELDataMap file.

When prompted, save the changes to the SmartPlant Electrical Map file.

Save Mapping Changes

 Verify the tool map schema name for the mapping changes
and choose Yes.

Since you made changes to the SmartPlant schema, you are not prompted to save the CMF
file.
You can now exit the Schema Editor.

 From the SmartPlant menu, click To Do List, and run the
updates from the retrieve.
 Verify data for MP-106 has been created.

Create a new signal for the motor from SmartPlant P&ID.

Publish the Motor Properties

 To create a new signal for the motor retrieved from P&ID,
right-click on it in the Electric Index window under Loads,
and then click the New Signal command.

The new signals appear in the tree beneath the associated motor.

Publish the Motor Properties

 The name for the new signal is
generated by the software.

Create a report to publish from SmartPlant Electrical.

Publish the Motor Properties

 To create a report to publish the new properties, click
Actions > Register Report.

Publish the Motor Properties

 In Windows Explorer, open the published XML file, and
verify that the new properties were published with the
values your provided.

11.13 Activity 2 – Adding and Mapping a Complex

Property
Complete the Chapter 11 – Activity 2 in the SmartPlant Foundation Modeling and
Mapping Activity workbook.
11-62 Mapping with SmartPlant Electrical
C H A P T E R 12
Mapping with SmartPlant
3D
12-2 Mapping with SmartPlant 3D
Mapping with SmartPlant 3D 12-3

12. Mapping for SmartPlant 3D Overview

When the schema in SmartPlant is extended, such as when new classes, properties, or
select list entries are added, you or an administrator must react to the change. You
must update the mapping data in SmartPlant 3D. Mapping data is necessary for the
publish and retrieve operations, as well as for correlating design basis objects with
model objects. You also must update the Catalog Schema database in SmartPlant 3D,
if the new information does not already exist in the database.
12-4 Mapping with SmartPlant 3D

12.1 Adapters
Each authoring tool has an adapter that processes information during the publish and
retrieve operations. One of the adapter's functions is to map information between
SmartPlant and the particular authoring tool. SmartPlant 3D currently has two
adapters: one for retrieving and another for publishing. The retrieve adapter for
SmartPlant 3D requires that each document type have a registry entry present. These
registry entries define the map file used and define callback objects that perform
additional processing. It is possible that each document type could have its own map
file. The retrieve adapter uses a map file, which is defined by tool schema files. The
publish adapter uses a tool schema file (generated from the SmartPlant 3D Catalog
Schema and supplemented with mapping information) and a schema called the
P3DComponent Schema, which is derived from the SmartPlant Schema.

SP3D Mapping Adapters

 SmartPlant 3D currently has two adapters. One for
retrieving, and another for publishing.
 The adapter used for retrieving requires that each
document type that will be retrieved have a registry entry
that defines what map file will be used to retrieve that type
of document.
 The publishing adapter uses a standard tool map schema
file like the other SmartPlant Enterprise authoring tools.
 The Publish adapter interacts with the P3DComponent
component schema created from the SmartPlant Schema,
while the Retrieve adapter used information from multiple
component schemas.

12.2 Map Files

For retrieve, the delivered map file is DesignBasis_map.xml. For publish, the map
file is SP3DPublishMap.xml. This file is also used to correlate data during the
Compare with Design Basis process.

SP3D Mapping Map Files

 The Retrieve map file is DesignBasis_map.xml, and is
generated and modified when the design basis is
regenerated.
 For publish, the map file is SP3DPublishMap.xml. This
map file is also used during correlation.

12.2.1 General Mapping Information

Mapping for retrieve is configured from a set of component schemas contained in the
EFSchema.xml file on the SPF server. The information in these component schemas
is processed into a SmartPlant 3D schema package and a map file. The schema
package is loaded into the SmartPlant 3D Catalog Schema (metadata database), and
the map file is made available to each SmartPlant 3D client. Modification to the map
file is automatic and does not require manual editing. For retrieve, the Generate
Design Basis tool provided by Core does the mapping. The Generate Design Basis
tool updates the map file that is, in turn, used to generate the metadata package for the
design basis objects. During a retrieve operation, the map file is used to translate the
data received from SmartPlant into the form defined in the Catalog. For example,
attributes in a SmartPlant document are typically passed as strings. The
corresponding attribute in SmartPlant 3D could be a string, a long, a double, a
codelist, or other type. The map file could translate a string, such as TRUE, to the
Boolean value True in SmartPlant 3D.
During a retrieve operation, each object is identified by its UID. A one-to-one
relationship exists between an object and its UID. Once the object is identified and
brought into memory, the mapped properties are stored. You might also wonder if
you can map attributes on the document object itself. This mapping is possible as
long as the attributes are defined in both the SmartPlant Schema and the SmartPlant
3D Catalog Schema. Typically, a document object implements the IDocument
interface in addition to other special purpose interfaces.
Mapping with SmartPlant 3D 12-7

SP3D Mapping Information

 Component Schemas from the other authoring tools are
loaded into the catalog database using the Generate
Design Basis feature.
 The base tool schema is defined by the SmartPlant 3D
Catalog Schema.
 During a retrieve operation, each object is identified by its
UID, because of the one-to-one relationship between an
object and its UID.
 If SmartPlant 3D will be retrieving data from SPPID, set the
Use Piping Specifications entry in SPPID’s Option
Manager to SmartPlant 3D rather than PDS.

12.2.2 Publish Mapping

Mapping for publish is done by adding information to the tool schema. The base tool
schema is defined by the SmartPlant 3D Catalog Schema. Then, this base tool schema
is modified using utilities provided by the Core, including a merge utility and an
extract utility. The Schema Editor from SmartPlant is also used in the modification.
The net result of the modifications is that the tool schema includes applicable
mapping information. During a publish operation, the tool schema (with added
mapping information) and the SP3DComponent (derived from the SmartPlant
Schema) are used to convert SmartPlant 3D objects to SmartPlant objects.
When you publish documents, the software:
• Publishes a visual representation of the document that you can
view without SmartPlant 3D. For drawings, this is an Intergraph
proprietary file, called a RAD file (.sha). For reports, the viewable
file is a Microsoft Excel workbook. You can review and mark-up
the visual representation of the document using SmartPlant
Markup or SmartSketch.
• Places the published XML file and any viewable files in the
appropriate SmartPlant Foundation vault. This XML file can be
retrieved when users are in other authoring tools.
SmartPlant 3D receives notification when the publish operation is complete. The
software stores the XML file in the appropriate location and loads the data into the
database. The XML file can then be retrieved as published data by other tools, such
as SmartPlant Electrical.
Mapping with SmartPlant 3D 12-9

SP3D Mapping - Publish

 The Publish mapping for SP3D is managed like the other
authoring tools.
 Once changes have been made to the tool schema, the
metadata adapter can synchronize the tool schema and
the map file used for publish.
 Once these files are synchronized, the SmartPlant 3D
properties can then be mapped with SmartPlant Schema
using the Schema Editor.
 When you publish from 3D,
– The software publishes a visual representation of the
model that can be viewed using either SmartPlant
Markup, SmartSketch, or SmartPlant Review.
– Reports are published in Microsoft Excel workbook
format.
© 2008. Intergraph Corp.
All Rights Reserved.

When you work in an integrated environment with SmartPlant Enterprise, you must
publish documents containing the drawing data and relationships before other
authoring tools can share this information. You can publish your documents within
the Drawings and Reports task.
12-10 Mapping with SmartPlant 3D

The Publish command is available for the following document types:

• 3D Model Data (SmartPlant Review file type)
• Orthographic Drawings (viewable file with links to data)
• Piping Isometric Drawings (viewable file with links to data)
• Reports (viewable file with links to data)
• Composed Drawings
• Composite Model Documents
The viewable files created when you publish drawings and reports provide
relationship links to the 3D Model Data. You must also publish the 3D Model Data to
provide the navigation between the viewable files and the 3D Model Data.

SP3D Mapping - Publish

 Some properties are set in the publish code and cannot be
changed in this release.
 Publish is available for the following document types in
SP3D:
– 3D Model Data (SmartPlant Review file type)
– Orthographic Drawings (viewable file with links to data)
– Piping Isometric Drawings (viewable file with links to
data)
– Reports (viewable file with links to data)
– Composed Drawings
– Composite Model Document

12.2.3 Retrieve Mapping

During a retrieve operation, the adapter assumes that the data it receives is
synchronized with the metadata defined in the Catalog Schema. The map file cannot
have a one-sided definition. That is, a class or property must exist both in the
SmartPlant Schema and in the SmartPlant 3D Catalog Schema. The map file is
responsible for making this connection between the two definitions. An important
limitation of the retrieve process is that shared objects (objects that contain
information from two or more tools) are completely deleted when a single tool
deletes an object.

SP3D Mapping - Retrieve

 Mapping for retrieve carries the following limitation:
– Shared objects (objects that contain information from
two or more tools) are completely deleted when a single
tool deletes an object.
 The map file used during the retrieve process is managed
by the SP3D software when you run the Generate Design
Basis feature.
 The software accesses the component schemas for all the
authoring tools.
 During the Compare with Design Basis process, the
SP3DPublishmap.xml map file is used to correlate the
retrieved data.

SP3D Mapping – SP Schema Limitations

 For enumerate lists that will be retrieved into SmartPlant
3D, values (codelist entries) must be greater that 10000
and cannot have duplicated indices within a single list.
 Duplicated values in another level within a hierarchical
codelist is permissible.
 In rare cases, if an entry is removed from the SmartPlant
Schema, you may need to edit the retrieve map file to
remove the deleted entry.

12.3 Extending the Application Schema

The first step of extending the SP3D schema is to create or modify the Excel
spreadsheets that will include the new properties and code lists.

Extending the SP3D Schema

 In order to the extend the SP3D schema to add custom
properties and custom enumerated lists, you will load the
changes through a bulkloader utility using Excel
spreadsheets.
 Intergraph delivers a number of samples files that you may
use with the SmartPlant 3D application.
 For example to add the new fluid code values, create a
copy of the AllCodeLists.xls spreadsheet delivered with
the SP3D software.
 Open the spreadsheet, locate the Fluid Code tab, locate
the Gas, Fluid System, and then insert a row under this
Fluid System.

Make a copy of the original AllCodesList.xls, which is in the directory D:\Program

Files\SmartPlant\SP3D\CatalogData\BulkLoad\DataFiles on this server. Edit the
copy of AllCodesList.xls to add the new Fluid Code object to its worksheet.
12-14 Mapping with SmartPlant 3D

Open the spreadsheet, locate the Fluid Code tab, and then locate the Gas Fluid
System. Insert a row under this Fluid System, add the information that was added to
the Schema files, and then add an “A” to add this value during bulkload. Save the
file.
This adds the updated entries for Corrosive to the load file for loading.

Extending the SP3D Schema

 Add the fluid codes to the Schema files, and then add an A
in the “A” column. This value tells the loader to add the
value during the bulkload process. When you are finished,
save the file.

Next, create a Custom Interface XLS file to load the new custom properties into
SP3D.
The file D:\SPF_Training\SP3D\EFCustomProps.xls file will contain the
SystemCode and EngineeringSystem properties. Open this file to verify the
properties.

Extending the SP3D Schema

 The image below illustrates an Excel file that will create the
custom properties System Code and EngSystem in the
SmartPlant 3D schema.
 You can review this file on your class machine here:
D:\SPF_Training\SP3D\EFCustomProps.xls.
 Here, we see the names of the new properties and the name
of the SP3D interface on which we want to place them
(IUCustom).

Specify the code list used.

Extending the SP3D Schema

 Scrolling to the right, we see the name of the codelist that
will used by the EngSystem property (EngineeringSystem).

Specify the class defs that use will use the new custom interface.

Extending the SP3D Schema

 You will also need to specify, in that file, what classes will
use the interface on which you created the new custom
properties. Here, the IUCustom is added to pipeline
systems and piperuns.

Also in the same directory is the file EFCustomCodeList.xls

Confirm the connection information to the applicable SmartPlant 3D databases, and

click OK.

Extending the SP3D Schema

 Confirm the database information, and then click Apply.

When the process is complete, the following confirmation dialog box will appear.
Click OK to continue.

Extending the SP3D Schema

 Confirm message will appear when the process is
complete.

Finally, from the Project Management utility, right-click on the plant, and click
Regenerate Reports Database.

Extending the SP3D Schema

 Finally, regenerate
the reports
database for the
plant.
 From the Project
Management Utility,
right-click on the
plant, and click
Regenerate Reports
Database.

The applicable database information will appear by default in the form illustrated
below. Click OK.

Extending the SP3D Schema

 Confirm the database information, and then click OK.

The following dialog will appear at the end of the report load.

Extending the SP3D Schema

 Once the Reports Database and Schema have been
successfully generated, close the dialog box below.

12.5 Mapping Configuration for Publish in SP3D

Launch the Schema Editor in the Developer mode.
In our environment, the CMF file is already checked out and a session file exists with
the appropriate connection information.
From the Overall Workflows window, click the Sessions File button.

Synchronizing the Tool Data and Map File

 On the Schema tab, click the Session Files button and
choose the Open Session file command.

Find the existing session file.

Synchronizing the Tool Data and Map File

 Find the EFSchema.eds file in your My Documents folder,
and open it.

From the Application Metadata tab, use the SmartPlant button to access the Edit
Engineering Tool Options.

Synchronizing the Tool Data and Map File

 From the Application Metadata tab, click the SmartPlant
button, and choose the Edit Engineering Tool Options
command.

Launch the 3D metadata adapter and connect to the tool schema.

Synchronizing the Tool Data and Map File

 Choose the metadata adapter for SmartPlant 3D, and
indicate that you want to launch the tool map schema and
connect to the tool meta schema.

Use the Synchronize dialog to push the changes to the tool map file.

Synchronizing the Tool Data and Map File

 On the
Synchronize
screen, click
OK to push the
changes you
made in the
Data Dictionary
tool to the
SPPID Tool
Map Schema.

Drill down under SmartPlant 3D in the Map Environment window and find the
Map Classes.

Define 3D Publish Mapping

 Once synchronization
is complete, open the
SmartPlant 3D Tool
Schema in the Map
Environment window.

Under Map Classes, find the IUCustom interface on which you placed the custom
properties during the bulkload process. On the Edit Form window, click the Browse
button beside the Publish to SmartPlant class/interface field.

Define 3D Publish Mapping

 Under Map Classes, find the IUCustom interface, and
open the Edit Form view. Click the Browse button
beside the Publish to SmartPlant class/interface field.

Map the IUCustom interface to the ICustomInterface in the SmartPlant schema.

Define 3D Publish Mapping

 From the list of class and interface definitions, find
ICustomInterface, where the SystemCode and EngSystem
properties were exposes.

Click the Advanced Publish Map button.

Define 3D Publish Mapping

 Next, click the Advanced Publish Map button.

When you expand the ICustomInterface on the right side of the window, the new
properties will appear. Drag the property from the right and drop it onto the
corresponding property on the left side of the window

 To check that the
properties were loaded
into the SP3D
database correctly and
to publish from that
tool, open SP3D by
double-clicking the
SP3D.ses file icon on
your desktop.
 From the list box in
the top, left corner,
change the selection
from Piping Features
to Piping Runs.

Next, move your cursor over the pipe run in the window, and right-click on it. From
the shortcut menu that appears, choose the Properties command.

Publishing the SP3D Model

 Find a pipe run
in the model,
right-click on it,
and click
Properties on the
shortcut menu.

The System Code and Engineering System fields should appear in the Standard
properties. Provide values for these two new fields.

Publishing the SP3D Model

 In the Properties window, provide values for the two
custom properties.

Then, use the Tasks > Drawings and Reports command to change to the next task.

Publishing the SP3D Model

 From the menu bar, select Tasks > Drawings and Reports.

Note:
• The following steps show how to create a 3D model document in
SmartPlant 3D to publish it into SPF. In this class, the document has
already been created for us. We will republish the existing document.
However, this information is included to show how the document was
created and initially published.
Mapping with SmartPlant 3D 12-41

In the Management Console frame, right-click on the plant and click New.

Publishing the SP3D Model

 To publish the model the first time, you will need to create
a model document in SP3D.
 In the Management Console, right-click on the plant, and
click New. On the short-cut menu.

From the list of new components, select Folder and click OK.

Publishing the SP3D Model

 On the Add
Component dialog,
select the Folder
option on the
General tab, and
click OK.

The new folder appears under the plant. Rename it.

Publishing the SP3D Model

 Right-click on the
new folder, and
click Rename to
change its name to
something
reflective of its
purpose. In our
example, we will
use the name
3DModel.

Right-click on the new folder, and click New again.

Publishing the SP3D Model

 Select the 3DModel
folder, right click, and
click New from the
short-cut menu.

This time, from the New Component form, select the 3D Model Data option.

Publishing the SP3D Model

 On the Add
Component dialog,
highlight 3D Model
Data. This is the
object type you want
to publish. Click OK.

Right-click on the new 3D Model Data node, and click Setup.

12.7 Activity – Mapping SP3D Properties for

Publish
Complete the Chapter 12 – Activity 1 in the SmartPlant Foundation Modeling and
Mapping Activity workbook.
12-54 Mapping with SmartPlant 3D
DSPF-TP-100014A
SmartPlant Foundation Modeling and Mapping
Course Guide

12 SPF Modeling
50% (2)
12 SPF Modeling
5 pages
Manual - ReportAdapter For SmartPlant 3D (En)
No ratings yet
Manual - ReportAdapter For SmartPlant 3D (En)
21 pages
SPAdapter SPPID
No ratings yet
SPAdapter SPPID
116 pages
Smartplant P&Id: Installation and Upgrade Guide
No ratings yet
Smartplant P&Id: Installation and Upgrade Guide
130 pages
Howto Configurethe Authoringand DWHModels
No ratings yet
Howto Configurethe Authoringand DWHModels
156 pages
SmartPlant Foundation 2008 (4.2) Introduction and Administration I Course Guide Volume 2 PDF
No ratings yet
SmartPlant Foundation 2008 (4.2) Introduction and Administration I Course Guide Volume 2 PDF
339 pages
Smart Plant 3D Programming I Labs v7 SP4
100% (6)
Smart Plant 3D Programming I Labs v7 SP4
205 pages
TSMP4001 - SmartPlant 3D Programming I Labs v91
100% (1)
TSMP4001 - SmartPlant 3D Programming I Labs v91
210 pages
3 DDOTNETGuide
No ratings yet
3 DDOTNETGuide
162 pages
Tef SP3D
100% (4)
Tef SP3D
219 pages
Intergraph Smart 3D Interference Checking - Inglés
No ratings yet
Intergraph Smart 3D Interference Checking - Inglés
13 pages
S3D Common Application Tutorial MASTER BOOK
No ratings yet
S3D Common Application Tutorial MASTER BOOK
226 pages
Manual - 3D SymbolDesigner (En)
No ratings yet
Manual - 3D SymbolDesigner (En)
64 pages
DBIntegrity PDF
No ratings yet
DBIntegrity PDF
621 pages
Read Me First - Smart 3D .Net Symbols
No ratings yet
Read Me First - Smart 3D .Net Symbols
14 pages
Hexagon S3D Project Management
No ratings yet
Hexagon S3D Project Management
626 pages
Label Rules - 2011 R1 PDF
No ratings yet
Label Rules - 2011 R1 PDF
24 pages
Database Management Reference Manual
No ratings yet
Database Management Reference Manual
251 pages
SP3D Automation Toolkit Guide
No ratings yet
SP3D Automation Toolkit Guide
58 pages
Configuring Intergraph Smart 3D Application Servers and Databases Creations
No ratings yet
Configuring Intergraph Smart 3D Application Servers and Databases Creations
20 pages
Enable Network Access on Win Server 2003
No ratings yet
Enable Network Access on Win Server 2003
39 pages
Tef SP3D
33% (3)
Tef SP3D
196 pages
Sp3d Install
50% (2)
Sp3d Install
232 pages
TSMP4005 - Structure Symbols PDF
No ratings yet
TSMP4005 - Structure Symbols PDF
56 pages
CommonGuide PDF
No ratings yet
CommonGuide PDF
672 pages
SPRD How To Add Components For Smart3D
No ratings yet
SPRD How To Add Components For Smart3D
91 pages
TSMP3002 - Smart 3D Piping Reference Data Labs
100% (1)
TSMP3002 - Smart 3D Piping Reference Data Labs
143 pages
Ref Data Guide
No ratings yet
Ref Data Guide
459 pages
Systems and Specifications: User's Guide
No ratings yet
Systems and Specifications: User's Guide
70 pages
Orthographic Drawings Guide Smart Plant 3d
100% (1)
Orthographic Drawings Guide Smart Plant 3d
376 pages
SP3D Shortcut Keys
0% (1)
SP3D Shortcut Keys
13 pages
SP3D Drawings Creation Practice Labs 2009 1
100% (1)
SP3D Drawings Creation Practice Labs 2009 1
35 pages
03 - SP3DNetAPI - LAB - Writing Commands
100% (1)
03 - SP3DNetAPI - LAB - Writing Commands
10 pages
SP3d Guidlines For Reference Data Guide
No ratings yet
SP3d Guidlines For Reference Data Guide
38 pages
Planning Reference Data Guide
No ratings yet
Planning Reference Data Guide
51 pages
SP 3 Dprogguide 082014-1
No ratings yet
SP 3 Dprogguide 082014-1
70 pages
SP3D Structure Users Guide PDF
No ratings yet
SP3D Structure Users Guide PDF
344 pages
Reports Guide SM3D
No ratings yet
Reports Guide SM3D
965 pages
Smart Sketch Guide
100% (1)
Smart Sketch Guide
690 pages
Piping 3D Symbols Guide
100% (1)
Piping 3D Symbols Guide
1,814 pages
SPP Id Automation 1 V 2007
No ratings yet
SPP Id Automation 1 V 2007
14 pages
sp3d Toolkit
100% (1)
sp3d Toolkit
45 pages
Electrical Reference Data Guide SP3D
No ratings yet
Electrical Reference Data Guide SP3D
68 pages
Smartplant Review: Citrix Installation Guide
No ratings yet
Smartplant Review: Citrix Installation Guide
43 pages
Manual - 3D SymbolDesigner (En)
No ratings yet
Manual - 3D SymbolDesigner (En)
64 pages
Electrical: Reference Data Guide
No ratings yet
Electrical: Reference Data Guide
67 pages
Sp3d Admin Course Content
No ratings yet
Sp3d Admin Course Content
1 page
Smart 3D Setup and Administration Practice Labs 2016 PDF
0% (1)
Smart 3D Setup and Administration Practice Labs 2016 PDF
280 pages
SP3DProgGuideuser PDF
No ratings yet
SP3DProgGuideuser PDF
191 pages
SmartPlant 3D Piping Reference Data
No ratings yet
SmartPlant 3D Piping Reference Data
30 pages
SP3D Automation
No ratings yet
SP3D Automation
41 pages
SP 3 D Upgrade Guide
No ratings yet
SP 3 D Upgrade Guide
51 pages
Ref Data Guide Help 409
No ratings yet
Ref Data Guide Help 409
352 pages
SPSchema Modeling
No ratings yet
SPSchema Modeling
70 pages
SPF Web Portal
No ratings yet
SPF Web Portal
128 pages
SmartPlant Instrumentation
100% (1)
SmartPlant Instrumentation
35 pages
Smartplant Foundation: How To Configure The Consolidated Data Warehouse
100% (1)
Smartplant Foundation: How To Configure The Consolidated Data Warehouse
41 pages
TSPL1002 V2009 SP3 Course Guide October 2011
No ratings yet
TSPL1002 V2009 SP3 Course Guide October 2011
281 pages
SPRD How To Add Components For SP3D
100% (2)
SPRD How To Add Components For SP3D
45 pages
SP3D Drawings Training Exercises
No ratings yet
SP3D Drawings Training Exercises
135 pages
AWP+Conference+2018+ +O3+Solution
No ratings yet
AWP+Conference+2018+ +O3+Solution
29 pages
MicroStation4AutoCADUsers PDF
No ratings yet
MicroStation4AutoCADUsers PDF
330 pages
PDMS Procedure for Engineers
No ratings yet
PDMS Procedure for Engineers
32 pages
SPF - Gentle Intro To SP Schema
No ratings yet
SPF - Gentle Intro To SP Schema
207 pages
User Tips and Tricks - 1-1
No ratings yet
User Tips and Tricks - 1-1
4 pages
Interactive - Scripting Introduction
No ratings yet
Interactive - Scripting Introduction
3 pages
CADWorx Piping Rules
100% (1)
CADWorx Piping Rules
6 pages
Aspnet Aspnet Latest PDF
No ratings yet
Aspnet Aspnet Latest PDF
785 pages
Plant Design Solutions Master Contents and Updates: Pds Master Catalog For Cadworx 2015
No ratings yet
Plant Design Solutions Master Contents and Updates: Pds Master Catalog For Cadworx 2015
2 pages
SP3D-Isometric Practice Labs
93% (15)
SP3D-Isometric Practice Labs
141 pages
Aceco Ball Valv
No ratings yet
Aceco Ball Valv
1 page
Enhanced Isometrics
100% (1)
Enhanced Isometrics
28 pages
AVEVA PDM Studio 1.1 Product Release Letter
No ratings yet
AVEVA PDM Studio 1.1 Product Release Letter
3 pages
Ogunbiyi Oyedolapo Final E-Thesis (Master Copy)
No ratings yet
Ogunbiyi Oyedolapo Final E-Thesis (Master Copy)
412 pages
Week 1a Introduction To OOAD
No ratings yet
Week 1a Introduction To OOAD
32 pages
Cultural Sociology. Doctoral Dissertation, University of Copenhagen
No ratings yet
Cultural Sociology. Doctoral Dissertation, University of Copenhagen
36 pages
Engineer Australia - Professional Engineer Stage 1 Competencies
No ratings yet
Engineer Australia - Professional Engineer Stage 1 Competencies
10 pages
COMPSCI 751 - 2023 Semester One - Advanced Topics in Database
No ratings yet
COMPSCI 751 - 2023 Semester One - Advanced Topics in Database
6 pages
Chapter 5
No ratings yet
Chapter 5
17 pages
ERP Database Design Flexibility
No ratings yet
ERP Database Design Flexibility
89 pages
Theoretical Perspectives On Factors Affecting The Academic Performance of Students
No ratings yet
Theoretical Perspectives On Factors Affecting The Academic Performance of Students
15 pages
Cognitive OODA for C2 Enhancement
No ratings yet
Cognitive OODA for C2 Enhancement
22 pages
III Year V Sem Question Bank
No ratings yet
III Year V Sem Question Bank
379 pages
Module 1 Notes Dbms
No ratings yet
Module 1 Notes Dbms
5 pages
Checkland (1985) Systems Thinking
50% (2)
Checkland (1985) Systems Thinking
13 pages
BI Question Bank - All Units PDF
No ratings yet
BI Question Bank - All Units PDF
6 pages
ST 1. Introduction
No ratings yet
ST 1. Introduction
16 pages
Minor Project Report Format
No ratings yet
Minor Project Report Format
13 pages
Presentation
No ratings yet
Presentation
16 pages
SE Theory Solved StrangeR
No ratings yet
SE Theory Solved StrangeR
21 pages
Mongoose Schema Guide
No ratings yet
Mongoose Schema Guide
10 pages
Notice - BPUT Tech Carnival 2024
No ratings yet
Notice - BPUT Tech Carnival 2024
27 pages
ENT 416-3-Engineering Design Process
No ratings yet
ENT 416-3-Engineering Design Process
31 pages
DBML 3
No ratings yet
DBML 3
144 pages
Revision of Kerr'S Model of The Curriculum For A More Effective and Dynamic Science Education John K. Eminah
No ratings yet
Revision of Kerr'S Model of The Curriculum For A More Effective and Dynamic Science Education John K. Eminah
14 pages
Unit2 (Chapter 3)
No ratings yet
Unit2 (Chapter 3)
31 pages
Mine To Mills
No ratings yet
Mine To Mills
7 pages
Unit 1 Se
No ratings yet
Unit 1 Se
36 pages
Dbms Lab RECORD
No ratings yet
Dbms Lab RECORD
56 pages
Appendix A: The ATM System
No ratings yet
Appendix A: The ATM System
30 pages
Efficient To Use.: ©silberschatz, Korth and Sudarshan 1.1 Database System Concepts
No ratings yet
Efficient To Use.: ©silberschatz, Korth and Sudarshan 1.1 Database System Concepts
20 pages
Dr. Ambedkar Institute of Technology: Department OF Computer Science & Engineering 5 & 6 Semester Syllabus 2011-12
No ratings yet
Dr. Ambedkar Institute of Technology: Department OF Computer Science & Engineering 5 & 6 Semester Syllabus 2011-12
24 pages
Essays On Software Architecture
No ratings yet
Essays On Software Architecture
33 pages