Professional Documents
Culture Documents
SPEIntegration Ex
SPEIntegration Ex
Copyright
Copyright 2004-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 from Intergraph
Corporation.
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the
licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license
for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this
software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee
permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and
delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or
redistribution.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.
Contents
Preface .......................................................................................................................................................... 7
SmartPlant Foundation Product Documentation .................................................................................... 7
Documentation Comments ..................................................................................................................... 9
Overview ..................................................................................................................................................... 11
Software Compatibility .......................................................................................................................... 11
Plant Breakdown Structure ...................................................................................................................... 13
Plant Breakdown Structure for Integration Setup ................................................................................. 13
Integration Hierarchy Limitations .................................................................................................... 13
Plant Naming Guidelines ................................................................................................................ 14
Work Process for Creating a Custom PBS Hierarchy .................................................................... 14
Registering Authoring Tools with SmartPlant Foundation ................................................................... 33
Registering SmartPlant Engineering Manager and SmartPlant P&ID with SmartPlant
Foundation ............................................................................................................................................ 33
Register SmartPlant P&ID .............................................................................................................. 37
Review SmartPlant Properties for the Plant ................................................................................... 38
Register SmartPlant Electrical ........................................................................................................ 40
Retrieve the PBS Document from SmartPlant Foundation ............................................................ 42
Review Results of the Retrieve ...................................................................................................... 43
Registering Aspen Basic Engineering with SmartPlant Foundation ..................................................... 44
Open the Aspen Basic Engineering Workspace ............................................................................ 45
Retrieve the PBS Document from SmartPlant Foundation ............................................................ 47
Registering SmartPlant Instrumentation with SmartPlant Foundation .................................................. 49
Register SmartPlant Instrumentation ............................................................................................. 50
Retrieve the PBS Document from SmartPlant Foundation ............................................................ 52
Run Tasks in the SmartPlant Instrumentation To Do List .............................................................. 54
Register the New Plant with SmartPlant Foundation ..................................................................... 56
Set the Naming Convention for the New Plant/Area/Unit ............................................................... 56
Registering SmartPlant 3D with SmartPlant Foundation ...................................................................... 59
Register SmartPlant 3D .................................................................................................................. 60
Retrieve the PBS Document from SmartPlant Foundation ............................................................ 62
Review PBS Structure in the Workspace Explorer ........................................................................ 65
Creating a Greenfield Plant ...................................................................................................................... 67
Creating and Publishing PFDs and Datasheets in Aspen Basic Engineering ...................................... 67
Create a PFD in the Aspen Basic Engineering Drawing Editor ..................................................... 68
Create a Stream Datasheet in the Aspen Basic Engineering Datasheet Editor ............................ 70
Revise the PFD and Data Sheets .................................................................................................. 71
Publish the PFD and Data Sheets .................................................................................................. 76
View Published PFDs, Datasheets, and Equipment in SmartPlant Foundation ............................ 81
Creating and Publishing a P&ID in SmartPlant P&ID ........................................................................... 84
Create a Drawing in SmartPlant P&ID Drawing Manager .............................................................. 84
Retrieve a PFD ............................................................................................................................... 87
Manage Retrieved Data Using the SmartPlant P&ID To Do List ................................................... 89
Contents
Update the P&ID with Retrieved Data and New Items ................................................................... 96
Publish a P&ID ............................................................................................................................. 100
View Published P&IDs in SmartPlant Foundation ........................................................................ 102
View Shared Equipment in SmartPlant Foundation ..................................................................... 103
Retrieving a P&ID into Aspen Basic Engineering ............................................................................... 105
Manage Retrieved Data Using the Aspen Basic Engineering To Do List .................................... 107
View a Pump and Electric Motor Using Aspen Basic Engineering Explorer ................................ 112
Creating and Publishing Data Sheets in Aspen Basic Engineering .................................................... 112
Create a Data Sheet for the Centrifugal Pump ............................................................................ 113
Publish the Pump Data Sheet ...................................................................................................... 114
View Shared Equipment in SmartPlant Foundation ..................................................................... 117
Create and Publish a Datasheet for the Strainer ......................................................................... 117
View the Published Strainer Datasheet in SmartPlant Foundation .............................................. 120
Retrieving Datasheets into SmartPlant P&ID ..................................................................................... 120
Manage Update Tasks in the SmartPlant P&ID To Do List .......................................................... 122
Retrieving P&IDs into SmartPlant Instrumentation ............................................................................. 126
Manage Retrieved Data Using the SmartPlant Instrumentation To Do List ................................. 128
Add Additional Instruments to SmartPlant Instrumentation.......................................................... 131
Publishing an Instrument Index in SmartPlant Instrumentation .......................................................... 135
Creating Dimensional Datasheet (DDP) in SmartPlant Instrumentation ............................................ 138
Publishing Dimensional Data Sheets ........................................................................................... 145
Retrieving an Instrument Index into SmartPlant P&ID ........................................................................ 146
Manage Retrieved Instrument Index Data Using the To Do List .................................................. 147
View Items Created by To Do List Tasks ..................................................................................... 155
Add Retrieved Instrument Items to the P&ID ............................................................................... 156
Retrieving P&IDs and DDPs into SmartPlant 3D ................................................................................ 157
Publishing and Retrieving the Updated P&ID .............................................................................. 162
Retrieve the P&ID and DDP ......................................................................................................... 164
Create the 3D Model Using the Retrieved P&ID as the Design Basis ......................................... 168
Retrieving SmartPlant Instrumentation Dimensional Data into SmartPlant 3D ............................ 208
View the P&ID 128-5001 .............................................................................................................. 216
Publishing the 3D Model to SmartPlant Foundation ........................................................................... 217
Creating a Model File to Publish .................................................................................................. 217
Setting Up Reports and Orthographic Drawings ................................................................................. 232
Creating Isometric Drawings ........................................................................................................ 232
Creating an Orthographic Drawing ............................................................................................... 245
Creating a Report ......................................................................................................................... 272
Retrieving P&IDs into SmartPlant Electrical and Publishing a Cable Schedule ................................. 282
Add Power Consumption Data to the P&ID.................................................................................. 282
Retrieving the P&ID in SmartPlant Electrical................................................................................ 286
Managing Retrieved Data in the SmartPlant Electrical To Do List ............................................... 288
Copying the Value of the Driver Power Absorbed ........................................................................ 293
Creating Electrical Equipment and Components ......................................................................... 296
Creating Associations in Electrical Engineer ................................................................................ 305
Registering a Cable Schedule Report for Publishing.......................................................................... 308
Revising the Cable Schedule Report for Publishing ........................................................................... 313
Publishing the Cable Schedule ........................................................................................................... 319
Loading Electrical Data into SmartPlant 3D ........................................................................................ 321
Placing the Motor in SmartPlant 3D using the P&ID as the Design Basis ................................... 323
Retrieving the Cable Schedule from SmartPlant Electrical .......................................................... 328
Placing the Electrical Enclosure in SmartPlant 3D ....................................................................... 332
Correlate the Cable Schedule ...................................................................................................... 336
Placing Cableways in SmartPlant 3D ........................................................................................... 339
Contents
Publish the 3D Model for Retrieval in SmartPlant Electrical ............................................................... 345
Retrieving the 3D Model Data into SmartPlant Electrical ................................................................... 347
Verify the 3D Model Data in SmartPlant Electrical ....................................................................... 349
Working with Documents in SmartPlant Foundation .......................................................................... 355
Querying for Drawings ........................................................................................................................ 355
Sign Off Documents in SmartPlant Foundation .................................................................................. 356
Compare Document Revisions in SmartPlant Foundation ........................................................... 358
Glossary ................................................................................................................................................... 361
Index ......................................................................................................................................................... 381
Contents
Preface
This document provides an overview of integrating SmartPlant Enterprise. It describes a typical
example of full integration within SmartPlant Enterprise, including publishing and retrieving plant
information using each of the following authoring tools: Aspen Basic Engineering , SmartPlant
P&ID, SmartPlant Instrumentation, SmartPlant Electrical, and SmartPlant 3D engineering tools.
This document includes the following major topics:
Creating a greenfield plant (a new plant) in Aspen Basic Engineering, SmartPlant P&ID,
SmartPlant Instrumentation, SmartPlant Electrical, and SmartPlant 3D, including sharing data
between them
Publishing and retrieving from Aspen Basic Engineering, SmartPlant P&ID, SmartPlant
Instrumentation, SmartPlant Electrical, and SmartPlant 3D
Integration Documentation
Preface
Preface
Integration Programming Documentation
Documentation Comments
Send documentation comments or suggestions to PPMdoc@intergraph.com
(mailto:ppmdoc@intergraph.com?subject=documentation comments).
Preface
10
SECTION 1
Overview
SmartPlant Enterprise combines one or more authoring tools, such as SmartPlant 3D, SmartPlant
Electrical, SmartPlant Instrumentation, SmartPlant P&ID, and Aspen Basic Engineering with a
SmartPlant Foundation database so that data can be published and retrieved.
SmartPlant Enterprise full integration provides the following features:
User-controlled or manual workflows for managed data exchange, including To Do Lists,
e-mail notifications, versioning, approval/release, and configuration control
Transfer of engineering data from one tool to another, eliminating the need for manual
re-entry 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 forth), and
the data may come from different authoring tools.
SmartPlant Foundation acts as a repository for data and a medium through which information is
shared among authoring tools. SmartPlant Foundation manages the availability, integrity, and
accuracy of engineering information for engineering projects and operating plants. It builds a
comprehensive electronic library about a plant its structure, tags, equipment, and documents.
The following is a high-level diagram showing the types of data exchanged between tools using
full integration. For more information about integration with SmartPlant Enterprise, see the
SmartPlant Enterprise Overview.
In This Section
Software Compatibility ................................................................... 11
Software Compatibility
The examples in this document use SmartPlant Enterprise software for versions 2007 and higher.
The user interface in earlier versions of these applications may be slightly different, but the basic
workflow is the same.
SmartPlant integration now supports forward and backward compatibility. Integration supports the
SmartPlant authoring tools' use of different versions of the SmartPlant schema from the version
used in SmartPlant Foundation. Integrated SmartPlant tool versions 2007 Service Pack 4 and
later can be integrated with SmartPlant Foundation 2008 and higher. Integration software
automatically handles required transformations of data for tools. When the authoring tools release
new versions, these will also be compatible with SmartPlant Foundation 2008 and higher.
11
Overview
Compatibility Matrix
For more information about version interoperability between SmartPlant products, see the PPM
Compatibility Matrix Product Report on the Intergraph Process, Power & Marine eCustomer
Web site. To view this matrix, browse to the following Web address, and type your eCustomer
user name and password:
http://crmweb.intergraph.com/smart/Compatibility_Database/default.asp. Or, to navigate from the
Service & Support home page, click Download Software Updates > Products, and then click the
PPM Compatibility Matrices Database link in the middle of the page.
12
SECTION 2
See Also
Work Process for Creating a Custom PBS Hierarchy (on page 14)
Define the Plant Breakdown Structure (PBS) Hierarchy in the Schema (on page 17)
See Also
Define the Plant Breakdown Structure (PBS) Hierarchy in the Schema (on page 17)
Work Process for Creating a Custom PBS Hierarchy (on page 14)
13
You can use digits and special characters within the body of the plant name.
Special characters include ~ . + - = _ ! ? ' " , ; : & @ # ^ * < > ( ) | [ ] {} / \
The plant name is case-sensitive and cannot exceed 20 characters.
The plant name must be unique within the current domain. This limitation is imposed by
SmartPlant Instrumentation.
Intergraph recommends that the SmartPlant Instrumentation domain schema name and
domain name match the plant name.
Intergraph recommends that the plant name be the same name across all authoring tools.
14
By default, both the 2007 and 2008 configurations are checked to allow forwards and
backwards compatibility between schema versions when creating new objects or modifying
existing objects.
Define the custom hierarchy in the schema using the Schema Editor.
Check the CMF file back into SmartPlant Foundation.
Prepare the updated SmartPlant schema CMF file to be loaded into SmartPlant Foundation
data warehouse database.
Load the updated schema file into the SmartPlant Foundation data warehouse database.
Generate SmartPlant Foundation authoring PBS configuration.
Generate a new SmartPlant Foundation PBS authoring component schema.
Generate a new SmartPlant Foundation PBS authoring tool map schema.
Generate PBS methods, menus and forms.
Load the generated files into SmartPlant Foundation to load administration and schema data
and generate forms and menus.
Check out the existing PBS authoring adapter tool map schema and check in the PBS
authoring tool map schema that was generated.
Create a new plant.
Be sure not to create the plant until you complete all the previous steps in the
work process.
Create a host and vault and add the necessary publish interfaces needed for the vault.
Relate the new plant to a vault configured for integration.
See Also
Plant Breakdown Structure for Integration Setup (on page 13)
15
Click the Query Scope on the Desktop Client status bar to validate that the plant(s) have been
removed.
After you load the files, log out of the Desktop Client, and perform an IISRESET.
16
3.
4.
5.
6.
7.
8.
9.
10.
11.
17
Because plant is always the top-level class definition in PBS hierarchy in the schema
even if you change its display name, you cannot use "Plant" as the name of another object
in the PBS hierarchy.
The recommended naming convention for the relationship between an item and its parent
is <Parent><Item>s, for example, SitePlants. However, you can name this relationship
any name that you want.
The PBSHierarchy DirectedGraphDef is automatically created when you create the PBS
hierarchy.
6. Click OK.
7. Repeat steps 4-6 for each additional item that you want to add to the PBS hierarchy.
18
The PBS hierarchy cannot be changed after it is created in the SmartPlant Foundation
client.
19
10. Click File > Save > Schema File to save your changes to the SmartPlant schema.
11. Close the Schema Editor.
12. Click OK.
After you make changes in the schema, you must load the updated schema into the
SmartPlant Foundation database. See Load Schema Changes into the SmartPlant Foundation
Database.
20
Load the CMF Data Changes into the Data Warehouse Database
1. In the Desktop Client, click Administration > Schema Import Wizard.
2. In the Schema Import Wizard, select Compare content of selected file against all
database items with a matching container ID.
21
4. Click Next.
Schema Import Wizard compares the generated schema with the SmartPlant Foundation
database and displays the results. This process can take about 10 minutes.
22
If the items were all successfully loaded, then status in the Load State column is set to
Loaded. If not, the status if either Passed or Failed.
6. Click Finish.
23
24
The component schema and prefix are populated from the associated method.
3. Check the Combined Authoring and DW database check box.
25
26
8. Click Export.
This operation generates the schema, some basic SmartPlant Foundation administration
operations, and a tool schema with mappings to the SmartPlant schema. This information is
contained within 7 files in the output directory.
File Name
Description
SPF_01_AuthoringSchema.xml
SmartPlant
Foundation PBS
authoring
schema
SPF_02_AuthAdminData.xml
New PBS
Methods and
Menus
SPF_03_AuthFormInstruction.xml
PBS Form
Instructions
The instructions to
generate forms for newly
generated objects.
Comments
27
SPF_05_DWFormInstruction.xml
SPF_SelectedItems.xml
Copy of
Selected Items
ToolMapSchema_SPF.xml
In the Desktop Client, click File > Load and select the SPF_01_AuthoringSchema.xml file.
Generate Forms
Load the SPF_03_AuthFormInstruction.xml file. This will generate all forms defined under
the component schema.
28
Create a Vault
1. Click File > New > Administration > Vault in the Desktop Client.
2. Type a name and description for the vault.
3. In the Local path box, type the file location where you want the vault to be stored on the
SmartPlant Foundation server.
You must create the folder structure for your vault on the SmartPlant Foundation
server.
4. In the Sub directory property or name box, type
Obj->SPFFileComposition_12->SPFRevisionVersions_21->SPFDocumentRevisions_21.SP
FDocType. This property stores your published and non-published documents based on
document type.
5. In the Host list, select the host you created.
Do not set to local host.
6. Relate ISPFTEFPublishedDocVersion to the vault.
Click Find > Schema > Interface Definition. In the Find box, type
ISPFTEFPublishedDocVersion.
Drag the vault you created on to ISPFTEFPublishedDocVersion.
7. Relate ISPFNonPublishedDocVersion to the vault.
Click Find > Schema > Interface Definition. In the Find box, type
ISPFNonPublishedDocVersion.
Drag the vault you created on to ISPFNonPublishedDocVersion.
8. Relate the Owning Group to the vault.
Click Find > Administration > Vault to find the vault you created. Press CTRL and drag
the vault to the New Items window.
Click Find > Administration > Owning Group.
Drag the ADMIN owning group on to the vault.
29
Create a Unit
1.
2.
3.
4.
Click File > New > Organization / Support Items > Unit.
Type the name of your unit
Pick the Plant created in the previous step
Select New for Construction status
Create a System
1.
2.
3.
4.
Click File > New > Organization / Support Items > System.
Type the name of your system
Pick the Unit created in the previous step
Select New for Construction status
30
Click File > New > Organization / Support Items > Sub System.
Type the name of your sub system
Pick the System created in the previous step
Select New for Construction status
Testing
1. Click SmartPlant > PBS > Register.
2. Test the create, update and view functions of each item in the new structure.
3. Test the publish function.
Right-click the plant, then click Publish PBS.
Remember the PBS needs to be registered, and the Process Engineer needs to be
associated to the SmartPlantPublish and SmartPlantRetrieve roles defined in the database.
The new PBS is now ready to be retrieved by the authoring tools.
31
To activate a plant that has a status of Created, find the plant in the Desktop Client (Find >
Organization / Support Items), right-click the plant, and click Activate configuration.
32
SECTION 3
In This Section
Registering SmartPlant Engineering Manager and SmartPlant P&ID with
SmartPlant Foundation .................................................................. 33
Registering Aspen Basic Engineering with SmartPlant Foundation
....................................................................................................... 44
Registering SmartPlant Instrumentation with SmartPlant Foundation
....................................................................................................... 49
Registering SmartPlant 3D with SmartPlant Foundation ............... 59
33
3. Select the plant that you want to register under Plant Structures in the
tree view.
34
35
3. Click OK in the Specify Map File dialog box to save the map file location.
36
1. In the SmartPlant Foundation URL box, type the node name and virtual directory of the
SmartPlant Foundation database with which you want to register your plant, and then click
Next. Use the following format: http://<SPFServer>/<VirtualDirectory>. For example,
http://cert2k3ora38/spf38sp104.
37
3. Click Finish. If the registration completes successfully, the Register With SmartPlant
Software message box appears.
38
39
If SmartPlant P&ID and SmartPlant Electrical are already associated to the plant structure,
the registration process registers both applications with SmartPlant Foundation simultaneously.
40
If you are upgrading to SmartPlant Foundation 2007 Service Pack 4, each tool must
re-register with SmartPlant Foundation.
For registering tools with SmartPlant Foundation 2007 Service Pack 2 or Service Pack 3, see the
Integration Setup guide for service pack 2 and service pack 3 on eCustomer :
https://crmweb.intergraph.com/ecustomer_enu/.
The above example describes registering SmartPlant Electrical after SmartPlant P&ID is
registered. If only SmartPlant Electrical is associated to the plant structure, the complete
registration wizard appears when you register SmartPlant Electrical with SmartPlant Foundation.
41
You may be required to enter your SmartPlant Foundation user name and password
before you can retrieve from SmartPlant Foundation You are not required to enter this
information if your computer user name matches a user name in SmartPlant Foundation.
2. Select the PBS document in the Retrieve dialog box, and then click OK.
42
When the document has been retrieved, a message box lets you know that the retrieve was
successful.
43
2.
3.
4.
5.
44
If no workspace appears in the tree view, click Action > New Workspace to create a
workspace that connects to the
appropriate server.
Right-click the appropriate workspace for the plant, and then click All Tasks > SmartPlant
Registration.
The SmartPlant Registration Wizard appears. The SmartPlant Registration Wizard user
interface is the same for other authoring tools.
In the SmartPlant Foundation URL box, type the node name and virtual directory of the
SmartPlant Foundation database with which you want to register your plant, and then click
Next. Use the following format: http://<SPFServer>/<VirtualDirectory>. For example,
http://EFSPF1/SPFASP.
For the next step, you need to know the SmartPlant Foundation plant that you will register to.
In our case, we will register to plant that we created earlier.
In the Plant name list, select the plant we created earlier.
Click Finish. If the registration completes successfully, a message box appears.
45
4. In the Select Workspace or Project dialog box, click the workspace that you want to open,
and then click OK.
46
The Folders view and Filters view in the Aspen Basic Engineering Explorer contain the
appropriate objects for the workspace you selected.
47
The software displays the retrieve status in the Retrieving message box.
When the document has been retrieved, a message box lets you know that the retrieve was
successful.
When you retrieve the PBS document from SmartPlant Foundation into Aspen Basic
Engineering, the software automatically updates the database. No tasks appear in the Aspen
Basic Engineering To Do List as a result of the retrieve.
48
2. In the Open Administration Module dialog box, select Domain Administrator and then
select the domain you want to register.
49
The SmartPlant Registration Wizard appears. The SmartPlant Registration Wizard user
interface is the same for other authoring tools.
50
4. For the next step, you need to know the SmartPlant Foundation plant that you will register to.
In this example, we will register to SPF38SP104 plant that we created earlier. In the Plant
name list, select the SPF38SP104 plant.
51
If you are upgrading to SmartPlant Foundation 2007 Service Pack 4, each tool must
re-register with SmartPlant Foundation.
For registering tools with SmartPlant Foundation 2007 Service Pack 2 or Service Pack 3, see the
Integration Setup guide for service pack 2 and service pack 3 on eCustomer :
https://crmweb.intergraph.com/ecustomer_enu/.
The Select Plant dialog box allows the user to select a SmartPlant Instrumentation plant for
retrieving Plant Breakdown Structure (PBS) documents. The software uses the information
52
The software displays the retrieve status in the Retrieving message box.
53
2. Review the Create or Update Plant, Area, and Unit tasks in the To Do List.
3. Select all the tasks in the To Do List.
4. Click Run.
A check mark appears in the Status column of the To Do List when the tasks are complete.
54
55
56
57
7. After picking the source unit from which the naming convention is to be copied, click OK.
58
3.
4.
5.
6.
You can find the names in the SQL Server Enterprise Manager on the server.
7. Click OK.
59
Register SmartPlant 3D
1. In Project Management, click SmartPlant > Register.
The SmartPlant Registration Wizard appears. The SmartPlant Registration Wizard user
interface is the same for other authoring tools.
60
3. For the next step, you need to know the SmartPlant Foundation plant that you will register to.
In this example, we will register to SPF38SP104 plant that we created earlier. In the Plant
name list, select the SPF38SP104 plant.
61
62
6. Select As-built as the active WBS item in the list box on the main toolbar.
63
The software displays the retrieve status in the Retrieving message box.
When the document has been retrieved, a message box lets you know that the retrieve was
successful.
Retrieving the PBS creates the area and unit in SmartPlant 3D.
64
65
66
SECTION 4
In This Section
Creating and Publishing PFDs and Datasheets in Aspen Basic Engineering
....................................................................................................... 67
Creating and Publishing a P&ID in SmartPlant P&ID .................... 84
Retrieving a P&ID into Aspen Basic Engineering .......................... 105
Creating and Publishing Data Sheets in Aspen Basic Engineering
....................................................................................................... 112
Retrieving Datasheets into SmartPlant P&ID ................................ 120
Retrieving P&IDs into SmartPlant Instrumentation ........................ 126
Publishing an Instrument Index in SmartPlant Instrumentation ..... 135
Creating Dimensional Datasheet (DDP) in SmartPlant Instrumentation
....................................................................................................... 138
Retrieving an Instrument Index into SmartPlant P&ID .................. 146
Retrieving P&IDs and DDPs into SmartPlant 3D........................... 157
Publishing the 3D Model to SmartPlant Foundation ...................... 217
Setting Up Reports and Orthographic Drawings ........................... 232
Retrieving P&IDs into SmartPlant Electrical and Publishing a Cable
Schedule ........................................................................................ 282
Registering a Cable Schedule Report for Publishing .................... 308
Revising the Cable Schedule Report for Publishing ...................... 313
Publishing the Cable Schedule ...................................................... 319
Loading Electrical Data into SmartPlant 3D .................................. 321
Publish the 3D Model for Retrieval in SmartPlant Electrical .......... 345
Retrieving the 3D Model Data into SmartPlant Electrical .............. 347
67
The selected workspace opens in the Aspen Basic Engineering Drawing Editor.
3. Click File > New to create a PFD, and click OK. In this example, the name of the PFD should
be PFD108.
68
The selected document opens in the Aspen Basic Engineering Drawing Editor.
5. Place a column, a pump, and a drum in the PFD.
6. Place equipment labels on each piece of equipment
7. Edit each label for each piece of equipment to the appropriate tag name by right-clicking the
label, clicking the Edit Text command, and editing the text.
8. Place primary connections between the pieces of equipment you placed previously.
9. Label the primary connections using the name diamond label.
10. Edit the label of each primary connection to add the stream number by right-clicking each
label, clicking the Edit Text command, and then editing the text.
69
70
71
.
3. Select the Checked drawing and Issue it.
72
4. Revise the drawing by selecting the Revision Scheme field and selecting RevA1.
73
6. In the Aspen Basic Engineering Datasheet Editor, click File > Datasheet > by Object and
select Test Stream Datasheets 607, 609, 610 and 613.
74
A dialog box appears indicating that all datasheets have been submitted.
8. Now check the datasheets by selecting File > Datasheets > by Submitted.
The Datasheets dialog box appears with all streams listed.
9. Check the issued streams by selecting all streams and then clicking Control > Check.
A dialog box appears indicating the datasheets have been checked.
75
76
3. Click Publish.
4. In the Publish dialog box, click the OK
77
78
6. Click Publish.
79
The software displays the publish status in the Publishing message box.
When the documents have been published, a message box lets you know that the publish
was successful.
80
3. Click Find.
81
2. Click Find.
82
2. Click Find.
83
If the item exists on multiple drawings, the software prompts you to select the drawing you
want to view.
If you have SmartPlant Markup Plus loaded, the drawing containing the equipment opens
in the drawing view with the equipment highlighted and zoomed into view.
84
4. Click OK.
The new drawing is created for the selected unit.
85
7. Revise the drawing by selecting the Revision Scheme field and selecting RevA1.
8. Now select the Major field under Revise in Tool and select First. The Major field will change
to "A" and the Count and Starting Major fields are also populated with "1" and "A".
86
Retrieve a PFD
1. In Drawing Manager, click SmartPlant > Retrieve.
2. In the Retrieve dialog box, select the check boxes for the documents that you want to retrieve.
87
The software displays the retrieve status in the Retrieving message box.
When the documents have been retrieved, a message box lets you know that the retrieve was
successful.
88
89
90
on the toolbar.
The name of the drawing appears in the Destination Drawing column for the tasks you
selected.
91
92
93
3. To view the properties for a completed task, select the task in the To Do List dialog box.
4. Click Properties
on the toolbar.
5. In the Properties dialog box, review information for the completed task on the General tab.
94
95
96
5.
6.
7.
8.
9.
10.
d. Route the pipe runs that were created from in the plant stockpile when you retrieved the
PFD was retrieved.
For all nozzles and pipe runs set the fluid code to P and the piping materials class to 1C0031
in the Properties window.
Add the following instruments to the P&ID:
Control valve: ~ Symbols\Instrumentation\In-Line\Valves\2 Way Common.
Dual-action cylinder actuator: ~ Symbols\Instrumentation\Actuators
ZSC valve (discrete single-function): ~ Symbols\Instrumentation\Off-Line\Without
Implied Components\Single Function
3-way solenoid valve: ~ Symbols\Instrumentation\Off-Line\Without Implied
Components\Solenoid Valves
Connect the ZSC to the actuator using an electric signal line: ~
Symbols\Instrumentation\Signal Line.
Connect the actuator to the solenoid with a pneumatic line: ~
Symbols\Instrumentation\Signal Line.
Create an instrument loop by doing the following: ~ Symbols\Instrumentation\Loops.
In the Catalog Explorer, right-click the flow loop that you want to place.
Click Send to Drawing Stockpile.
In the Properties window, set the tag sequence number for the loop to 12820.
Add the instruments you placed to a loop by doing the following:
Select the control valve, the solenoid, and the ZSC in the drawing view.
97
11. Type % in the Search for box, and then click Search Now.
98
99
Publish a P&ID
1. In SmartPlant P&ID, click SmartPlant > Publish.
100
When the document has been published, a message box lets you know that the publish was
successful.
101
102
103
104
105
5. Select the P&ID that you want to retrieve, and then click OK.
The software displays the retrieve status in the Retrieving message box.
When the document has been retrieved, a message box lets you know that the retrieve was
successful.
106
107
108
4. To view the properties for an update task, select an update task in the To Do List, and then
click Properties on the toolbar.
109
110
111
112
4. On the New tab of the Datasheets dialog box, select P-262: AZ Centrifugal Pump 1, and
click Open.
113
114
115
When the document has been published, a message box lets you know that the publish was
successful.
116
117
118
119
120
4. Click OK.
When the documents have been retrieved, a message box lets you know that the retrieve was
successful.
121
2. Select the update task for which you want to view properties in the To Do List.
3. Click Properties
122
on the toolbar.
123
124
125
126
5. Click OK.
When the documents have been retrieved, a message box lets you know that the retrieve was
successful.
127
128
129
130
131
7. In the Select Instrument Type dialog box, type X, and click OK.
132
133
11.
12.
13.
14.
In the Select Instrument Type dialog box, type X (as previously), and click OK.
In the Tag Number Properties dialog box, select New in the Status list, and click Apply.
Click New.
In the New Tag Number dialog box, type JT, and click OK.
15. In the Select Instrument Type dialog box, type X, and click OK.
16. In the Tag Number Properties dialog box, select New in the Status list, and click OK.
17. Repeat steps 2-16 to add loop L-12820 with tag LT-12820. The instrument type is Level
Transmitter with a process function type of Level.
134
135
4. Click New.
5. In the Revision Scheme column, select the revision scheme you want to use.
6. In the Major column, select First from the list.
7. Click OK.
136
Click OK.
8. Close the Print View by clicking X in the title bar of the Print View window.
137
138
139
140
9. In the Working Data All groups window, enter the following values in the appropriate
columns for ABV-12820:
Column Name
Dimensional Group
IRXPA
Inlet Class
150
Outlet Size
Outlet Class
150
141
10.
11.
12.
13.
142
15. Click Revision at the bottom of the application window to revise the new dimensional
datasheet.
143
144
21. Click Save at the bottom of the application window to save the datasheet.
145
If ABV-12820 already exists in SmartPlant P&ID, you can model it in SmartPlant 3D. To be
able to model the valve in SmartPlant 3D, it must be on the P&ID. Inline instruments are
dependant on the existence of the dimensional datasheet and the instrument being on the P&ID.
146
147
148
on the
149
150
151
4. Review properties for the create tasks for the new instruments by selecting a task and clicking
Properties
on the toolbar.
5. Make sure the catalog item is defined for the instruments; if the catalog item is not defined, the
task will fail to run.
6. Click
152
153
9. After reviewing and assigning the catalog item for each task, select the tasks in the to do list
and click Run Task
154
155
2. Place the instruments EY, HS, and JT-12820 you retrieved from SmartPlant Instrumentation
in the P&ID.
3. Place instrument connectors on the motor MP-262 and then use electric signal lines to
connect the instruments to the instrument connectors.
The following graphic shows how the instruments should look when they are placed in the
P&ID.
156
157
4. Click the appropriate New System command and create the following systems:
Generic System
Ducting System
Equipment System
Conduit System
Piping System
158
Structural System
159
7. Click OK
160
9. Click Tasks > Common. The new systems appear in the Workspace Explorer.
161
4.
5.
6.
7.
162
Publish the instrument index again, then retrieve it back into SmartPlant P&ID.
Open the To Do List in SmartPlant P&ID. You should not receive any tasks.
In the SmartPlant Instrumentation, retrieve the P&ID again
Open the To Do List in SmartPlant Instrumentation and verify that there are no new tasks that
you need to run. This ensures all items are correlated and the data that is published and
retrieved is the same.
Subscription Notification
When the software loads documents into SmartPlant Foundation, the SmartPlant Loader sends
an e-mail notification message to all subscribed users.
163
164
165
6. In the View P&ID dialog box, select the P&ID that you want to view, and then click Open.
166
167
168
3. Click SmartPlant > View P&ID, and select the P&ID that you want to open.
4. In the P&ID File Viewer, click the equipment that you want to place in the model.
169
5. In the Equipment and Furnishings task, verify the name in the Name box on the toolbar
matches the name of the equipment in the P&ID.
170
8. Click Close.
171
E 0 ft
N 0 ft
EL 0 ft
172
13. Select the equipment that you placed in the model, and click Properties
on the ribbon
bar.
14. Change the following Equipment Dimension properties for the tower on the Occurrence
tab, and click OK:
Vessel Start Point 2 ft
Vessel Height 50 ft
173
15. Repeat steps 4-14 to place pump P-262 from the P&ID, and define the following properties for
the pump:
Designed Equipment Pump
Part Number HorCFJacketedPump01-E
E 20 ft
N 0 ft
EL 2.5 ft
16. Repeat steps 4-14 to place vessel D-262 from the P&ID, and define the following properties
for the vessel:
Designed Equipment Simple Horizontal Cylindrical Vessel
Part Number SHCV-01-L400xD1500-E
E 20 ft
N 30 ft
EL 2.5 ft
174
.
Looking down on the model, the final view should look like the following graphic:
175
Place Nozzles
1. Click Format > View, and select Reference Geometry. Then click OK.
2. In the Equipment and Furnishings task, set the locate filter to Pipe Nozzle.
176
4. In the P&ID File Viewer, click the top nozzle on the tower (A1).
5. Verify the name in the Name box on the toolbar matches the name of the nozzle in the P&ID.
6. Click Place Nozzle
177
8. In the Nozzle Properties dialog box, set the following properties for the nozzle, and click OK.
Occurrence Tab
Nominal Size 3
Termination Class Bolted
End Preparation Raised-face flanged end
Rating Practice US Practice
Pressure Rating CL150
Name A1
178
Nozzle Length 6 in
Location Tab
Placement Type Radial
N1 45 ft
N2 3 ft 6 in
179
180
OR1 180
9. In the P&ID File Viewer, click the manway M1 on the right side of the tower.
10. Repeat steps 5-8 for the manway using the following properties:
Placement Type Radial
N1 40 ft
N2 3 ft 6 in
181
OR1 0 deg
11. In the P&ID File Viewer, click the bottom nozzle B1 on the tower, and repeat steps 5-8 for the
nozzle using the following properties:
Placement Type Axial
N1 -2 ft 6in
N2 0 ft
182
OR1 0 deg
183
12.
13.
14.
15.
184
These nozzles were predefined and are not used in this example.
17. Repeat steps 12-16 for Vessel Noz2, Vessel Noz3, and Vessel Noz4.
185
186
4. Click Update to transfer data from the design basis to the model, and then
click Close.
187
5.
6.
7.
8.
9.
188
189
The name of the nozzle appears in red in the Compare with Design Basis dialog box
because the name of the nozzle in the P&ID does not match the name of the nozzle in the
designed equipment.
Data is updated and appears as follows:
13. Repeat steps 4-12 to correlate the intake nozzle on the pump with the P&ID
design basis.
190
191
192
193
194
This procedure inserts the flange in the P&ID and automatically correlates it with the
3D model. You can insert the flange and route pipe without using the P&ID as the design
basis, but there is no correlation between the P&ID and 3D model.
195
196
Then, in the Property list, type 100F as the Design Maximum Temperature and 100F
as the Design Minimum Temperature.
Click OK in the New Pipe Run dialog box, and click Finish on the ribbon bar.
If you receive the following message, SmartPlant P&ID is not publishing the
correct short codes and piping model codes for SmartPlant 3D. Update the piping
specification for the P&ID and publish the P&ID again. See the SmartPlant P&ID User's Guide
for how to setup the piping spec in SmartPlant P&ID for use in SmartPlant 3D.
197
13. Continue routing from the reducer to the nozzle (A1) on the pump.
198
14. To route the discharge portion of the pump, click the discharge nozzle B1 in the P&ID File
Viewer.
15. On the ribbon bar, type 2 feet as the Length..
16. Click Insert Component
on the vertical toolbar.
17. In the New Pipe Run dialog box, click OK.
199
19. Continue routing the line up to the nozzle A1 on top of tank D-262.
The routed line appears as represented in the graphic below.
200
20. In the 3D model, select the pipe you just routed, and click SmartPlant > Compare with
Design Basis.
201
If you have problem correlating the pipe runs, check the topology tab on the
Compare Design Basis dialog box. A red row in the table indicates you have a problem with
the flange not correlating.
202
203
204
205
206
207
208
The software displays the retrieve status in the Retrieving message box.
209
All the dimensional data for the valve comes from the DDP published by SmartPlant
Instrumentation.
210
211
212
5. To update the entire line, select all items in the line in the 3D model, and click SmartPlant >
Compare with Design Basis.
213
6. Click Yes in the message box to update the properties for the selected objects.
214
8. Click Load.
Bulk loading data could take several minutes.
9. Click Close on the Bulkload utility.
215
216
2. Right-click in the Management Console and click New on the shortcut menu.
3. In the Add Component dialog box, select Folder. Right-click Folder and
rename it.
For this example, the folder is INTDemo.
217
218
219
8. Expand Default Filters > SP3D Object Filters > Object Types.
9. Select the filter that you want, then click OK on the Select Filter dialog box.
220
221
12. Right-click 3D Model Data-1-0001, and click Revise on the shortcut menu.
222
13. Set Revision Scheme and the Major under Revise in Tool. After these options are
selected, click OK on the Revise dialog box.
The following two dialog boxes appear:
223
224
18. After the model file is updated with the proper Revision and WBS attributes, you can publish
the file. Right-click 3D ModelData-1-0001, and click Publish on the shortcut menu.
225
19. Click OK and the following progress dialog box appears as the model is published.
After the document has successfully been published, the following dialog
box appears.
226
227
228
229
230
231
232
233
234
on the toolbar.
235
236
11. In the Management Console, right-click Iso Pipeline Isometrics, then click Run Query.
237
When the query is complete, Iso Pipeline appears in the Management Console.
12. Right-click Iso Pipeline, then click Properties on the shortcut menu.
13. In Properties dialog box, click the WBS tab.
14. Set the Document Type property to Civil Overall Isometric.
238
239
17. In the Save Package dialog box, define the package properties.
SmartPlant 3D saves all packages to C:\Program Files\SmartPlant\
3D\CatalogData\Symbols. Packages can be copied and reused with
other projects.
240
SmartPlant 3D automatically creates the isometric drawings based on the query that
was performed earlier.
19. Right-click Iso Pipeline, then click Revise.
If documents exist in the project, you must select each new document and revise each
individually.
241
If documents exist that have different status, for example, working and current, you must
select each document and revise each individually.
20. Set Revision Scheme and the Major revision under Revise in Tool. After these options are
chosen, you can select OK in the Revise dialog box.
242
243
244
245
3. In the Management Console, right-click New Folder, then click Rename. Rename the folder
to Ortho Drawing.
246
247
248
249
250
251
252
11. In the Drawing View Properties dialog box, click the View tab. Define the view properties.
253
13. In the Management Console, right-click the Orthographic Drawing template, then click
Setup.
254
15. Expand Categories > Default Filters > SP3D Object Filters > Equipment and Furnishing.
16. Select Equipment.
255
18. In the Management Console, right-click the Orthographic Drawing template, then click
Save Package.
256
Define the Tab Name to add the tab to the Add Component dialog box.
SmartPlant 3D saves all packages to C:\Program Files\SmartPlant\
3D\CatalogData\Symbols.
Packages can be copied and reused with other projects.
20. In the Management Console, right-click the Ortho Drawing folder, then
click New.
21. In the Add Component dialog box, click the tab your defined earlier. In this example, the tab
is Demo.
257
23. In the Management Console, right-click the Ortho Drawing folder, then click New.
258
259
260
28. In the Setup dialog box, select More under the Filter option.
261
30. In the New Filter Properties dialog box, click the System tab.
31. Select the plant folder to highlight all systems.
262
263
34. In the Setup dialog box, select More under the Package option.
264
265
38. In the Management Console, right-click the Equipment Drawings folder, then click Create
Drawings.
266
39. In the Detail View, select all drawings. Right-click, then click Properties.
267
268
269
270
271
Creating a Report
1. In the Management Console, right-click the project folder, then click New.
272
3. In the Detail View, right-click New Spreadsheet Reports, then click Create Report on the
shortcut menu.
273
274
275
276
9. Click the WBS tab. Set the Document Type to General Reports.
277
11. In the Detail View, right-click the report, then click Revise.
278
279
280
281
282
283
In the Properties window, find the Power Driver Rated list and select 40.0 hp.
284
When the documents have been published, a message box lets you know that the publish
was successful.
285
286
When the documents have been retrieved, a message box lets you know that the retrieve was
successful.
287
288
289
290
291
4. Next select the pump P-262 task and run this task first.
5. Next select the motor MP-262 task and run to create the motor.
292
2. Select P-262
293
4. Select the check box for the P-262 that you need to copy, then click OK.
A message box appears when the Power Absorbed data has been updated successfully.
294
6. On the Load Data tab, verify that the Brake power is 35 HP.
295
1. In the Electrical Index, expand Electrical Equipment > Power Distribution Equipment.
296
297
298
299
300
301
9. In the Reference Data Explorer, expand Wiring Equipment > Cables > Power Cables.
10. Select 3+1/C - 150 mm^2 - (Power / mm^2) cable.
302
11. In the Electrical Index, expand Wiring Equipment > Cables > Power Cables.
303
304
305
4. In the Electrical Index, expand Electrical Equipment > Loads > Motors.
306
307
308
309
310
5. In the Register Report Common Properties dialog box, type in the Document Name and
Description.
311
312
313
314
315
The software displays the revision status in the Revise Documents message box.
When the document is revised, a message box lets you know that the revision was
successful.
316
317
318
2. Click OK.
319
When the document is published, a message box lets you know that the publish was
successful.
320
321
322
323
9.
324
Click OK to place the motor. Place it within the proximity of the pump.
The Compare with Design Basis dialog box prompts you that a data mismatch exists.
The Equipment Properties dialog box also shows the data inconsistency.
325
326
327
328
The software displays the retrieve status in the Retrieving message box.
When the document has been retrieved, a message box lets you know that the retrieve was
successful.
329
330
4. In the CableSchedule dialog box, review the From Device and To Device equipment items
list.
331
In the SmartPlant 3D, the names of Electrical Enclosures selected from the Catalog
must match the From Device list in the cable schedule.
332
8. Click OK.
333
334
335
In the Workspace Explorer, select the system in which the cable equipment should appear.
Click SmartPlant > View Cable Schedule.
Open 3D Cable Schedule.
Select the cables to correlate, then click Process.
Check the Include up-to date cables and Select All options before clicking Process.
These options allow you to view correlated items in the cable schedule.
336
337
338
339
5. Select the appropriate system for the cableways, then click OK.
340
7. Select a starting point in the graphic view for the new cableway.
8. Select points to define the route of your cableway.
9. Select the end point of the cableway.
341
342
6. Click Accept.
7. Select the conduit and cable trays that you want the cable to run through.
343
9. Click Accept.
10. Click Finish.
The current cable path appears highlighted in white in the model.
344
When publishing the model for retrieval into SmartPlant Electrical, you can set a filter to
publish electrical data only. This will reduced retrieval time in SmartPlant Electrical.
345
4. Click OK.
346
When the document is published, a message box lets you know that the publish was
successful.
347
3. Select the check box next to 3D Modal Data-1-0001, then click OK.
348
When the document has been retrieved, a message box lets you know that the retrieve was
successful.
349
The cable name appears in the General tab under Destination Item Tag.
350
351
4. In the Electrical Index, expand Wiring Equipment > Cables > Power Cables.
352
6. In the Cable Common Properties dialog box, select the Design Data tab.
353
354
SECTION 5
In This Section
Querying for Drawings ................................................................... 355
Sign Off Documents in SmartPlant Foundation ............................. 356
To clear your search criteria and perform another query, click Reset.
To do a quick search for an object by name, you can use the commands on the Find
menu.
To save the query, click Save.
355
356
5. Click OK.
357
358
3. To center the display on both Navigate tabs on a particular item, click the item in the table.
359
360
Glossary
A
active scope
A configuration in which you may view, create, modify, and delete information in the SmartPlant
Foundation client.
adapter
Authoring tool software that facilitates the sharing of data between the authoring tool and other
integrated tools. Tool adapters generate XML files for publish operations and consume XML when
tools retrieve documents. Adapters are also called SmartPlant adapters.
API
1) Application Programming Interface. 2) American Petroleum Institute.
as-built
The set of data that describes the existing conditions of a plant or site; the completed and approved
state of a project.
attribute
An object characteristic.
authoring tools
Applications where documents are created and then shared through integration. Integrated
authoring tools include Aspen Basic Engineering, SmartPlant P&ID, SmartPlant Electrical,
SmartPlant Instrumentation, SmartPlant 3D, SmartPlant Materials, and SmartPlant Foundation.
B
batch printing
Printing files at a specified date and time from the SmartPlant Foundation client.
361
Glossary
brownfield
An existing plant or site that is modified by one or more projects.
C
cache
Memory that stores recently-accessed data so that subsequent requests to access the same data
can be processed quickly.
cases
Configurations for instruments that may include specific parameters, settings, or even components
for use in a specific situation.
change notification
An e-mail message sent to a user when an action is performed on an object in SmartPlant
Foundation.
check out
Allows you to make changes to an existing document in SmartPlant Foundation. Only the user who
has checked out a document can save changes to it.
checklist
A series of items, tasks, or questions that the user finishes before a completing a step in a workflow.
Checklists can be optional or required.
claim
362
Glossary
client API
A .dll (dynamic link library) that performs a particular function in SmartPlant Foundation. Client APIs
are processed by a specific section of code in a component.
common UI
An ActiveX component (.dll) that provides a standard user interface for integration functionality, such
as publish, retrieve, and register. The authoring tools display the common UI when the user clicks
particular SmartPlant commands in the authoring tool.
compare
To view the differences between two revisions of the same document in SmartPlant Foundation.
component
A .dll (dynamic link library) that handles requests on the SmartPlant Foundation server. Components
are also called business service layers (BSLs).
component schema
A subdivision of the complete SmartPlant schema that contains the set of class definitions that are
used within a specific domain or application area.
condition
An object that can restrict access to a method, workflow, or relationship based on specified criteria.
configuration tree
A representation in a tree list, which may include plant, areas, units, and projects that indicates the
structure in which the data is stored in SmartPlant Foundation.
container
An object used by the tool adapters and the SmartPlant software components to pass data back and
forth between a tool and SmartPlant Foundation. A container may hold data or metadata related to
the data model or actual instance data.
contract
A group of documents that are collected and issued for bid, construction, review, and so on.
363
Glossary
correlation
The relationship between items that represent the same object in multiple authoring tools.
create scope
A configuration for data creation, modification, and termination in SmartPlant Foundation.
current document
A document that has been signed off. Current documents can be revised in SmartPlant Foundation,
but not checked out or in.
cut-off date
Any date on which progress information is calculated. Official cut-off dates are scheduled in advance
and are typically part of a reporting schedule. Unofficial cut-off dates are random dates when rollups
are not scheduled but progress is calculated anyway.
D
data list
A list of plant items that can be modified outside SmartPlant Foundation. You can generate data lists
to view and edit SmartPlant Foundation data in Microsoft Excel, and then save the data back into
SmartPlant Foundation.
data sheet
A file that allows users to view, edit, and print object data in a customizable format.
database
Collection of files of comprehensive information that have predefined structure and organization; a
specific program can communicate, interpret, or process these files.
364
Glossary
design basis
An item in an authoring tool that represents an item from an upstream application (an application
used earlier in the lifecycle of the plant). Plant items placed with the authoring tool correspond to a
particular design basis item.
Design basis items provide a means of determining if the plant items within the authoring tool are
consistent with the items from the upstream application and help users maintain consistency as
changes are made in all authoring tools.
design file
A file generated by a design tool, such as SmartPlant P&ID or Aspen Basic Engineering.
digest
See e-mail digest.
display item
Object used to present data or relationships on a form in SmartPlant Foundation.
distribution matrix
A list of people who will receive a transmittal created in SmartPlant Foundation and an indication of
what is expected from each recipient. Workflows can also be configured to use a distribution matrix
for sending To Do List or e-mail notifications to workflow step recipients.
document
An object used to track revisions to a design file in SmartPlant Foundation.
document master
An object used to group all the revisions of a document in SmartPlant Foundation.
document revision
An officially recognized change to a document.
domain
A set of data (for example: tool data, SmartPlant Foundation administration data, and schema data)
that is segregated and managed independently in SmartPlant Foundation. Data segregation
improves performance and maintains data integrity. The SmartPlant Enterprise authoring tools
create data in one SmartPlant Foundation domain and publish into another domain.
365
Glossary
downstream forecasting
A feature that uses timestring information and actual dates when steps were completed to provide
an estimated completion date for subsequent steps.
dump file
A file that contains data exported from the SmartPlant Foundation data or system administration
database. You can import database dump files using SmartPlant Foundation Server Manager.
E
edge definition
Single or multiple relationship definitions with direction. In the SmartPlant schema, an edge
definition is used to traverse from a starting object to related objects.
effectivity date
The period of time for which historical data is displayed in SmartPlant Foundation.
e-mail digest
A collection of notification messages from SmartPlant Foundation that are sent together instead of
separately. You can set a user preference in the Desktop Client to receive digests instead of
individual e-mail messages.
enumerated entry
A member of an enumerated list that defines one possible value for a property in the SmartPlant
schema. Enumerated values are sometimes called enumerated entries.
enumerated list
A list of possible string property values defined for a property definition in the SmartPlant schema.
Enumerated sets are sometimes called enumerated lists, picklists, codelists, and lookups.
exposes
The relationship between interface definitions and property definitions in the SmartPlant schema.
Interface definitions expose the property definitions for class definitions.
366
Glossary
file server
A service that handles direct file transfer between vaults and the SmartPlant Foundation client.
file type
A setting in SmartPlant Foundation that specifies the format of attached files based on file extension.
This setting determines how files are viewed, edited, and printed in SmartPlant Foundation.
folder
A grouping object that can contain a number of items. A folder can contain other folders, to build up
a folder hierarchy. A folder can have an owner, which makes it visible only for that user, and it can
have an owning group, which allows access for members of the group. Some uses of a folder include
grouping objects, putting a folder's contents through a workflow, and generating a data list from a
folder's contents.
form
A part of the SmartPlant Foundation client user interface that allows users to specify values for class
definition properties.
FTR
Full-Text Retrieval; a separate module of SmartPlant Foundation that allows you to store, index, and
search for text contained in or associated with objects managed by SmartPlant Foundation. Full-text
retrieval creates an inverted index (a list of the individual words with locations in the files) and uses
this index at search time.
G
governing case
The specific case used for an instrument.
graph definition
A connected network of edge definitions with structure. Each graph definition in the SmartPlant
schema starts at an interface definition and traverses through one or more relationship definitions to
another interface definition at the other end. Graph definitions are sometimes referred to as directed
graph definitions.
367
Glossary
graphic report
A filtered view of a drawing or model, displayed graphically in SmartPlant Foundation.
greenfield
A new plant on a site with no existing infrastructure.
H
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, used for grouping
data.
host
A computer that stores files.
hotspot
Graphical notification that a user can click a drawing item in a drawing or viewable file to display the
properties for the item in SmartPlant Foundation.
I
implies
The relationship between two interface definitions in the SmartPlant schema. If an interface
definition implies another interface definition, then any class definition that realizes the first interface
definition can also realize the implied interface definition.
integration
Technology that standardizes and improves the communication among the various SmartPlant
Enterprise authoring tools used in the course of designing, constructing, and operating a plant.
Integration manages data exchange among these authoring tools, which enables sharing and reuse of plant information throughout the plant lifecycle.
368
Glossary
interface definition
A named collection of property definitions that represents a role for a class definition in the
SmartPlant schema.
issue
To release a document as part of a transmittal. The document is not considered issued until the
status of the transmittal has been changed to issued.
issue request
A staging of documents and drawings to be issued with a transmittal. An issue request means that
the documents or drawings are ready to be issued with a transmittal, but does not actually cause the
transmittal to be issued.
M
master file
A document file that references other files.
meta schema
A set of schema objects that describe the objects in the SmartPlant schema. The meta schema
provides the building blocks upon which the SmartPlant schema is built.
method
A call to an API that allows users to perform actions on objects or interfaces in SmartPlant
Foundation.
O
owning group
The user group to which an object is assigned in SmartPlant Foundation.
369
Glossary
picklist
A list of applicable values for a given property in SmartPlant Foundation.
plant
An object that can represent the top level in the delivered SmartPlant Foundation data hierarchy. If
you use a custom hierarchy, the object at the top level of the hierarchy may have a different name.
print server
A computer that processes print requests for a defined list of printers in SmartPlant Foundation.
process cases
Configurations for instruments that may include specific parameters, settings, or even components
for use in a specific situation.
profile
See user profile.
progress
Functionality that allows users to track the development of deliverables, such as documents or
items, against a project plan, indicating any deviations from the original plan.
project
A logical unit of data that is a subset of the items that make up a plant. A project is used for making
controlled, incremental changes to the data in a plant. There can be multiple projects for a plant at
any given time.
property
An object characteristic.
370
Glossary
property definition
A basic attribute shared by all members of a class. Property definitions are grouped using interface
definitions in the SmartPlant schema.
publish
To share a document and its data with other authoring tools by exporting an XML file containing the
document data and relationships. When a document is published, the software places the XML file in
the appropriate SmartPlant Foundation vault and loads the data from the XML file into the
SmartPlant Foundation database. After the document is published, users can retrieve the data from
the XML file located in the SmartPlant Foundation vault into other authoring tools.
punchlist
Provides a running to do list of outstanding scope for completions.
Q
query
A detailed search based on object properties.
query scope
A configuration for data queries and relationship expansions in SmartPlant Foundation.
R
realizes
The relationship between class definitions and interface definitions in the SmartPlant schema. Class
definitions realize interface definitions. The interface definitions that are realized by a class definition
expose the properties for that class definition.
371
Glossary
reference file
Files associated with a master file in SmartPlant Foundation.
register
To map an authoring tool and all its projects to a SmartPlant Foundation URL, which points to one
SmartPlant Foundation database. You must register your authoring tool plant before you can publish
and retrieve in an integrated environment.
relationship
An association between two objects.
relationship definition
Associations between interface definitions in the SmartPlant schema. Relationship definitions
identify two specific objects that fulfill the roles on each end of the relationship.
resurrected object
A deleted authoring tool object that is reintroduced to the SmartPlant Foundation database when
recovered tool data is republished. For example, a tool initially publishes a document containing an
object, but later deletes the object and republishes. SmartPlant Foundation then detects that the
object is deleted. However, if the tool restores data that was backed up before the object was
deleted, through a data restoration or other tool-specific mechanism, and republishes, then
SmartPlant Foundation recognizes that the object was previously deleted but has been reintroduced
(resurrected).
retrieve
To import document data from an .XML file that was published by another authoring tool for the
purpose of maintaining consistency of data across tools. When you retrieve a document, most
authoring tools analyze the impact of the newly retrieved data on the existing database and then
place tasks on the authoring tool's To Do List. The tasks on the To Do List allow you to create,
delete, or modify items at the appropriate time in the design process.
revision
An officially recognized change to a document. Each revision of a document may have multiple
versions.
372
Glossary
revision scheme
A numbering convention for document revisions.
role
A role determines a user's level of access to data and functionality in a specific plant/project
configuration. Users can belong to more than one role per configuration. Roles are defined by
system administrators and are based on related access groups, domains, and owning groups.
rollup
The process of calculating progress data. Progress is calculated for every deliverable at every level
of the hierarchy, and all of that information is available for viewing or reporting when you run a rollup.
Rollups can be scheduled with official cut-off dates or can be run manually at any time.
S
schema
A model used to describe and validate the structure of XML files.
Schema Component
A suite of ActiveX components that provide functionality surrounding the creation, parsing,
validation, and comparison of the SmartPlant schema and data. The tool adapters interact with the
Schema Component to read the SmartPlant schema, to create data for publish, and to retrieve data.
scoped by
The relationship between property definitions and property types in the SmartPlant schema. The
scoped by relationship specifies the property type that defines acceptable values, or scopes, a
particular property definition. Every property definition in the SmartPlant schema is scoped by one
and only one property type. All properties of that property definition must be of that property type.
section
A collection of display items used on SmartPlant Foundation forms.
server
A computer that stores or processes files.
373
Glossary
shared object definition
A schema object used to group together similar class definitions that define the same object in
different domains. Class definitions that can be shared have a Sharing relationship with shared
object definitions in the SmartPlant schema.
sharing
The relationship between class definitions and shared object definitions in the SmartPlant schema.
This relationship indicates that a class definition can be shared.
SI
International System of Units, sometimes referred to as the metric system. When values for units of
measure are published, they are converted to SI units and stored, regardless of the units of measure
selected when the user defined the value in the authoring tool.
sign off
To approve a particular revision of a document in SmartPlant Foundation. Signing off a document
sets the document to be the current released revision, makes it official, and supersedes any
previous released revisions. Document revisions that have been signed off are frozen and cannot be
checked out.
site
Refers to the SmartPlant Foundation server settings that point to SmartPlant Foundation
Administration and Data databases and vaults. Each site allows you to run SmartPlant Foundation
operations on data associated with plants and projects configured in the database.
SmartPlant Enterprise
A suite of Intergraph engineering applications that are delivered together.
SmartPlant schema
An XML file that describes the structure of the XML files generated by integrated authoring tools in
much the same way as a data dictionary describes the structure of a database. As tools publish
documents 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.
374
Glossary
status
The state of a change object at the completion of each step in a workflow.
step
A process that must be performed in order to complete a workflow.
subscribe
To register interest in an object so that you receive a notification when the object is modified. You
can manually subscribe to change notifications in the SmartPlant Foundation client.
superseded
Indicates that a newer, working version of the selected document exists.
symbology
Settings that determine how a drawing or model will appear when displayed as a graphical report in
SmartPlant Foundation.
T
TEF
The Engineering Framework; technology behind the integration of SmartPlant Enterprise products.
terminate
To change the status of a SmartPlant Foundation object to terminated without removing it from the
SmartPlant Foundation database. Terminating objects, instead of deleting them, allows you to
continue to see the history of the object after termination.
timestring
A schedule that assigns a certain number of days for the completion for each step in the lifecycle of
a deliverable.
title block
The portion of a drawing that contains information about the drawing, such as who created the
drawing, when it was created, who approved it, and so on. The type of information included in the
title block varies by drawing type, industry, and organization.
375
Glossary
To Do List
A graphical list of tasks that require attention from the user. In SmartPlant Foundation, the To Do
List contains workflow steps assigned to the user. In the authoring tools, such as SmartPlant P&ID
and SmartPlant Instrumentation, the To Do List contains create, delete, and update tasks
generated when a user retrieves a document.
token
A license that provides timed access to users of SmartPlant Foundation. When a user opens the
software, a token is activated.
There are two types of tokens: daily and perpetual. Daily tokens are available to all users and are
valid for 12 consecutive hours after the user logs on to SmartPlant Foundation. When a daily license
token is checked out, a token is depleted from the daily token file. If there are no tokens left in the
daily token file, then other users cannot access the software. Perpetual tokens are only available to
a select group of system users and provide unlimited access to the software.
tombstone
Delete instructions for an object that has been removed in one of the authoring tools. Upon retrieval
of a tombstone, delete tasks are created in the authoring tool's To Do List to allow the tool to delete
the object from its database.
tool
See authoring tool.
tool adapter
See adapter.
tool schema
A set of schema objects that describe the data in the authoring tool databases before it is
transformed into the format prescribed by the SmartPlant schema. The tool schema also specifies
the mapping between objects in the tool database and the SmartPlant schema.
tool signature
A unique identifier for the relationship between a plant in SmartPlant Foundation and a specific plant
in an authoring tool database. The relationship is created when an authoring tool registers with
SmartPlant Foundation.
376
Glossary
transmittal
A controlled package of documents used to perform, track, and record the distribution of project
documentation among different design teams.
U
unit
Group of parts of the schematic and individual worlds of a plant that together perform a given
process function. The identifying number of the unit is unique within the project and within the plant.
Most companies, but not all, use the concept of unit.
UoM
A unit of measurement.
user
An object that specifies data about a person who is authorized to use SmartPlant Foundation.
user profile
Information about windows, configuration, and interface settings, saved by the SmartPlant
Foundation client when you close the application and used to configure the application when you
reopen it.
V
vault
A folder where files are stored on a host computer.
version
An intermediate update to an existing document that is tracked by the SmartPlant Foundation
software.
377
Glossary
view definition
A named group of properties extracted from the possible properties that a graph definition exposes.
View definitions are used in an integrated environment to provide a different view of data from that
provided by the underlying schema.
virtual directory
A Web folder created in IIS that points to a physical folder on the Web server. Virtual directories are
used by SmartPlant Foundation to run applications and services from the SmartPlant Foundation
server and to transfer files between file servers and clients.
W
Web Portal
Provides the functionality of the SmartPlant Foundation client system through an easy-to-deploy
Internet Explorer web browser. Based on the software configuration and authorization of the System
Administrator, you can perform the following functions:
View information from the database about a specific object
Search for objects in the database
View drawings and 3D models
View a history for a particular object
View relationships between objects
weighting
The percentage of a project that is made up by a step, sub- step, or deliverable. When you create a
step or sub-step for a deliverable or assign a deliverable to workpack, you must indicate what
percentage of the work that item represents. For example, if a deliverable is 30 percent complete
when a particular step is finished, the weighting for that step is 30.
wildcard
A character that helps you narrow your search for objects in the SmartPlant Foundation database.
You can use wildcards in any text box in the Find and Query dialog boxes.
Text wildcards in SmartPlant Foundation include the following:
? - Finds any single character
* - Finds any string of characters
% - Performs the same function as *
378
Glossary
Work Breakdown Structure (WBS)
The composition of the plant based on the construction work to be completed. The plant usually
occupies the top level of the hierarchy; it is typically followed by projects, contracts, and documents.
workflow
A series of steps defining actions to be taken on an object in SmartPlant Foundation.
working document
A document that has not been signed off in SmartPlant Foundation.
X
XML
Extensible Markup Language; the format for all documents published or retrieved in an integrated
environment. These XML files must conform to the structure defined by the SmartPlant schema.
379
Glossary
380
Index
A
active scope 361
adapter 361
Add Additional Instruments to SmartPlant
Instrumentation 131
Add Power Consumption Data to the P&ID
282
Add Retrieved Instrument Items to the P&ID
156
Add the PBS to SmartPlant Foundation and
Test 29
API 361
as-built 361
Assign Tasks in the To Do List to a Drawing
90
attribute 361
authoring tools 361
B
batch printing 361
brownfield 362
Bulk Loading Piping Specialty Data 214
C
cache 362
cases 362
change notification 362
Check In the CMF file 20
check out 362
Check Out the SmartPlant Schema CMF File
17
checklist 362
claim 362
class view map 362
client API 363
common UI 363
compare 363
Compare Document Revisions in SmartPlant
Foundation 358
component 363
component schema 363
condition 363
configuration tree 363
container 363
contract 363
D
data list 364
data sheet 364
data sheet template 364
database 364
381
Index
Define the Plant Breakdown Structure (PBS)
Hierarchy in the Schema 17
design basis 365
design file 365
digest 365
display item 365
distribution matrix 365
document 365
document master 365
document revision 365
domain 365
downstream forecasting 366
dump file 366
F
file server 367
file type 367
folder 367
form 367
FTR 367
hierarchy 368
host 368
hotspot 368
I
implies 368
Include Plants in a Configuration 32
integration 368
Integration Hierarchy Limitations 13
382
O
Open the Aspen Basic Engineering
Workspace 45
Overview 11
owning group 369
P
picklist 370
Place Equipment 168
Place Nozzles 176
Place the Instrument Valve 210
Place the Strainer 211
Placing Cableways in SmartPlant 3D 339
Placing the Electrical Enclosure in SmartPlant
3D 332
Placing the Motor in SmartPlant 3D using the
P&ID as the Design Basis 323
Index
plant 370
Plant Breakdown Structure 13
Plant Breakdown Structure (PBS) 370
Plant Breakdown Structure for Integration
Setup 13
Plant Naming Guidelines 14
Preface 7
Prepare the CMF Data to be Loaded into
SmartPlant Foundation 20
print server 370
process cases 370
profile 370
progress 370
project 370
property 370
property definition 371
publish 371
Publish a P&ID 100
Publish the 3D Model for Retrieval in
SmartPlant Electrical 345
Publish the PFD and Data Sheets 76
Publish the Pump Data Sheet 114
Publishing an Instrument Index in SmartPlant
Instrumentation 135
Publishing and Retrieving the Updated P&ID
162
Publishing Dimensional Data Sheets 145
Publishing the 3D Model to SmartPlant
Foundation 217
Publishing the Cable Schedule 319
punchlist 371
Q
query 371
query scope 371
Querying for Drawings 355
R
realizes 371
Reason For Issue (RFI) 371
Reason For Receipt (RFR) 371
reference file 372
register 372
Register SmartPlant 3D 60
Register SmartPlant Electrical 40
Register SmartPlant Instrumentation 50
Register SmartPlant P&ID 37
Register the New Plant with SmartPlant
Foundation 56
Registering a Cable Schedule Report for
Publishing 308
383
Index
Run Tasks Created by Retrieving the
Instrument Index 150
Run Tasks in the SmartPlant Instrumentation
To Do List 54
Run To Do List Tasks 93
Run To Do List Tasks and Republish the
P&ID 125
Run To Do List Tasks in Aspen Basic
Engineering 110
S
schema 373
Schema Component 373
scoped by 373
Search for Published Equipment Datasheets
in SmartPlant Foundation 82
Search for Published Equipment in
SmartPlant Foundation 83
Search for Published PFDs in SmartPlant
Foundation 81
section 373
server 373
Set the Naming Convention for the New
Plant/Area/Unit 56
Setting Up Reports and Orthographic
Drawings 232
shared object definition 374
sharing 374
SI 374
sign off 374
Sign Off Documents in SmartPlant
Foundation 356
site 374
SmartPlant Enterprise 374
SmartPlant schema 374
Software Compatibility 11
status 375
step 375
subscribe 375
Subscription Notification 163
superseded 375
symbology 375
T
TEF 375
terminate 375
timestring 375
title block 375
To Do List 376
token 376
tombstone 376
tool 376
384
U
unit 377
unit of measure list 377
UoM 377
Update the P&ID with Retrieved Data and
New Items 96
user 377
user profile 377
V
vault 377
Verify the 3D Model Data in SmartPlant
Electrical 349
Verifying the 3D Model Publish 227
version 377
View a Pump and Electric Motor Using Aspen
Basic Engineering Explorer 112
view definition 378
View Items Created by To Do List Tasks 155
View Properties for Create Tasks 92
View Published P&IDs in SmartPlant
Foundation 102
View Published PFDs, Datasheets, and
Equipment in SmartPlant Foundation 81
View Shared Equipment in SmartPlant
Foundation 103, 117
View Task Properties in Aspen Basic
Engineering 107
View the Drawing for Published Equipment in
SmartPlant Foundation 84
View the P&ID 128-5001 216
View the Published Strainer Datasheet in
SmartPlant Foundation 120
Viewing the Cable Schedule 330
virtual directory 378
W
Web Portal 378
weighting 378
wildcard 378
Work Breakdown Structure (WBS) 379
Work Process for Creating a Custom PBS
Hierarchy 14
workflow 379
working document 379
Index
Working with Documents in SmartPlant
Foundation 355
X
XML 379
Z
Zoom in on Drawing Items for a Task in the To
Do List 124
385