SPFDesktop Client

SmartPlant Foundation
Desktop Client
User's Guide
Version 2009 R4 and Service Packs
August 2012/March 2013
DSPF1-PE-200041G-UPDATED
Copyright
Copyright © 2002-2013 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
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.
U.S. Government Restricted Rights Legend
Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of
the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813
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.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, 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.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
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.
Portions of the user interface copyright 2012 Telerik AD.
Contents
Preface ........................................................................................................................................................ 17
SmartPlant Foundation Product Documentation .................................................................................. 17
Documentation Comments ................................................................................................................... 22
Welcome to SmartPlant Foundation Desktop Client ............................................................................. 23

Using the SmartPlant Foundation Desktop Client ................................................................................ 23
What's New in SmartPlant Foundation Desktop Client?....................................................................... 24
Version 2009 R4 Service Packs ..................................................................................................... 24
Version 2009 R4 ............................................................................................................................. 24
Version 2009 R3 SP3 ..................................................................................................................... 25
Version 2009 R3 SP2 ..................................................................................................................... 27
Version 2009 SP1........................................................................................................................... 29
Version 2009 .................................................................................................................................. 30
Exploring the Desktop Client User Interface .......................................................................................... 35

Start the Desktop Client ........................................................................................................................ 35
Start the Desktop Client from the command line ............................................................................ 36
Run the Desktop Client from a UNC share .................................................................................... 38
Run the Desktop Client from a URL ............................................................................................... 39
Get to know the Desktop Client user interface ..................................................................................... 39
Toolbar ........................................................................................................................................... 40
Menu bar ........................................................................................................................................ 40
Status bar ....................................................................................................................................... 40
Shortcut toolbar .............................................................................................................................. 41
Tree view ........................................................................................................................................ 41
New Items window.......................................................................................................................... 42
Properties window .......................................................................................................................... 43
Extended view of the Properties window........................................................................................ 44
List view .......................................................................................................................................... 44
List Edit window .............................................................................................................................. 45
Manage windows and forms in SmartPlant Foundation ....................................................................... 46
Learn about the SmartPlant Foundation Desktop Client user profile ............................................. 47
Reset user profile ........................................................................................................................... 47
Change windows options ............................................................................................................... 47
Display or hide a window ................................................................................................................ 49
Automatically hide a window .......................................................................................................... 49
Turn off Auto-Hide mode ................................................................................................................ 50
Dock a floating window ................................................................................................................... 50
Undock a window ........................................................................................................................... 51
Undock a tabbed window ............................................................................................................... 52
Maximize a window ........................................................................................................................ 52
Create tab windows from multiple windows ................................................................................... 52
Display an object in a new window................................................................................................. 53
Collapse sections on forms ............................................................................................................ 53
Use the Shortcut toolbar ....................................................................................................................... 54
Configure the Shortcut toolbar ....................................................................................................... 54
Enable the Shortcut toolbar ............................................................................................................ 54
SmartPlant Foundation Desktop Client User's Guide 5

Contents
Use the Tree view ................................................................................................................................. 54

Show or hide the Tree view ............................................................................................................ 55
Navigate the Tree view ................................................................................................................... 55
Reset the Tree view........................................................................................................................ 56
Use the New Items window................................................................................................................... 56
Add objects to the New Items window............................................................................................ 56
Show or hide the New Items window ............................................................................................. 56
Clear the New Items window .......................................................................................................... 57
Use the Properties window ................................................................................................................... 57
Show or hide the Properties window .............................................................................................. 57
Change the Properties window view .............................................................................................. 58
Use the List view ................................................................................................................................... 58
Change the display of data in the List View ................................................................................... 59
Export the contents of a List View to the default template ............................................................. 59
Export the contents of a List View to the selected template........................................................... 59
Export the contents of a List View to Excel .................................................................................... 60
Export the contents of a List View to a text file .............................................................................. 60
Use the List Edit window ....................................................................................................................... 61
Open the List Edit window .............................................................................................................. 63
Set the date and time in the List Edit window ................................................................................ 64
Configure the list in the List Edit window ........................................................................................ 65
Sort columns in the List Edit window .............................................................................................. 65
Filter items to display ...................................................................................................................... 65
Freeze a column ............................................................................................................................. 66
Export list to Excel .......................................................................................................................... 66
Edit the properties of an object in the List Edit window .................................................................. 66
Create a new object in the List Edit window ................................................................................... 68
Copy and paste in the List Edit window.......................................................................................... 69
Delete an object in the List View window ....................................................................................... 69
Personalize status code colors ....................................................................................................... 69
Resolve conflicts in the List Edit window ........................................................................................ 70
Save lists as documents ................................................................................................................. 72
Get to know keyboard shortcuts ........................................................................................................... 72
User Options .............................................................................................................................................. 75

Set user options .................................................................................................................................... 75
Learn more about setting the active scope .................................................................................... 78
Set the active configuration by roles .............................................................................................. 79
Change user password................................................................................................................... 80
Change user ................................................................................................................................... 81
Look ahead for associations ........................................................................................................... 81
Change the effective date .............................................................................................................. 82
Reset user profile ........................................................................................................................... 82
Change user preferences ..................................................................................................................... 83
Change general user preferences .................................................................................................. 88
Change user preferences for windows ........................................................................................... 90
Display objects in a separate window by configuration .................................................................. 91
Change user preferences for expansion ........................................................................................ 91
Change user preferences for APIs ................................................................................................. 92
Change user preferences for claiming objects ............................................................................... 92
Change default containerIDs for new objects ................................................................................ 93
Change user preferences for 3D viewing ....................................................................................... 93
6 SmartPlant Foundation Desktop Client User's Guide

Contents
Search for Objects ..................................................................................................................................... 95

Searching for objects in the SmartPlant Foundation Desktop Client .................................................... 95
Find an object ................................................................................................................................. 99
Query for an object ......................................................................................................................... 99
Save a query ................................................................................................................................ 100
Run a saved query ....................................................................................................................... 100
Update saved queries................................................................................................................... 100
Edit a previous query .................................................................................................................... 100
Delete a saved query.................................................................................................................... 101
Navigate queries ........................................................................................................................... 101
Find an object using an FTR search ............................................................................................ 102
Learn more about searching for objects in SmartPlant Foundation ................................................... 102
Queries ......................................................................................................................................... 102
Navigating queries ........................................................................................................................ 103
Quick finds .................................................................................................................................... 103
Wildcards ...................................................................................................................................... 103
Symbol and special character searches....................................................................................... 104
Search results ............................................................................................................................... 104
Full-Text Retrieval (FTR) .............................................................................................................. 104
Graphical Navigation ............................................................................................................................... 107

View and mark up files ........................................................................................................................ 107
View items in SmartPlant Foundation Desktop Client .................................................................. 108
Cache 3D model files ................................................................................................................... 108
Cache file types to the SmartPlant Foundation server ................................................................. 108
View and annotate files ....................................................................................................................... 109
View a 2D file ................................................................................................................................ 114
View a 3D model .......................................................................................................................... 114
View an item in a drawing ............................................................................................................ 115
View an item in a model ............................................................................................................... 115
Select a standard isometric or orthographic view ........................................................................ 115
View a connected drawing ........................................................................................................... 116
Use 3D model relationships ......................................................................................................... 116
Place a published P&ID in a 3D model ........................................................................................ 116
Print a 3D model ........................................................................................................................... 117
Lock a Markup file ........................................................................................................................ 117
Unlock a Markup file ..................................................................................................................... 118
View alternate files ....................................................................................................................... 118
View with native application ......................................................................................................... 118
Convert files for navigation ........................................................................................................... 118
3D Navigation Controls ....................................................................................................................... 119
Use Keyboard-Only 3D Navigation .............................................................................................. 120
Use Mouse Only or Mouse + Keyboard Combinations (Fly Mode) .............................................. 122
Use the 3D Navigator ................................................................................................................... 124
3D Navigation Tips .............................................................................................................................. 128
Graphics Card Information .................................................................................................................. 129
Troubleshoot 3D Navigation ............................................................................................................... 130
Checking Hardware Acceleration Settings - Microsoft Vista/Windows 7
Instructions ................................................................................................................................... 132
Checking Hardware Acceleration Settings - Microsoft Windows XP Instructions ........................ 135
Clip volumes........................................................................................................................................ 137
Set a clipping volume ................................................................................................................... 141

Contents
Turn off volume clipping ............................................................................................................... 142

SmartPlant Review with SmartPlant Foundation ................................................................................ 143
Launch SmartPlant Review from SmartPlant Foundation ............................................................ 143
View an item in SmartPlant Review ............................................................................................. 144
View a model in SmartPlant Review ............................................................................................ 144
Build display sets .......................................................................................................................... 144
Create and Modify Objects ..................................................................................................................... 145

Create a new object using the Create wizard ..................................................................................... 148
Create a new object using the Create dialog box ............................................................................... 152
Copy an object .................................................................................................................................... 153
Update an object ................................................................................................................................. 153
Delete an object .................................................................................................................................. 153
Terminate an object ............................................................................................................................ 154
Display details for an object ................................................................................................................ 154
Display the history of an object ........................................................................................................... 154
Change the owning group for an object .............................................................................................. 154
Document Management .......................................................................................................................... 155

Document life cycle ............................................................................................................................. 155
Components of the document model ........................................................................................... 156
Document status icons ................................................................................................................. 158
Create and manage documents in SmartPlant Foundation ................................................................ 159
Create a new design document.................................................................................................... 162
Create a new vendor document ................................................................................................... 165
Reserve a vendor document ........................................................................................................ 168
Activate a reserved vendor document .......................................................................................... 169
Copy a document ......................................................................................................................... 170
Copy the latest revision of a document ........................................................................................ 173
Delete a document ....................................................................................................................... 175
Generate PDF copies ................................................................................................................... 175
Generate view renditions .............................................................................................................. 175
Save alternate renditions .............................................................................................................. 176
Attach a file to a document ........................................................................................................... 177
Copy attached files ....................................................................................................................... 178
Create a new template document ................................................................................................ 179
Check in and check out a document ................................................................................................... 179
Check out a document.................................................................................................................. 183
Cancel a check out ....................................................................................................................... 184
Check out and edit a document in an authoring application ........................................................ 185
Check in a document .................................................................................................................... 188
Sign off on a document ....................................................................................................................... 189
Sign off a document...................................................................................................................... 191
Sign off a document with comments ............................................................................................ 193
Revisions and versions ....................................................................................................................... 194
Revise a document ....................................................................................................................... 196
Insert a historical revision ............................................................................................................. 198
Show all revisions for a document................................................................................................ 198
Show all versions for a document ................................................................................................ 198
Create a snapshot of a document version.................................................................................... 199
Generate a document revision report for a document .................................................................. 200
Purge superseded versions for a document ................................................................................ 200

Contents
Delete a document revision .......................................................................................................... 200

Terminate a document revision .................................................................................................... 201
Comparing documents ........................................................................................................................ 201
View and compare document versions ........................................................................................ 205
Compare document versions ....................................................................................................... 206
Select the layout for the Compare window ................................................................................... 208
Change colors for comparison results .......................................................................................... 210
Change display indicators for comparison results ........................................................................ 210
Change auto-focus options for comparison results ...................................................................... 210
Find a change in the Comparison Results table .......................................................................... 211
Find a selected change in compared drawings ............................................................................ 211
Learn more about the View and Compare window ...................................................................... 212
Archive and purge ............................................................................................................................... 214
Archive files .................................................................................................................................. 215
Review the archive document and archive information files within Desktop Client ..................... 216
Reference files .................................................................................................................................... 216
Learn more about file types for reference files ............................................................................. 219
Update Maintain Relations properties on reference files ............................................................. 220
Update reference relationships .................................................................................................... 221
Show nested reference files ......................................................................................................... 221
View reference files for a document revision ............................................................................... 222
Watermarks and labels ....................................................................................................................... 222
Create a new watermark .............................................................................................................. 223
Attach a watermark to a document............................................................................................... 224
Print a document with a watermark .............................................................................................. 225
Create a new label........................................................................................................................ 225
Attach a label to a document ........................................................................................................ 225
Print a document with a label ....................................................................................................... 226
List documents .................................................................................................................................... 226
Create a new list document .......................................................................................................... 227
Edit a list associated with a list document .................................................................................... 227
Attach the list to an existing document ......................................................................................... 227
Create a list document snapshot .................................................................................................. 227
Create a line list document snapshot ........................................................................................... 228
Relationship Management ...................................................................................................................... 229

Drag objects to create relationships.................................................................................................... 231
View relationships ............................................................................................................................... 232
Update relationship data for an object ................................................................................................ 232
Create, edit, or delete related items in a list edit window ................................................................... 232
Maintain relationships for an object .................................................................................................... 233
Terminate relationships ....................................................................................................................... 235
Use SmartPlant Foundation as an Authoring Tool .............................................................................. 237

Register SmartPlant Foundation as a Tool ......................................................................................... 237
Register SmartPlant Foundation .................................................................................................. 238
Find registered tools ..................................................................................................................... 238
SmartPlant Registration Wizard .......................................................................................................... 238
Data Sheets and Data Lists .................................................................................................................... 241

Edit Microsoft Excel security settings for data sheets and data lists .................................................. 241

Contents
Data Sheets ........................................................................................................................................ 242

Learn about instrument data sheet templates .............................................................................. 244
Manage process cases................................................................................................................. 244
Create a process case.................................................................................................................. 245
Generate and edit an Instrument data sheet (IPD) online............................................................ 246
Generate and edit a data sheet offline ......................................................................................... 248
Load offline data sheets and data lists ......................................................................................... 250
Publish a data sheet ..................................................................................................................... 251
Retrieve a data sheet ................................................................................................................... 253
Partially mapped data sheets.............................................................................................................. 255
Update the data sheet template for partially mapped data sheets ............................................... 255
Document-Managed Data Sheets....................................................................................................... 256
Create a data sheet document ..................................................................................................... 257
Create a snapshot of a data sheet document .............................................................................. 257
Find data sheet documents .......................................................................................................... 258
Query for data sheet documents .................................................................................................. 259
Compare data sheet snapshots ................................................................................................... 259
Publish a data sheet snapshot ..................................................................................................... 260
Enhanced Mechanical Equipment Data Sheets ................................................................................. 261
Learn more about mechanical equipment data sheet options and functionality .......................... 262
Purchase and install enhanced mechanical equipment data sheets for SmartPlant
Foundation .................................................................................................................................... 262
Publish data sheets ...................................................................................................................... 263
Register SmartPlant Foundation (EQD) ....................................................................................... 263
Map file for equipment data sheets .............................................................................................. 264
Data Lists ............................................................................................................................................ 264
Learn about data list templates .................................................................................................... 265
Generate and edit an instrument data list online .......................................................................... 265
Generate and edit an instrument data list offline .......................................................................... 267
Generate a data list from a related object .................................................................................... 268
Create and manage objects in a data list ..................................................................................... 270
Line Lists .................................................................................................................................................. 273

Components of the Line List application ............................................................................................. 273
Line segment ................................................................................................................................ 274
Line list record .............................................................................................................................. 274
Line list ......................................................................................................................................... 274
Line list document......................................................................................................................... 274
List list icons ................................................................................................................................. 275
Integrated line lists .............................................................................................................................. 275
Creating line lists from SmartPlant P&ID data ............................................................................. 276
Using SmartPlant Materials to modify data .................................................................................. 277
Using line lists ..................................................................................................................................... 277
Roll up and consolidate line lists .................................................................................................. 278
Retrieve data into the line list application ..................................................................................... 278
Roll up a line segment .................................................................................................................. 280
Create line lists interactively ......................................................................................................... 281
Modify line list records .................................................................................................................. 282
Create a line list record document................................................................................................ 282
Create a line list document snapshot ........................................................................................... 283
Publish a line list document snapshot to the data warehouse ..................................................... 283

Contents
Reports ..................................................................................................................................................... 285

Ad-hoc reports..................................................................................................................................... 285
Create a new report ...................................................................................................................... 288
View an existing report ................................................................................................................. 291
Run an existing report .................................................................................................................. 292
Define filter criteria for an ad hoc report ....................................................................................... 292
Run a report as a scheduled task ................................................................................................. 295
Terminate a report ........................................................................................................................ 296
Learn more about reporting output styles..................................................................................... 296
Graphic Reports .................................................................................................................................. 298
Create a new graphic report ......................................................................................................... 302
Edit a graphic report definition ...................................................................................................... 304
Modify the symbology of a graphic report .................................................................................... 305
View an existing graphic report .................................................................................................... 307
Select a graphic report to run ....................................................................................................... 308
Apply a graphic report to a model ................................................................................................ 309
Change Notifications ............................................................................................................................... 311

Manage object subscriptions .............................................................................................................. 312
Add an object subscription .................................................................................................................. 312
Update an object subscription............................................................................................................. 314
Remove an object subscription ........................................................................................................... 314
Manage class subscriptions ................................................................................................................ 315
Transmittals ............................................................................................................................................. 317

Learn more about Transmittals ........................................................................................................... 317
Transmittal icons .......................................................................................................................... 318
Transmittal project roles ............................................................................................................... 319
Transmittal life cycle ..................................................................................................................... 320
Transmittal structure ..................................................................................................................... 321
Distribution matrices ..................................................................................................................... 321
Set up transmittals .............................................................................................................................. 322
Create an internal department or office ........................................................................................ 324
Create an external company ........................................................................................................ 325
Create an external department or office for transmittals .............................................................. 325
Create a supplier for transmittals ................................................................................................. 325
Create a contract .......................................................................................................................... 326
Create and manage transmittals ......................................................................................................... 326
Create an internal transmittal ....................................................................................................... 330
Create an external transmittal ...................................................................................................... 332
Create an internal transmittal for a set of documents .................................................................. 333
Create an external transmittal for a set of documents ................................................................. 334
Attach a document to a transmittal ............................................................................................... 335
Assign documents to an issue request......................................................................................... 335
Export a transmittal....................................................................................................................... 336
Copy a transmittal......................................................................................................................... 336
Create a transmittal from a template ............................................................................................ 336
Set the planned date for a transmittal .......................................................................................... 337
Update transmittal recipients ........................................................................................................ 337
Set the controlling recipient for a transmittal ................................................................................ 338
Cancel a transmittal ...................................................................................................................... 338
Terminate a transmittal ................................................................................................................. 338

Contents
Terminate a transmittal section .................................................................................................... 338

View a transmittal structure .......................................................................................................... 338
View a transmittal summary report ............................................................................................... 339
Save a transmittal as a template .................................................................................................. 339
View the transmittal history for a document ................................................................................. 339
Manage transmittal responses for e-mail and paper users .......................................................... 339
Workflows................................................................................................................................................. 341
Learn more about workflows ............................................................................................................... 341
Workflow example ........................................................................................................................ 342
Workflow templates ...................................................................................................................... 345
Workflow status ............................................................................................................................ 345
Working with workflows ....................................................................................................................... 346
Attach a workflow ......................................................................................................................... 349
Delete an attached workflow ........................................................................................................ 349
Put an attached workflow on hold ................................................................................................ 349
Take an attached workflow off hold .............................................................................................. 350
Reject an attached workflow ........................................................................................................ 350
Terminate an attached workflow .................................................................................................. 350
Manage responses to workflow steps for users ........................................................................... 351
View a workflow ............................................................................................................................ 352
Update a workflow ........................................................................................................................ 352
Update users in the Assignment list ............................................................................................. 355
View a workflow details report for a document ............................................................................. 357
View workflow details for a document .......................................................................................... 357
View workflow history for a document .......................................................................................... 357
View a report of overdue workflow steps...................................................................................... 357
To Do List ................................................................................................................................................. 359

Show or hide the To Do List................................................................................................................ 363
Refresh the To Do List ........................................................................................................................ 363
Set the refresh interval for the To Do List ........................................................................................... 363
Show items related to a workflow step ............................................................................................... 363
Show or hide the checklist preview pane in the To Do List ................................................................ 364
Update the checklist for a workflow step ............................................................................................ 364
Acknowledge an information step ....................................................................................................... 365
Claim a step in a workflow .................................................................................................................. 365
Complete a step in a workflow ............................................................................................................ 366
Indicate a step cannot be completed .................................................................................................. 367
Approve a step in a workflow .............................................................................................................. 368
Reject a step in a workflow ................................................................................................................. 369
Reassign a step to another user or role .............................................................................................. 369
Update the description for a workflow step ......................................................................................... 370
Change the duration for a workflow step ............................................................................................ 370
Update workflow.................................................................................................................................. 371
View relationship objects .................................................................................................................... 373
View workflow ..................................................................................................................................... 373
View workflow details .......................................................................................................................... 374
Schedulers and Queue Management .................................................................................................... 375

Scheduler ............................................................................................................................................ 375

Contents
Stop or start a scheduler .............................................................................................................. 376

Query for scheduled tasks ............................................................................................................ 376
Retry a failed task ......................................................................................................................... 377
Load Queue Management .................................................................................................................. 377
Publish documents ....................................................................................................................... 378
View documents in a queue ......................................................................................................... 378
Find published documents ........................................................................................................... 379
Query published documents ......................................................................................................... 379
View a successfully published document ..................................................................................... 380
View published document information.......................................................................................... 380
Access load queues ..................................................................................................................... 380
Query for a published document by queue .................................................................................. 380
Check published document status ............................................................................................... 381
Manage the load queue ................................................................................................................ 382
Retry failed document................................................................................................................... 382
Stop or start load queue ............................................................................................................... 383
Printing in the Desktop Client ................................................................................................................ 385

Print the contents of a List View window ............................................................................................ 388
Print a List View window ..................................................................................................................... 388
Print the contents of a dialog box........................................................................................................ 388
Batch print attached files ..................................................................................................................... 388
Print files to a local printer ................................................................................................................... 389
Integration ................................................................................................................................................ 391

Learn more about working in an integrated environment ................................................................... 391
SmartPlant Enterprise integration methods.................................................................................. 392
SmartPlant Basic Integrator ......................................................................................................... 392
Launch SmartPlant Foundation in an integrated environment ..................................................... 392
Launch SmartPlant Foundation from a command prompt ........................................................... 392
Learn about the Consolidated Data Warehouse .......................................................................... 394
Working with Microsoft Excel .............................................................................................................. 394
Import data from Microsoft Excel .................................................................................................. 397
Import data from Microsoft Excel and compare ........................................................................... 398
Export the contents of a List View to the default template ........................................................... 401
Export the contents of a List View to the selected template......................................................... 401
Export the contents of a List View to Excel .................................................................................. 401
Publish data from Microsoft Excel ................................................................................................ 402
Publish data from Microsoft Excel and compare .......................................................................... 404
Configure export template ............................................................................................................ 407
Comparing documents ........................................................................................................................ 410
View and compare document versions ........................................................................................ 414
Compare document versions ....................................................................................................... 415
Select the layout for the Compare window ................................................................................... 417
Change colors for comparison results .......................................................................................... 419
Change display indicators for comparison results ........................................................................ 419
Change auto-focus options for comparison results ...................................................................... 419
Find a change in the Comparison Results table .......................................................................... 420
Find a selected change in compared drawings ............................................................................ 420
Learn more about the View and Compare window ...................................................................... 421
Comparing published documents ....................................................................................................... 423
Compare published items and work process considerations ....................................................... 424

Contents
Compare design basis objects to the design ............................................................................... 425

Compare design basis documents to the design ......................................................................... 426
Compare with design .................................................................................................................... 427
Correlating items ................................................................................................................................. 427
Correlate items manually after publish ......................................................................................... 429
Correlate items automatically during publish................................................................................ 429
Correlate items from a new tool ................................................................................................... 430
Correlate items from PDS or AVEVA PDMS ................................................................................ 432
View shared objects ..................................................................................................................... 434
Viewing status and history .................................................................................................................. 435
View document history ................................................................................................................. 435
View documents in a queue ......................................................................................................... 435
View documents in load queues ................................................................................................... 436
Use load options ........................................................................................................................... 436
View authoring tools registered with the current plant ................................................................. 437
Revising document ............................................................................................................................. 438
Learn more about revising documents ......................................................................................... 440
Revise a document ....................................................................................................................... 440
Revise a document in SmartPlant 3D .......................................................................................... 442
Use minor revisions in SmartPlant P&ID ...................................................................................... 443
Learn revision scheme behavior through scenarios ..................................................................... 444
Publishing in an integrated environment ............................................................................................. 445
Publish SmartPlant Foundation data ............................................................................................ 446
Query for a published document .................................................................................................. 448
View drawing items in a published document .............................................................................. 449
Allow users to publish documents to a default workflow .............................................................. 450
Learn about publish workflows ..................................................................................................... 450
Understand Load, Consolidated, and MergeDelta tasks.............................................................. 451
Learn more about publishing in an integrated environment ......................................................... 453
Publishing large 3D models in SmartPlant Foundation ...................................................................... 457
Learn more about publishing large 3D models to SmartPlant Foundation .................................. 458
Maintain versions of the composite document in SmartPlant Foundation ................................... 458
Publish the 3D model in SmartPlant 3D or SmartMarine 3D ....................................................... 459
Publish the 3D model in PDS ....................................................................................................... 459
Publish the 3D model to AVEVA PDMS ....................................................................................... 459
Query for a 3D composite document in SmartPlant Foundation .................................................. 459
View the 3D model in SmartPlant Foundation ............................................................................. 459
Create the 3D composite model manually ................................................................................... 459
Add or remove relationships for composite 3D documents.......................................................... 461
Retrieving in an integrated environment ............................................................................................. 462
Learn more about retrieving documents in an integrated environment ........................................ 462
Data handling after retrieval ......................................................................................................... 463
Document types for retrieval ........................................................................................................ 463
Design basis ................................................................................................................................. 465
Retrieve and restore ..................................................................................................................... 465
Retrieve in SmartPlant Foundation .............................................................................................. 465
Concurrent Engineering ......................................................................................................................... 469

Use concurrent engineering ................................................................................................................ 469
Change user preferences for a claim ........................................................................................... 471
Claim an object ............................................................................................................................. 471
Claim an issued document ........................................................................................................... 474
Merge a claimed object into the plant........................................................................................... 474

Contents
Merge a complete configuration ................................................................................................... 475

Unclaim an object ......................................................................................................................... 475
Subscribe to claim notifications .................................................................................................... 475
Resolve conflicts and generate reports .............................................................................................. 475
Compare object to a higher configuration .................................................................................... 476
Resolve conflicts ........................................................................................................................... 477
Generate a configuration report ................................................................................................... 478
Generate a future changes report ................................................................................................ 478
Generate a merge validation report .............................................................................................. 478
Progress ................................................................................................................................................... 481

Calculate progress .............................................................................................................................. 482
Report progress .................................................................................................................................. 482
Progress example......................................................................................................................... 482
Configure the progress model............................................................................................................. 483
Find an existing design workpack or design workpack template ........................................................ 483
Find an existing activity ....................................................................................................................... 484
Find an existing set of progress options ............................................................................................. 484
Freeze plan dates ............................................................................................................................... 484
Redistribute man hours ....................................................................................................................... 484
View progress data ............................................................................................................................. 485
Export progress data to Excel ............................................................................................................. 485
View progress data graphically ........................................................................................................... 485
Loader ....................................................................................................................................................... 487

Create a load file ................................................................................................................................. 488
Process a load file ............................................................................................................................... 489
View and edit XML load files ............................................................................................................... 490
Load offline datasheets and data lists ................................................................................................ 491
XML Format ........................................................................................................................................ 493
XML Instructions ........................................................................................................................... 493
XML Load Formats for Documents .............................................................................................. 496
Attaching Files (XML) ................................................................................................................... 497
NLF Format ......................................................................................................................................... 500
NLF Instructions ........................................................................................................................... 501
NLF Load Format for Documents ................................................................................................. 504
Attaching Files .............................................................................................................................. 505
Field Types for NLF ...................................................................................................................... 506
Relations for NLF.......................................................................................................................... 506
Supporting Relationship Relations ............................................................................................... 507
Data Lists in NLF Format.............................................................................................................. 508
Object Mode in NLF Format ......................................................................................................... 509
NLF Load File Date Examples ..................................................................................................... 510
Transaction Handling .......................................................................................................................... 510
Date Time Handling ............................................................................................................................ 511
CreateConfig Setting ........................................................................................................................... 511
Modes for Load Files .......................................................................................................................... 512
ContainerID ......................................................................................................................................... 512
SuppressENS...................................................................................................................................... 513
Load Errors and Reloading Files ........................................................................................................ 514
Viewing Errors in the Loader ........................................................................................................ 514
Reload Files .................................................................................................................................. 515

Contents
Exception Reports ........................................................................................................................ 516

Command Line Usage for the Loader ................................................................................................. 519
Loader Directory Poller ....................................................................................................................... 520
Run the Loader Directory Poller ................................................................................................... 520
Load File Examples ............................................................................................................................ 521
Data Creation ............................................................................................................................... 522
Perform SmartPlant Foundation Instructions ............................................................................... 522
Design Document Creation .......................................................................................................... 525
Relationship Examples ................................................................................................................. 526
Attaching a File to an Object ........................................................................................................ 527
Attaching a Document to a Workflow ........................................................................................... 528
Glossary ................................................................................................................................................... 529
Index ......................................................................................................................................................... 549

Preface
This document is a user's guide for the SmartPlant® Foundation Desktop Client and provides
conceptual information and procedural instructions for a standard SmartPlant Foundation
installation. The content is the same as the online Help delivered as part of the software.
Depending on the domains and roles you have been assigned, you may or may not see
all the commands and functionality documented here.
SmartPlant Foundation Product Documentation

SmartPlant Foundation documentation is available as Help and as Adobe® PDF files. To view
printable guides for SmartPlant Foundation, click Help > Printable Guides in the software.
Intergraph gives its customers permission to print as many copies of the delivered PDF files as
they need for their non-commercial use. Do not print the PDF files for resale or redistribution.
Installation and Overviews

 SmartPlant Foundation Core Functionality & Enterprise Integration Capabilities Release
Bulletin - Provides information on new SmartPlant Foundation and integration features for
the current release.
 SmartPlant Enterprise Overview - Provides an overview of SmartPlant Enterprise and
integration concepts and data exchange among integrated SmartPlant Enterprise authoring
tools.
 SmartPlant Enterprise Data Exchange Diagrams - Includes full-size graphics that describe
the exchange of data among SmartPlant Enterprise authoring tools. These graphics are also
included in the SmartPlant Enterprise Overview.
 SmartPlant Enterprise Integration Example Guide - Provides an overview of integrating
SmartPlant Enterprise and describes a typical example of full integration within SmartPlant
Enterprise, including publishing and retrieving plant information using SmartPlant authoring
tools and Aspen Basic Engineering™.
 SmartPlant Foundation Installation and Setup Guide - Provides installation and setup
instructions and troubleshooting information for stand-alone SmartPlant Foundation.
 SmartPlant Enterprise Hardware and Software Recommendations - Provides information
about the hardware recommendations and software requirements of the authoring tools that
are part of the SmartPlant Enterprise suite.
 Integration Setup Guide - Provides information about setting up and using SmartPlant
Enterprise products in an integrated environment. Also provides integration troubleshooting
information.
 How to Set Up and Configure SmartPlant Foundation - Provides system administrators with
information on setting up and configuring the SmartPlant Foundation system after all
software has been installed.
 SmartPlant Enterprise Backup and Restore Guide - Provides backup, restore, and
resynchronization procedures for SmartPlant Foundation, SmartPlant Basic Integrator, and
integrated SmartPlant Enterprise authoring tools. The procedures are designed to minimize
data loss and downtime when restoring data in an integrated environment.
 SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the
SmartPlant Foundation and integration software.

Preface
 Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to

the SmartPlant schema and the data model that describes how the SmartPlant schema is
constructed.
 Integration: A Gentle Introduction to SmartPlant Schema Patterns, Process & Practice -
Provides an introduction to patterns in the SmartPlant schema.
 SmartPlant Foundation Licensing Guide - Provides information for installing and configuring
licenses in SmartPlant Foundation.
 SmartPlant Foundation Upgrade Guide - Provides step-by-step instructions for upgrading
from SmartPlant Foundation or SmartPlant Basic Integrator version 2008 and later to the
current version.
 SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring
integrated SmartPlant® Enterprise applications to run in a Citrix environment.
 SmartPlant Foundation Web Portal Samples Overview - Provides a brief overview of the
customization samples delivered with the SmartPlant Foundation Web Portal.
User's Guides
 SmartPlant Foundation Web Portal User's Guide - Provides instructions for using the
SmartPlant Foundation Web Portal.
 SmartPlant Foundation Desktop Client User's Guide - Provides instructions for creating,
viewing, updating, and managing objects and their relationships. Additionally, it provides
information about completing workflow steps and using SmartPlant Foundation in an
integrated environment.
 Integration User's Guide - Provides information about using SmartPlant Enterprise products
in an integrated environment. Also provides a basic understanding of integration and
common integration tasks.
Administrative Guides
 SmartPlant Foundation Server Manager User's Guide - Provides instructions for using
SmartPlant Foundation Server Manager to configure the SmartPlant Foundation server and
to upgrade SmartPlant Foundation databases.
 Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and
extend the SmartPlant schema, view and modify authoring tool mapping, and compare
schema files.
 SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of
mapping between the SmartPlant schema and integrated authoring tools.
 SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to
®
load documents exported from PDS or AVEVA PDMS into the SmartPlant Foundation
database.
 SmartPlant Foundation Administrator's Guide - Provides SmartPlant Foundation
administrators with basic information about how to administer standalone SmartPlant
Foundation.
 Integration Administrator's Guide - Provides information for system administrators on how to
set up and configure an integrated environment.
Troubleshooting Guide
 SmartPlant Foundation Troubleshooting Guide - Contains information about troubleshooting
the installation and configuration of SmartPlant Foundation.

Preface
Model Configuration Guides

 How To Guide Master Table of Contents - Provides a copy of the table of contents of each
"How to" document in the SmartPlant Foundation documentation set. Use this document to
locate the guide that contains a particular topic without opening each "How to" guide to
search for the topic.
 How to Configure the Authoring and Data Warehouse Models - Provides information for
system administrators on how to configure the authoring and data warehouse models in
SmartPlant Foundation and describes the underlying data model.
 How to Configure Classified Objects - Provides information for system administrators on
how to configure classified objects in SmartPlant Foundation and describes the underlying
data model.
 How To Configure the Consolidated Data Warehouse (CDW) - Provides information for
system administrators on how to configure the CDW in SmartPlant Foundation and
describes the underlying data model.
 How to Configure Concurrent Engineering - Provides information for system administrators
on how to configure concurrent engineering in SmartPlant Foundation and describes the
underlying data model.
 How to Configure the Data Sheet Model - Provides information for system administrators on
how to configure the data sheets model in SmartPlant Foundation and describes the
 How to Configure Document Management - Provides information for system administrators
on how to configure document management in SmartPlant Foundation and describes the
 How to Configure the GUI Model - Provides information for system administrators on how to
configure the graphical user interface (GUI) model in SmartPlant Foundation and describes
the underlying data model.
 How to Configure the Infrastructure Model - Provides information for system administrators
on how to configure the infrastructure model in SmartPlant Foundation and describes the
 How to Configure the Line List Model - Provides information for system administrators on
how to configure the line list application in SmartPlant Foundation and describes the
 How to Configure Performance - Provides information for system administrators on how to
enhance the performance of SmartPlant Foundation.
 How to Configure the Progress Model - Provides information for system administrators on
how to configure the progress model in SmartPlant Foundation and describes the underlying
data model.
 How to Configure Reports - Provides information for system administrators on how to
configure reporting in SmartPlant Foundation and describes the underlying data model.
 How to Configure the Security Model - Provides information for system administrators on
how to configure the security model in SmartPlant Foundation and describes the underlying
data model.
 How to Set Up and Configure SmartPlant Foundation - Provides information for system
administrators on how to set up and configure SmartPlant Foundation after install.
 How to Configure the Workflow Model - Provides information for system administrators on
how to configure the workflow model in SmartPlant Foundation and describes the underlying
data model.

Preface
Integration Guides
 SmartPlant Foundation Core Functionality & Enterprise Integration Capabilities Release
Bulletin - Provides information on new SmartPlant Foundation and integration features for
the current release.
 SmartPlant Enterprise Overview - Provides an overview of SmartPlant Enterprise and
integration concepts and data exchange among integrated SmartPlant Enterprise authoring
tools.
 SmartPlant Enterprise Data Exchange Diagrams - Includes full-size graphics that describe
the exchange of data among SmartPlant Enterprise authoring tools. These graphics are also
included in the SmartPlant Enterprise Overview.
 SmartPlant Enterprise Integration Example Guide - Provides an overview of integrating
SmartPlant Enterprise and describes a typical example of full integration within SmartPlant
Enterprise, including publishing and retrieving plant information using SmartPlant authoring
tools and Aspen Basic Engineering™.
 SmartPlant Enterprise Hardware and Software Recommendations - Provides information
about the hardware recommendations and software requirements of the authoring tools that
are part of the SmartPlant Enterprise suite.
 Integration Setup Guide - Provides information about setting up and using SmartPlant
Enterprise products in an integrated environment. Also provides integration troubleshooting
information.
 Integrated Line List Configuration and User's Guide - Provides configuration and user
information for creating, publishing, or retrieving line list documents in SmartPlant
Foundation and SmartPlant Materials.
 SmartPlant Enterprise Backup and Restore Guide - Provides backup, restore, and
resynchronization procedures for SmartPlant Foundation, SmartPlant Basic Integrator, and
integrated SmartPlant Enterprise authoring tools. The procedures are designed to minimize
data loss and downtime when restoring data in an integrated environment.
 SmartPlant Foundation/Integration Architecture Guide - Describes the architecture of the
SmartPlant Foundation and integration software.
 Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to
the SmartPlant schema and the data model that describes how the SmartPlant schema is
constructed.
 Integration: A Gentle Introduction to SmartPlant Schema Patterns, Process & Practice -
Provides an introduction to patterns in the SmartPlant schema.
 Integration User's Guide - Provides information about using SmartPlant Enterprise products
in an integrated environment. Also provides a basic understanding of integration and
common integration tasks.
 Integration Administrator's Guide - Provides information for system administrators on how to
set up and configure an integrated environment.
 Schema Editor User's Guide - Provides instructions for using the Schema Editor to view and
extend the SmartPlant schema, view and modify authoring tool mapping, and compare
schema files.
 SmartPlant Mapping User's Guide - Provides guidelines, procedures, and examples of
mapping between the SmartPlant schema and integrated authoring tools.
 SmartPlant Model Loader User's Guide - Provides instructions for using the Model Loader to
®
load documents exported from PDS or AVEVA PDMS into the SmartPlant Foundation
database.
 SmartPlant Enterprise Citrix Configuration Guide - Provides information on configuring
integrated SmartPlant® Enterprise applications to run in a Citrix environment.

Preface
Intergraph Work Process Guides

Intergraph Work Process guides map the process, power, and marine industries' basic work
processes to SmartPlant Enterprise and SmartPlant Marine Enterprise solutions. This
documentation helps your organization transition from previous work practices to using
Intergraph tools as the new way of executing projects. These documents are available on
http://crmweb.intergraph.com/ https://crmweb.intergraph.com under Product Documentation >
Enterprise Work Processes.
Enterprise Work Processes describe an entire engineering discipline or process at two
different levels, including:
 Providing a swim lane diagram to define the typical roles and high-level processes involved
in a project
 Showing how Intergraph tools are used to produce required deliverables
Integration Capability Statements describe a specific work process among a set of Intergraph
tools, including:
 Explaining the out-of-the-box capabilities of the tools and their recommended use
 Providing a swim lane diagram to show how the tools interact in the work process
 Stating critical requirements and precautions
 Enterprise Work Processes and Integration Capability Statements offer a better
understanding of how Intergraph tools work together and how to adapt the tools to improve
existing work processes.
Programming Guides
To view customization and programming documentation for SmartPlant Foundation and
integration, browse to the ..\SmartPlant\Foundation\< version >ProgrammingHelp folder on a
computer where the SmartPlant Foundation server components are installed.
 SmartPlant Foundation Server Customization Guide - Provides information for developers
on customizing the SmartPlant Foundation Server.
 SmartPlant Foundation Client Customization Guide - Provides information for developers on
customizing the SmartPlant Foundation Client.
 SmartPlant Foundation Web Portal Customization Guide
(SPFWebPortalCustomization.chm) - Provides information about customizing and
configuring the SmartPlant Foundation Web Portal.
 SmartPlant Foundation Web Services Guide - Describes SmartPlant Foundation web
methods used for uploading data from and downloading data to the SmartPlant Foundation
Server.
 SmartPlant Schema Modeling Guide - Provides an introduction to the techniques that were
used to develop the SmartPlant schema and create a data model.
 SmartPlant Adapter Interfaces Reference Guide - Provides information for tool developers
about the interface classes used to communicate data between the authoring tool and the
common user interface and the common user interface and the tool adapter.
 SmartPlant Common UI Interfaces Reference Guide - Provides information for tool
developers about the API exposed through the EFCommonUI.dll, which is used by authoring
tool developers to access integration functionality.
 SmartPlant Metadata Adapter Reference Guide - Provides information for tool developers
about programming the metadata adapter. The tool metadata adapter allows communication
between the SmartPlant Schema Editor and the tool database to manage mapping between
the tool and the SmartPlant schema.
 SmartPlant Schema Component API Reference Guide - Provides information for developers
about the Schema Component API.

Preface
 SmartPlant Enterprise SmartPlant Adapter for SmartPlant Electrical - Describes the

SmartPlant Adapter details, functionality and configuration in SmartPlant Electrical.
 SmartPlant Enterprise SmartPlant Adapter for SmartPlant Instrumentation - Describes the
SmartPlant Adapter details, functionality and configuration in SmartPlant Instrumentation.
 SmartPlant Enterprise SmartPlant Adapter for SmartPlant P&ID - Describes the SmartPlant
Adapter details, functionality and configuration in SmartPlant P&ID.
 SmartPlant Enterprise SmartPlant Adapter for SmartPlant 3D - Describes the SmartPlant
Adapter details, functionality and configuration in SmartPlant 3D.
 SmartPlant Enterprise SmartPlant Adapter for PDS 3D - Describes the SmartPlant Adapter
details, functionality, and configuration in PDS 3D.
Documentation Comments
 Send documentation comments or suggestions to PPMdoc@intergraph.com
mailto:ppmdoc@intergraph.com?subject=documentation comments.

SECTION 1
Welcome to SmartPlant Foundation

Desktop Client
SmartPlant Foundation enables electronic management of all of the plant's engineering
information, integrating data on the physical asset, processes, and regulatory and safety
imperatives.
In This Section
Using the SmartPlant Foundation Desktop Client ......................... 23
What's New in SmartPlant Foundation Desktop Client? ............... 24
Using the SmartPlant Foundation Desktop Client

SmartPlant Foundation provides management of a plant's engineering information,
encompassing the plant's design, configuration, modifications, upgrades, and refurbishment. In
an integrated environment, it allows this data to be shared between applications and users. The
SmartPlant Foundation Desktop Client provides the functionality of the SmartPlant Foundation
client system through a windows-based client.
As a user, based on the software configuration and authorization of the system administrator,
you can perform the following functions:
 Use data sheets to create and manage data. This includes the following operations:
 View the history or information from the database for a specific object
 Update existing objects
 View relationships between objects
 Remove objects or object relationships
 Create new objects and revisions
 Use Document Management to do the following:
 Create and manage documents and their revisions
 Complete steps in workflows
 Use SmartPlant Foundation to interact with the integrated environment
 Plan and report on time-critical activities related to a project
 Use Concurrent Engineering to manage changes to the plant without impacting the as-built
configuration.

The commands and functionality that you see depend on your role and the access
that has been configured for you. You may or may not see all of the commands and functionality
documented here.

Welcome to SmartPlant Foundation Desktop Client
What's New in SmartPlant Foundation Desktop

Client?
Version 2009 R4 Service Packs
If a SmartPlant Foundation 2009 R4 service pack is not listed below, that service pack
has fixes only and no new features. For more information about the fixes included with a
release, see the ReadMe file delivered with the SmartPlant Foundation setup.
Service Pack 1
User
 You can refresh your To Do List with new tasks assigned to you each time you complete a
workflow action, by enabling the Auto refresh/display To Do List option in your user
preferences. Alternatively, disable the Auto refresh/display To Do List option if you only want
the completed workflow action to be refreshed. For more information, see Change user
preferences (on page 83) .
Administration
 You can configure a URL in an e-mail definition to open the To Do List with only steps
relevant to a single item rather than displaying all steps assigned to user. When you type a
URL path in one of the URL boxes in an e-mail definition, the URL hyperlink appears in the
body of the resulting e-mail. When the user clicks the hyperlink in the e-mail message,
SmartPlant Foundation Desktop Client and the To Do List window opens, showing the
workflow steps ready for action for the object in the e-mail message. You can also assign a
method to an object to do this from a context menu in the Desktop Client. For more
information, see Create or Update E-Mail Definition in the How to Configure the
Infrastructure Model guide.
 If you have an existing PDF and you want to regenerate it, you can set the
GenerateAlternateRendition Client API argument (Arg 10) to True. Setting this value to true
allows you to regenerate your alternate renditions. By default, the value is set to False. For
more information, see the How to Configure Document Management guide.
Version 2009 R4
User
 You can drag an existing graphic report into a 3D model. The contents of the graphic report
appear in the 3D model and also populate the Graphic Results window. For more
information, refer to Apply a graphic report to a model (on page 309).
 You can drag a published 2D drawing onto a displayed and published 3D model. Matching
2D items highlight and also appear in the Graphics Results window. For more information,
refer to Place a published P&ID in a 3D model (on page 116).
 The Delete local files option on the Attach File dialog box has been updated. Any time you
clear the Delete local files option, the selection is stored in the local system to be used as
the default the next time you access this dialog box. Users can change their preference at
any time by selecting this option. For more information, see Create and manage documents
in SmartPlant Foundation (on page 159).

 The FTR bulk indexing utility incrementally indexes a set of particular objects you select,
filtered by class definitions, classifications, file types, FTR filters, or configuration items.
 The FTR Report can display the FTR indexing status (Indexed, Failed To Index, and Not Yet
Indexed) with filters by class definitions, configuration, and file type.
Administration
 The SmartPlant® Foundation Consolidated Data Warehouse (CDW) functionality has been
enhanced for publishing data: the CDW domain now has its own CDW domain group with its
own set of database tables. The CDW schema is configurable, but all the class definitions
must realize a minimum set of interface definitions. For more information, see The CDW
Object Schema in the How to Configure the Consolidated Data Warehouse guide.
 The paging toolbar can be configured to display the Show All button and honor query limits.
For more information, see Configure Paging Queries in the How to Configure the GUI Model
guide.
 SmartPlant Foundation now provides a Performance Test tool available from the
Administration menu to identify performance issues. For more information, see
Performance Benchmark Tests in the SmartPlant Foundation Troubleshooting guide.
 You can see the amount of time taken to perform the Look Ahead action for each submenu
item in the Desktop Client by setting the debug level in the settings.xml file to 2 or greater.
When this debug level is set, the time required by the Look Ahead operation is displayed
next to items in the submenu. For more information, see Look Ahead Displaying Time to
Retrieve Relationships in the SmartPlant Foundation Troubleshooting guide.
 Server tracing output is available to show the time taken to populate combo box controls on
display items. The number of items retrieved and the amount of time required is recorded in
the log file. For more information, see Logging the Time Required to Populate a Combo Box
in the SmartPlant Foundation Troubleshooting guide.
 SmartPlant Foundation 2009 R4 is not supported on Windows Server 2003. For more
information, see SmartPlant Foundation Hardware and Software Recommendations in the
SmartPlant Foundation Installation Guide.
Version 2009 R3 SP3

User
 Users have access to an updated load queue which allows the users to view the status of a
published document and manage the statuses of the load into the data warehouse. Users
can view all documents in a queue or filter to view documents published to a specific queue.
For more information, see Load Queue Management (on page 377) in the Desktop Client
Help.
 You can configure the Paging toolbar to display on the List View window in SmartPlant
Foundation. The toolbar allows you to retrieve queried and Quick Find menu information with
only the first page appearing when the search is complete. The records appear in an
alphabetically sorted list view, sorted by name. For more information, see Navigate queries
(on page 101) in the Desktop Client Help.
 You can configure and access a shortcut menu from a toolbar by selecting an item in the
SmartPlant Foundation Desktop Client window. By default, the shortcut toolbar appears with
Details and History buttons beside the Find box. For more information, see Use the Shortcut
toolbar (on page 54) in the Desktop Client Help.

 To identify when a step in the workflow is auto completed or is completed by the user, an
additional workflow status, Auto Signed Off, displays on the workflow graphical viewer
window. For more information, see Auto Signed Off in the Desktop Client Help.
 Special characters and symbols (%, *, ? which are true by default, and _ which is false by
default) can be used within the name of an object. When searching objects with symbols or
special characters embedded in the name, a \ must be added to the search criteria
immediately in front of the special character. If the \ character does not precede the special
character in the search, the special character is used as a wildcard. For more information,
see Search for Objects (on page 95) in the Desktop Client Help.
 By first selecting Modeless Forms on the Windows tab, multiple windows can be opened
at the same time from the List Edit window. For more information, see Change user
preferences for windows (on page 90) in Desktop Client Help.
 You can update Date and Date/Time properties by double-clicking any date box (Creation
Date, Last Updated, and so on) in the List Edit window. The Set Date dialog box appears
for all date options in the List Edit window. The current date appears in all options when the
user opens the List Edit window. Dates can be changed by using copy/paste, typed
manually, or selected from a dialog box. Time is added in combination with the date when
selecting from the Set Date dialog box. For more information, see Set the date and time in
the List Edit window (on page 64) in Desktop Client Help.
Administration
 The three SmartPlant Foundation schedulers, Main, Publish and Report, have been
reconfigured to poll at less frequent intervals. The interval, which previously polled at 30
seconds, will poll at 10 seconds to reduce processing time. Also to increase efficiency in the
polling process, the default maximum number of parallel running threads can be set by the
administrator. See Configure the Scheduler Polling Intervals and Running Threads in How
To Configure the Infrastructure Model guide. For custom code, see Configuring the Polling
Interval in SmartPlant Foundation Server Customization guide.
 Administrators can configure paging queries by using the common method, Argument 11,
which was added to the Client API for QFindObject, QueryObject, QueryClassObj, and
QueryClassObjFromClass, For additional information, see Common Methods in How to
Configure the GUI Model guide and Navigate queries (on page 101) in the Desktop Client
Help.
 You can configure a shortcut menu from a toolbar by selecting an item in the SmartPlant
Foundation Desktop Client window. By default, the Shortcut toolbar appears with Details
and History buttons beside the Find box. Any existing shortcut menu method can be added
to the toolbar by updating the method and entering the shortcut icon and/or display text.
When a user logs into the Desktop Client, the software retrieves all methods that have these
properties populated and are accessible to the user through their role. The shortcut tool bar
is context-sensitive in that it only displays methods that are configured on the selected
objects. For more information, see Shortcut Menu Toolbar in the How to Configure the GUI
Model guide.
 Administrators can unclaim a claimed item by using the shortcut menu or by configuring the
XML code. See XML Instructions (on page 493) in the How to Setup and Configure
SmartPlant Foundation guide.

Version 2009 R3 SP2

User
 The Documents with Markups report is now available when using the Files > New >
Report command. This report displays all documents that have markups. Also, all
available details about each markup displays. For more information about reports, see
Reports (on page 285) in the Desktop Client help.
 When viewing a master file with the View and Markup command, you can now view its
nested references. For more information, see View and mark up files (on page 107) in the
Desktop Client help.
 A Details section has been added to the Attach File dialog box for viewing file property
details. For more information, see Attach a file to a document (on page 177) in the Desktop
Client help.
 The Save Alternate Renditions dialog box now offers the ability to select multiple
renditions. For more information, see Save alternate renditions (on page 176) in the
 The Show Workflow Objects command allows you to see items related to a workflow, such
as documents or transmittals. You can also see items related to a workflow across multiple
plant configurations. See Show items related to a workflow step (on page 363) in the
 The Undo Sign Off command allows you to revert a “Current” document back to a
“Working” document. For more information, see Undo a document sign off in the Desktop
Client help.
 The Undo Checkout dialog box now shows checked out reference files along with their
master file so that their check out can be canceled along with the master. See Cancel a
check out (on page 184) in the Desktop Client help.
 The Purge superseded versions command allows you to purge all superseded versions
for a document. Purging database files is also supported, so you can also purge CMF
versions to further conserve space. For more information, see Purge superseded versions
for a document (on page 200) in the Desktop Client help.
 The Export a Transmittal (online) command allows you to export an object structure, such
as a transmittal or document, to the local file system, creating a folder structure that
corresponds to the object structure. For more information, see Export a transmittal (online) in
the Desktop Client help.
 You can print files to a local printer with the Print Files (Local) command. For more
information, see Print files to a local printer (on page 389) in the Desktop Client help.
 When printing a file, you can now select the paper size as one of the printing options. Also,
you can also set options for multiple file/printer combinations in the Batch Print dialog box.
For more information, see Batch print attached files (on page 388) in the Desktop Client
help.
 The Save Target As command now supports multi-select operations with documents and
files. For more information, see Copy attached files (on page 178) in the Desktop Client
help.

Administration
 Excel spreadsheet data can now be published directly into the SmartPlant Foundation data
warehouse. For more information on using Excel to publish data, see How to Configure
Excel Publish in the How to Configure the Authoring and Data Warehouse Model guide. For
information on loading data from Excel, see Excel Import in the How To Setup and Configure
SmartPlant Foundation guide. For information on creating and configuring the data list
definition and Excel template that support this process, see New Data List Example in the
How To Configure the Data Sheet Model guide.
 Excel import/publish supports the loading/publishing of UOM data in a variety of ways,
based on the data's position in the spreadsheet. For information on how to load/publish
UOM data in Excel, see New Data List Example in the How To Configure the Data Sheet
Model guide.
 A new diagnostic tool, the Diagnostic Tool Framework, has been included to gather
system and configuration information. The tool performs tasks such as checking the versions
of installed DLL files, testing the file service, reporting IIS application pool settings, reporting
database information, and other configuration tests and reports that can assist in diagnosing
issues on a server. The Diagnostic Tool Framework is available from eCustomer.
 Several reporting enhancements have been made to improve performance. Ad hoc reports
can be run as a background process via a dedicated report scheduler. The report scheduler
can also be configured to run on a separate server. For more information, see Report
Configuration in the How to Configure Reports guide or Configure the Scheduler on an
Alternate Server in the How to Configure the Infrastructure Model guide.
 Performance enhancements include ad hoc reporting performance improvement via
reduced database access, improved Desktop Client loader and published document loader
performance, and faster query response. Scalability has been improved to include full 64-bit
server support for the SmartPlant Foundation core server.
 SmartPlant Foundation allows objects to branch to a certain step in a workflow based on a
condition specified in the step class and step definition. For more information, see
Condition-Based Workflow Branching in the How to Configure the Workflow Model guide.
 Classified items, such as equipment tags, can already have different forms configured to
display different sets of properties at different nodes of the classification tree. This same
capability is now available for the column set that configures the list view by relating column
sets to the nodes of the classification tree. The quick find command can still be configured to
override this and use a specific column set for the method. For more information, see
Cumulative Column Sets on Classified Objects and Overriding Cumulative Column Sets for
Quick Find in the How to Configure the GUI Model guide.
 The Details and Update forms for an object can be configured to display relationship data
on tabs. In the delivered system, the Details forms for the administration items access
groups, roles, column sets, menus and methods are configured to display tabs. The Update
forms for the administration items organizations, vaults, and printers are configured to
display tabs. The Update form's relationship lists also support relationship management and
list editing of related items. For more information, see Update Relationship Data for an
Object (on page 232) in the Desktop Client User's Guide and Configure Relationship Tabs
on Forms in the How to Configure the GUI Model guide.
To display some new functionality in your upgraded site, you will need to regenerate
several of your out-of-the-box forms. For more information, see Regenerate Forms after
Upgrade in the SmartPlant Foundation Upgrade Guide.
 A new form purpose, “Attach File,” has also been added, and sections configured with this
form purpose are displayed on Attach forms. For more information, see Create Form
Sections in the How To Configure the GUI Model guide.

 Inconsistency reports on shared objects using Excel templates are now available. For more
information about using these reports, see Viewing Inconsistency Reports in Excel in the
SmartPlant Desktop Client help. For more information about configuring these reports, see
Configuring Data Warehouse Inconsistency Reports in the How to Configure the Authoring
and Data Warehouse Models guide.
 A new argument Show nested dialog (True/False) has been added to the Navigate client
API to allow for showing the nested reference file for a master file when performing the View
and Markup command for an object. Setting this argument to True displays the nested
reference structure for an object's master file, if it exists. If set to False, a flat structure
showing only the master files is displayed. For more information, see Configure Markups in
the How to Configure Document Management guide.
 For users who need to receive the files attached to documents in an object like a transmittal,
but who are not users in SmartPlant Foundation, you can now export these files’ object
structure to the local file system so they can be distributed on another medium, such as a
CD or DVD. For more information, see Configure Export Object Structure in the How To
Configure Document Management guide.
 Watermarks and labels can be defined on print and PDF generation methods (for support of
default "uncontrolled copy" watermarks, for example). Text substitution of object properties
and related data for status labels is also supported. For more information, see Watermark
and Label Model in the How to Configure Document Management guide.
 PDF files now can be generated to include redlines. For more information, see Configure
PDF Generation in the How To Configure Document Management guide.
 Web services now can be configured to import and export data via third-party applications.
 When bulkloading historical data using the Desktop Client Loader, you can override the ENS
functionality so that you can specify names for objects in the load files. For more information,
see SuppressENS (on page 513) in the How to Setup and Configure SmartPlant Foundation
guide.
 The Audit domain is no longer installed with SmartPlant Foundation. The Audit History and
Hot Fix Report functionality is also no longer installed. With the Audit domain absent from
the database, system performance improves: loading schema from the database is faster,
and any queries that are not tied to a specific domain run faster. If you upgrade a database,
the Upgrade Wizard does not remove the Audit domain from existing installations, so it must
be removed manually. If you would like to remove the Audit domain from your upgraded
database, follow the directions in the ReadMe file located in RemoveAuditDomain folder
(for example, browse to C:\Program Files\SmartPlant\Foundation\2009\Database\Database
Scripts\RemoveAuditDomain). For more information, see Remove Audit Domain from an
Upgraded Database in the SmartPlant Foundation Installation and Setup Guide.
Version 2009 SP1

User
 Users can now export the contents of any list view to a text file using the File > Extract to
Text File command. For more information, see Export the contents of a List View to a text
file (on page 60) in the Desktop Client Help.
 The Warning dialog number and Maximum query limit settings in the Change User
Preferences dialog box also apply when you right-click an object and display relationships
or relationship edges. Using these settings allows you to improve performance by limiting
the number of objects returned during an expansion. For more information, see Change
general user preferences (on page 88) in the Desktop Client Help.

 When SmartPlant Foundation republishes line list documents, delete instructions are now
published in a tombstone file. If a line list record is found to be terminated, a delete
instruction for the record is published. If a line list record has been flagged to be excluded
from the line list or if a line list record is found to be no longer related to the line list, a delete
instruction for the relationship between the record and the document is generated and
published. For more information, see Line Lists (on page 273) in the Desktop Client help.
 A new Turn off look ahead on filtered and multi-path relationship (edge) expansion
option in the User Preferences dialog box allows you to turn off the look ahead feature on
shortcut menu options that apply to relationships that traverse multiple objects (using
edges). Turning off this option can improve performance for shortcut menu displays because
the Desktop Client queries the database for less information when you right-click an object.
For more information, see Change user preferences for expansion (on page 91) in the
Desktop Client Help.
 Users can now print 3D models. For more information, refer to Print a 3D model (on page
117) the Desktop Client Help.
Administration
 The Manage Related Items and similar dialog boxes now support landscape and portrait
pane orientation. See Manage Related Items in How to Configure the GUI Model for more
information.
 Data sheet templates now support unmapped data. Users can enter data in cells that are
not mapped to SmartPlant Foundation schema, and the data is saved when the data sheet
is regenerated. See New Data Sheet Example in How to Configure the Data Sheet Model for
more information about how to configure data sheets that support unmapped data.
 Administrators can now use the Navigate Schema tab to create column items on the
Manage Column Items and Manage Column Items for Edit dialog boxes. This new tab
allows you to select a property definition, edge definition, or relationship definition, create a
column item, and add it to the column set. For more information, see Create Column Set
Items Using the Schema Navigation Tab in How to Configure the GUI Model.
 Administrators are now able to off load the scheduler service to a separate server or to
another CPU of the main server, freeing up resources for the core SmartPlant Foundation
processes. For more information, see Configure the Scheduler on an Alternate Server in
How to Configure the Infrastructure Model.
Version 2009
User
 The ability to create, maintain, and integrate line lists has been added. The Line List
Application in the Desktop Client allows piping engineers, other project engineers, and
managers to manage key information associated with piping systems as line lists. The
SmartPlant Foundation line lists functionality can be used in a number of ways within
SmartPlant Enterprise, both stand-alone and integrated. When integrated, the line list
functionality retrieves the piping data (typically from SmartPlant P&ID), including the
connected equipment and instrumentation, and generates the line list structure that reflects
the rollup of the more granular line list segments (pipe runs). In integrated mode, a
document containing updated line information can be issued and published back to the data
warehouse for use in the enterprise.
See Line Lists (on page 273) for more information about using the Line List Application.

See the administration guide How to Configure Line Lists for more information about
configuring and administering the line list functionality.
 The List Edit window has been added to the Desktop Client. The List Edit window allows
users to sort and configure lists of data and export them to Excel or save the list as a
document. The List Edit window is also used to manage list documents, and the List Edit
window can also be configured to be opened from a command from the list document's
shortcut menu. See List Edit window (on page 45) and List Documents (on page 226) for
more information.
 When you drag and drop an object onto multiple objects that include some similar objects,
you can use the Apply to similar items check box in the New Relationship dialog box to
determine whether the relationship you select in the Relationship column applies to all
similar objects. Similar objects have a background color to identify them. This new
functionality allows to create multiple relationships at the same time with one drag and drop.
 New visual feedback has been implemented to windows in the Desktop Client, making the
windows easier to undock, move, and dock. See Manage windows and forms in SmartPlant
Foundation (on page 46) for more information.
 You can change the appearance of the windows in the Desktop Client by choosing a visual
style. See Change general user preferences (on page 88) for more information.
 The Query > Published Documents command allows you to perform a detailed search
based on object properties for published documents. See Query for a published document
(on page 448).
 You can now publish objects to a correlate workflow from a tool that has been used to
modify data for your plant, but the tool was just added to the integrated environment. See
Correlate items from a new tool (on page 430).
 Publishing a document to the Auto-Correlate workflow now compares the objects in that
document to the objects that are already in SmartPlant Foundation. If an object in the
document that you put in Auto-Correlate can correlate through objects using one shared
object class, Auto-Correlate automatically correlates the objects. However, if an object can
correlate with objects using more than one shared object class, Auto-Correlate puts a task
in the To Do list to allow you to pick the correlation. See Correlate items automatically
during publish (on page 429).
 To make publishing 3D models more efficient, the SmartPlant 3D or SmartMarine 3D user
now publishes models in distinct, non-overlapping file sets to any SmartPlant Foundation
workflow. For example, you publish these object sets using a workflow based on the
AutoLoadPublishWithMerge workflow. This workflow has MergePublishedFile process
step configured. This step creates the 3D document, loads the 3D data in SmartPlant
Foundation, then merges these file sets into a new composite document that represents the
entire 3D model.
 The functionality to support markups on Navigation files has been enhanced.
You can create snapshots of certain types of document versions, typically in preparation for
publishing a document from SmartPlant authoring to the data warehouse or as part of the data
sheet feature. Creating a snapshot generates an Excel view file and an XML data file.
Snapshots provide a view of the document data at the time the snapshot was created. For
example, creating a snapshot of a document allows users to publish a particular approved
version of the document to the data warehouse. When you create the first snapshot of a version,
the software creates and attaches new electronic files that contain the data associated with the
document. When you create additional snapshots, the software creates a new version of the
document and attaches updated copies of the electronic files with the current data from the
database, typically an .xml file with the data from the database and a viewable .xls file.
Snapshots can also be compared to other snapshots to view differences.

By default, snapshot functionality is available for data sheets and list documents.
 To perform case sensitive quick finds, in which the software searches for objects that match
the case of the text you type, check the Case sensitive quick find option in the Change
User Preferences dialog box.
 When you create, copy, or revise a publishable document in the authoring domain,
SmartPlant Foundation automatically reserves a revision for that document in the data
warehouse domain. This functionality keeps the revision details in the authoring domain and
the data warehouse synchronized for the same revision of a document.
 The Clip Volume command has been added, which includes a 3D wireframe box that can
be manipulated to limit the objects that can be seen in the view.
 The 3D Navigator control has been added, which supports the common navigation
movements you can perform with the mouse and keyboard such as look and move.
Additionally, it contains the Select, Home, and Fit navigation commands.
Administration
 Administrators can now choose how to display login names and user names in the Desktop
Client for three different parts of the user interface:
 Tree views - By default, tree views display both the user name and login name. You can
modify the SPFLoginUserTreeDisplay column set to change the display.
 List views - You can change the display of user names and login names by modifying
SPFLoginUserColumnSet.
 Tables and other parts of the user interface - For other parts of the Desktop Client user
interface, administrators can change the display of user names and login names by
changing the Login user display option on the SmartPlant Foundation Options
dialog box. For more information, see Displaying User Names and Login Names in How
to Configure the Infrastructure Model.
 New SetVendorDocDueDate and SetVendorDocPlannedReturnDate workflow process steps
are available to set vendor document return dates and status. For more information, see
Default Workflow Templates in How to Configure the Workflow Model.
 Administrators can configure the sort order for tree views, list views, and the New Items
window by modifying the Sort Sequence and Sort Order for any column set in the Manage
Column Items dialog box. For example, you can configure design documents to
automatically sort on Revision and Version in both the list view and tree view using these
options on the appropriate column sets. For more information, see Configuring Automatic
Sorting Using Column Sets in How to Configure the GUI Model.
 Administrators can use the List Management Console to configure lists that will be edited
and maintained in the List Edit window of the Desktop Client. The List Edit window can
also be configured to create and maintain list management documents. See List Editing in
How to Configure the GUI Model and Documents that Manage Lists and List Management
Document Configuration in How to Configure Document Management.
 The creation and validation of conditions in SmartPlant Foundation have been improved.
 Two new standard conditions are supported in SmartPlant Foundation: ANY and ALL.
ANY indicates that the condition is satisfied if any of the identified items satisfy the
condition. ALL indicates that the condition is only satisfied if all of the identified items
satisfy the condition.
 New date and time functions, a UOM function, and condition constants, including days
of the week and control constants have been added.
 The new Validate Conditions command is available in the Desktop Client for validating all
conditions in the database. Validate Conditions generates a report showing the details of

all conditions, and whether they failed or were successful. For more information about
condition validation and correction, see Creating Conditions in How to Configure the GUI
Model.
 ENS definitions can now be configuration dependent.
 Two new file service settings,Cached File Extensions and Days Before Cache Cleanup,
are available in SmartPlant Foundation Server Manager. These settings allow you to specify
types of files to cache when they are opened in the Desktop Client. Caching information
instead of opening and decompressing the files every time you view them reduces the time it
takes to view large files. See Modifying File Service Extensions in the SmartPlant
Foundation Server Manager User's Guide for more information.
 Full Text Retrieval now supports internationalization in a homogeneous environment.
 PDF generation configuration has been enhanced so that all the supported file types
generate a PDF in a single step.
 Compare scope options have been added to the Excel Import Wizard.


SECTION 2
Exploring the Desktop Client User

Interface
The following topics describe how to open and exit the SmartPlant Foundation Desktop Client
and provide an overview of major features in the Desktop Client user interface.
Start the Desktop Client

SmartPlant Foundation offers several ways to get started.
When SmartPlant Foundation opens, you will be asked to log on. From the Logon Information
dialog box, you can add or change a server name for logging on to the Desktop Client.
Logon Information dialog box

Allows you to log on to the SmartPlant Foundation Desktop Client.
User name - Type your SmartPlant Foundation user name.
Password - Type the password for your user account.
Server - Select the name of the SmartPlant Foundation site connection to which you want to
connect. You can also add a new site connection or edit an existing one by clicking Options and
then clicking Edit or New.
 If you have only one site connection in your Server list, and Windows authentication is set
up on that server, you will be logged in automatically if your Windows user name is valid for
that SmartPlant Foundation site.
If you have more than one server in your list and Windows authentication is set up on your
server, even though your Windows user name is valid in the site, your user name and
password will be unavailable on the Logon Information dialog box. Click OK to log on
using your Windows user name and password.
 If your system is configured for automatic logon, then the software automatically logs you on
to SmartPlant Foundation using your Windows user name when you open the Desktop
Client. This feature is not available if you start SmartPlant Foundation from an authoring tool.
 Alternatively, you can launch the Desktop Client from a URL. There are several optional
parameters that you can add to the logon URL. These parameters should be separated with
an ampersand (&).
Parameter Description
user= The user name assigned by the system administrator.
password= The password assigned to the user name.
project= The project to open when the software starts.
class=userinbox Displays your To Do List.
For example:
http://nodename/directory/SPF.asp?user=jqpublic&password=MyPassword&class=userinbox

Exploring the Desktop Client User Interface
New Server/Edit Server dialog box

Allows you to add or change a server name for logging on to the SmartPlant Foundation
Desktop Client.
Name - Type a meaningful name for the server. This name will appear in the Server list on the
Logon Information dialog box.
Web host - Type the actual server name of the Web host computer where the SmartPlant
Foundation server is located.
Web directory - Type the name of the virtual directory on the Web host. You can also use the
SmartPlant Foundation site name.
Secure channel (SSL) - Check this option if the server connection is to be accessed by SSL.
SSL is set up on the server.
Trusted site - Select this option if you are running in a non-domain account environment. This
will cause you to be prompted for domain credentials when you log on.
Delete - Select a server that you want to remove from the Server list in the Logon Information
dialog box, and click Delete. (Edit Server dialog box only)
Validate - Click to test the connection to the server.
What do you want to do?

 Start the Desktop Client from the command line (on page 36)
 Run the Desktop Client from a UNC share (on page 38)
 Run the Desktop Client from a URL (on page 39)
Start the Desktop Client from the command line

1. Open a Command Prompt window.
2. In the Command Prompt window, change directories to the product directory, for example:
c:\Program
Files\SmartPlant\Foundation\2008\SPFDesktopClient\CurrentVersion.
3. Type the following command: DesktopClient.exe /SINSTANCE True /u <username>
/p “” /s <servername>
When launching the Desktop Client from the command line, all parameters that begin
with a slash ( / ) are uppercase and require a space between the parameter and the value. If the
value contains spaces, it must be enclosed inside double quotation marks (“ ”), as shown in the
following example.
Logon Parameters
U User name
P Password

PLANT Plant name
PROJECT Project name
H Host
S Server name (as defined in the logon dialog box)
W Web directory
CURRDIR Current directory
SECURE True/False: if logging on to server using SSL
DEBUGLOG Path and file name for a debug file. This parameter is only
valid for URLs.
The following details logon parameter behavior, depending on what you specify in the command
line or URL. The following are provided in command line format. They can also be used in the
URL format.
/U /P /PLANT /PROJECT /S
Logs you in as the user specified with the plant/project specified on the given server if the server
is not authenticated. The user and password are ignored if the server is authenticated. If the
server is authenticated, the Logon dialog box appears with the User name and Password
boxes disabled, and the Server list to select the correct server.
/U /P /PLANT /PROJECT /H /W
Same as the previous example, but uses the host and web directory instead of the server.
/U /P /PLANT /PROJECT
A Logon dialog box appears with the User name and Password boxes populated.
/S /PLANT /PROJECT
If the server is authenticated, this command logs you on to the Desktop Client. Otherwise, the
Logon dialog box appears with the Server list disabled, but displays the specified server.
If the server specified is not defined, a message box appears to inform the user, and the logon
process stops.
/H /W /PLANT /PROJECT
Same as the previous example except that if the specified Web host and Web directory have not
been defined, a new server is created from these. If the new server is authenticated, this logs
you on. Otherwise, the Logon dialog box appears with the Server list disabled, but displays
the specified server.
/PLANT /PROJECT
Displays the Logon dialog box, but once you select a server and log on, the specified Plant and
Project is honored.
 If you do not specify any command line parameters, the Logon dialog box appears.
 If you select an authenticated server from the list, the User name and Password boxes are
disabled. They are enabled if you select a server that is not authenticated.
 If a server is not responding, a message box appears to tell the user, and the OK button is
disabled. The OK button is enabled if you select another server that is responding.
 When using the /SECURE switch, you may need to adjust the timeout setting in your
web.config file to keep the login attempt from timing out while the secure login is processing.
If this occurs, add or edit the following key in the web.config file with the following value:
<add key="IsResponding.Timeout" value="600" />.

 The logon parameters are case-sensitive.

Examples
Desktop_Client.exe /U abc /P /S SPF42
Desktop_Client.exe /U abc /P /PLANT Plant1 /PROJECT Project1 /S SPF42
For more information about starting the Desktop Client from a command line, see Desktop Client
Command Line Parameters in the SmartPlant Foundation Installation and Setup Guide.
Run the Desktop Client from a UNC share

Running the Desktop Client from a share requires that the client assemblies, help, and icons
exist in the server share.
1. Create the new directory to be shared (for example: SPFDesktopClientRemote).
2. Copy the following contents into the new shared folder on the host computer with Desktop
Client installed.
 Copy all files and subfolders in the \Program
Files\SmartPlant\Foundation\2009\SPFDesktopClient folder.
 Copy the \Program Files\SmartPlant\Foundation\2009\Icons folder.
 Copy the \Program Files\SmartPlant\Foundation\2009\BitmapsMisc folder.
3. Right-click the SPFDesktopClientRemote share and select Sharing and Security.
4. Click the Security tab, and give Read permission to the users who will access the share.
5. Click the Sharing tab, click Share this folder, and then click Permissions.
6. On the Share Permissions tab, give Everyone Read access to the share.
 The copied and shared directory structure should have no less than what is shown below:
 The CurrentVersion folder contains the client assemblies, so the path to the executable
would be similar to this:
\\<SPFServer>\<SPFDesktopClientShare>\CurrentVersion\Desktop_Client.exe
where <SPFDesktopClientShare> is the name of the share.
 For information about parameters for launching the Desktop Client, see Desktop Client

Run the Desktop Client from a URL

The SPFLaunch.exe command allows users to run the Desktop Client from a URL. By default,
this command can be accessed using the following syntax:
http://server_name/virtual_directory/DesktopClient/Apps/SPFLaunch.exe.
 Before you can run the software using a URL, you must:
 Have a valid client installation, either local or UNC install.
 Start the Desktop Client manually to create the settings.xml file in the C:\Documents
and Settings\[YourUserName]\Application Data\SmartPlant\Foundation\[version] folder.
Then, when you use the SPFLaunch.exe command, the settings.xml file is updated to
include an entry for the local computer.
 Set the Execute Permissions for the virtual directory to Scripts only.
For information about parameters for running the Desktop Client from a URL, see
Desktop Client Command Line Parameters in the SmartPlant Foundation Installation and Setup
Guide.
Get to know the Desktop Client user interface

The first time that you open the SmartPlant Foundation Desktop Client, the software displays the
standard Desktop Client user interface, including a Tree view that contains the hierarchy used to
navigate data. The menus, toolbars, and shortcut menu commands available in the Desktop
Client vary depending upon the access assigned to you by your system administrator.

When you exit the Desktop Client, the software saves a user profile that contains information
about the windows, configuration, and other user interface settings.
What do you want to know?

 Toolbar (on page 40)
 Menu bar (on page 40)
 Status bar (on page 40)
 Shortcut toolbar (on page 41)
 New Items window (on page 42)
 Tree view (on page 41)
 Properties window (on page 43)
 List View (on page 44)
 List Edit window (on page 45)
Toolbar
The toolbar contains icons for commonly used commands. You can click the icons instead of
using the commands on the menus.
The SmartPlant Foundation toolbar includes a Quick Find tool that lists all the Quick Find
methods that you have access to through your user role permissions as defined by your system
administrator.
Quick Find allows you to search on an object's name, part of the name, or a combination of the
name and the valid wildcard characters (for example, n%).
Menu bar
Click the name of a menu to display the menu commands.

The menus available in the Desktop Client are configured by your system administrator
and depend on your user role.
Status bar
The status bar displays the current settings for roles, query configurations, create/update
configurations, effective date, and user. You can change any of these settings, except the user,
by clicking the current setting in the status bar. For more information, see Learn more about
setting the active scope (on page 78) for more information about selecting roles and
configurations.
The effective date defines a time period for viewing historical data. By changing the effective
setting to a date in the past, you can examine the data that was valid on that date. For more
information, see Change the effective date (on page 82).

Shortcut toolbar
The Shortcut toolbar is a dynamic and configurable toolbar that displays shortcut options
configured on any object you select on the SmartPlant Foundation user interface. The Shortcut
toolbar buttons have the same functionality as an object's shortcut menu. By default, the
Shortcut toolbar appears with Details and History buttons beside the Find box.
As you log in to the Desktop Client, the software retrieves all toolbar shortcut methods that are
accessible through your role. When you select an object in the SmartPlant Foundation Desktop
Client, the Shortcut toolbar displays shortcut options for the selected object.
If any of the toolbar shortcut methods have conditions, they are processed when you select the
shortcut menu command. If any of the selected objects do not satisfy the condition, you are
given the option to continue processing the valid objects.
For information on how to use the Shortcut toolbar, see Use the Shortcut toolbar (on page 54).
Tree view
When you open the SmartPlant Foundation Desktop Client, the Tree view appears on the upper
left side of the Desktop Client window. The Tree view contains a hierarchy used for navigating
the data in the SmartPlant Foundation database. The active create/update scope that you have
selected appears in the Tree view.
 When you open the Desktop Client, select the appropriate role or roles for the available
configurations, and verify the create scope and query scope are set. If you have not selected
any roles, then the Tree view does not display any nodes.
 Objects added to the default tree view are added in alphabetical order.
You can see the number of objects involved in the relationship in parentheses beside the
expansion heading in the Tree view. The example above shows that there are eight default

process instruments defined in SmartPlant Foundation. Expansion headings tell you what
relationship you are viewing in the Tree view.
The Tree view does not clear when you exit the Desktop Client. Instead, the software stores
your preferences and your view of the user interface in your profile when you close the Desktop
Client. When you open the software again, the Desktop Client user interface contains the same
objects as it did when you exited the Desktop Client previously. However, if you expand the tree
view and then exit SmartPlant Foundation, the software does not save the expansions in your
user profile.
For information on how to use the Tree view, see Use the Tree view (on page 54).
New Items window

By default, the New Items window appears directly below the Tree View in the SmartPlant
Foundation Desktop Client. As you create objects in the Desktop Client, they are added to the
New Items window to give you easy access to the objects.
When you resize or move the Tree view, the New Items window resizes and moves with it.
As with other windows in the user interface, you can move the New Items window and have
your user profile store the window location when you exit SmartPlant Foundation.
When you work in the Desktop Client, the objects that appear in the New Items window are only
displayed during the current session. The software clears the New Items window when you
close the Desktop Client.
For information on how to use the New Items window, see Use the New Items window (on page
56).

Properties window
When you select an object in a list view that has data associated with it, the Properties window
displays the names and values of the properties associated with the object.
The Properties window displays information about a selected object only. A data sheet, on the
other hand, may show information about the selected object and other related objects. The
Properties window only shows those properties that you have access to as defined by your
role.
For information on how to use the Properties window, see Use the Properties window (on page
57).

Extended view of the Properties window

When the Properties window is in extended view and the correct view definitions have been
configured, you can convert data from one unit of measure (UoM) to another by clicking the data
in the Properties window and selecting another UoM from the list. For more information, see
Desktop Client UoM Support in the SmartPlant Foundation How to Configure the GUI Model
guide.
By default, the Properties window displays data in the UoM as defined by the user preference
in the Default UoM box on the General tab of the Change User Preferences dialog box. This
setting allows you to select a display set, typically Imperial or Metric. If a default setting is not
selected, the value is displayed as it is stored in the database.
List view
The Desktop Client displays object data in the List view.
Object data is often arranged in tabular format for easy viewing. Object properties appear as
column headings, and the values for these properties appear in the table rows.

Column Sets
Column sets control what properties are displayed in the list view. Using column sets and
column items, administrators can determine the appearance and order of properties to display.
Each type of item can have its own column set to determine which properties appear in the list
view.
See Configure Column Sets in How to Configure the GUI Model for more information about
creating and configuring column sets.
For information on how to use the List view, see Use the List view (on page 58).
List Edit window

The List Edit window allows you to edit and format data from the list view window of the
Desktop Client. The List Edit window can be configured to allow you to create and delete list
items.
The List Edit window can be configured to allow you to save the list as a list document. For
more information, see Save lists as documents (on page 72) and List Documents (on page 226).
Depending on the configuration of your software, you may be able to edit existing objects, as
well as create and delete objects from the database, using the List Edit window.
For information on how to use the List Edit window, see Use the List Edit window (on page 61).
Status Codes
Status codes
Rows in the List Edit window are color-coded to indicate whether an item is new or has been
modified. A color is also used to indicate that a column is read-only. The status colors are
defined in the key in the List Edit window.
The colors are customizable. For more information, see Personalize status code colors (on page
69).
Mandatory values
Mandatory values are marked by an asterisk (*) in the column header.
If you create a new list item and do not enter a value for a mandatory value, the background
color of the cell changes.
Administrators can configure column sets to designate which values are mandatory or
read-only in the List Edit window. The column attributes are created and managed on the

Manage List Items for Edit administration dialog box or in the List Management Console.
See the How to Configure the GUI Model guide for more information.
Manage windows and forms in SmartPlant

Foundation
In the Desktop Client, windows organize the information you view from the database. The
software uses windows to display the results of queries, and you can export the contents of a
window to an Excel template.
You can manage the windows, including selecting expansion and menu options, window
management options, and configuration setup options, by using the Change User Preferences
command on the File menu.
SmartPlant Foundation Desktop Client saves a user profile that contains information about the
windows, configuration, and other user interface settings when you exit the program.
The Desktop Client interface consists of two types of windows:
 Tool windows, such as the Tree, New Items, and Properties windows, can be displayed or
hidden using the Window menu. These windows provide additional information about where
you are in the project and what you are looking at in the list view windows.
 List view windows display your query results.
The windows in the Desktop Client, including the Tree, New Items, Properties, and list view
windows can be displayed, hidden, docked, maximized, tabbed, or floating.
The following tips help you manage windows effectively in the Desktop Client.

 Learn about the SmartPlant Foundation Desktop Client user profile (on page 47)
 Reset user profile (on page 47)
 Change windows options (on page 47)
 Display or hide a window (on page 49)
 Automatically hide a window (on page 49)
 Turn off Auto-Hide mode (on page 50)
 Dock a floating window (on page 50)
 Undock a window (on page 51)
 Undock a tabbed window (on page 52)
 Maximize a window (on page 52)
 Create tab windows from multiple windows (on page 52)
 Display an object in a new window (on page 53)
 Collapse sections on forms (on page 53)

Learn about the SmartPlant Foundation Desktop Client user

profile
When you exit the Desktop Client, the software saves a user profile that contains information
about the windows, configuration, and other user interface settings.
The user profile saves positional information for the following:
 Tree view
 New Items window
 Properties window
 To Do List location, if the To Do List is displayed.
 Display settings for the windows, such as whether the windows are docked or floating.
When you open the software again, the Desktop Client user interface displays these windows in
the same locations they were in when you exited.
The user profile does not save List View windows or contents.
Reset user profile

Click File > Reset User Profile to return your windows and user preferences back to their
original state.
Change windows options

1. Click File > Change User Preferences.
2. Click the Windows tab.
3. Select options.
4. Click OK to save changes.
For changes to the user preference for windows to take effect, you must restart
SmartPlant Foundation.
The options on the Windows tab of the Change User Preferences dialog box allow you to
control how the windows behave in the software.
Single window, always docked

List view windows are fixed, and new windows are opened as tabbed items in the single
window. You can close individual tabs by clicking the X in the top right corner. This closes
only the active tab. Alternately, you can right-click a tab and click Close.

The following graphic shows the Desktop Client windows when they appear as a single
window in the list view. The tabs located at the bottom of the window allow you to select the
query that you want to view. For example, you can click the Find Reports tab to view the
query results for reports.
You can choose to view only one single, non-tabbed window. When operating in this mode,
any new selection replaces the current display in the list view. This option is available by
selecting the No tabs option on the Windows tab of the Change User Preference dialog
box.
If this option is selected, you will not be able to undock and move any windows,
including tool windows. You will be able to hide and display windows.
Multiple floating windows, dockable

Windows can be floating, hidden, or docked.
The following graphic shows the Desktop Client windows when they appear as multiple,
floating windows in the list view. Each query appears in a separate window, but can also
appear as a single, floating window with tabs.
This option must be selected to undock and move any windows, including tool
windows.

For more information about windows management options, see Change user preferences for
windows (on page 90).
Display or hide a window

 Select a window from the Window list and select the name of the window you want to
display or hide.
A check mark beside the name of the window indicates that it is displayed.
Automatically hide a window

1. Click the button in the top-right corner of a docked window. The window is placed
vertically on the application border on the side to which it was docked.
2. Move your cursor over the window name on the border to display the window, temporarily,
where it was previously displayed. As you move your cursor away, the window is
automatically hidden again.
You can also automatically hide a window by double-clicking on the title bar of the window.
The following illustration shows a normal Tree view and a Tree view with the window placed on
the application border.

Turn off Auto-Hide mode

1. Place your mouse pointer on the window name to show the hidden window.
2. When the window appears, click the button to dock the window to its previous location.
Dock a floating window

 Click and drag the title bar of the floating window to dock it.
As you drag the window across a frame where it can be docked, a guide diamond appears.
The four arrows of the diamond in the center of the window refer to possible docking
positions on the edges of the center frame. As you drag a window, an arrow darkens,
pointing you to the edge where the window can be docked.
When the window you are moving reaches the position where you want to dock it, move the
pointer over the corresponding portion of the guide diamond. The area where the window
will be docked darkens. Release the mouse to dock the window.

In the following example, the floating Tree window has been dragged to the darkened area
on the left side of the screen, where it can be docked.
Undock a window
 Click and drag the title bar of a docked window to undock it and display it as a floating
window.
The Multiple floating windows, dockable option on the Windows tab of the Change
User Preference dialog box must be selected to undock a window.

Undock a tabbed window

 Click and drag the tab to undock the tabbed window.
Maximize a window
 Double-click a floating, undocked window to dock it against the top border of the Desktop
Client. This maximizes the window as much as possible considering the placement of other
tool and list view windows.
If windows are already docked along the top border of Desktop Client and there is no
empty space along the border, you cannot maximize another window. As long as some
portion of the top border does not have a window docked against it, you can minimize a new
window, and the software will place it in that empty space.
Create tab windows from multiple windows

 Click and drag a floating window. If the window can be added as a tab to the window
underneath, the center of the window underneath darkens. Release the mouse to dock the
window as a new tab on the window underneath.

You must have selected the Multiple floating windows, dockable option on the
Windows tab of the Change User Preference dialog box to create a tab window from
multiple windows.
 If you want only query windows to display as tabs, turn on the Create only query
windows as tabs option on the Windows tab of the Change User Preference dialog
box.
 If you want relationship expansions to display as tabs, turn on the Show relationship
expansions as tabs option on the Windows tab of the Change User Preference
dialog box. If this option is turned off, relationship expansions display in new windows.
Display an object in a new window

The Open in New Window command allows you to view the selected object in a new window.
This command is available when you right-click an object.
1. Right-click the object that you want to display in a new window.
2. On the shortcut menu, click Open in New Window.
Collapse sections on forms

You can collapse and expand sections on some forms. Click the minus (-) sign and expand
sections by clicking the plus (+) sign.
Collapse All button - closes each collapsible section, hiding all options on the form.
Expand All button - opens all collapsible sections, making all options on the form visible.
Collapse sections automatically option - collapses all open sections as soon as another
section is opened.

Use the Shortcut toolbar

The Shortcut toolbar is a dynamic and configurable toolbar that displays shortcut options
configured on any object you select on the SmartPlant Foundation user interface. The Shortcut
toolbar buttons have the same functionality as an object's shortcut menu.

 Configure the Shortcut toolbar (on page 54)
 Enable the Shortcut toolbar (on page 54)
Configure the Shortcut toolbar

 Right-click the toolbar to change the display options. Shortcut toolbar menu options are
Text, Image, and Text and Image. The Image icons appear by default.
 The Shortcut toolbar can be moved to a different location in the Desktop Client window and
remains in the selected location after you log out.
Enable the Shortcut toolbar

Click Window > Shortcut toolbar to display or hide the Shortcut toolbar.
Use the Tree view

The Tree view contains a hierarchy used for navigating the data in the SmartPlant Foundation
database. The active create/update scope that you have selected appears in the Tree view.

 Show or hide the Tree view (on page 55)
 Navigate the Tree view (on page 55)
 Reset the Tree view (on page 56)

Show or hide the Tree view

 Click Window > Tree to display or hide the Tree view.
When the tree view is displayed, a check mark appears beside the Tree command on
the Window menu.
Navigate the Tree view

 Click and to expand and close nodes in the Tree view to show and hide information.
 Right-click an object in the Tree view, and click the type of relationship that you want to
display on the Relations shortcut menu to display other, non-default relationships for an
object.
 Right-click the expansion heading, and click Clear Selection on the shortcut menu to
remove an expansion from the Tree view.
 You can click and to expand and close nodes in the Tree view to show and hide
information. When you expand a node in the Tree view, the software expands the default
relationship for the object. The default relationship for each object is defined by your system
administrator.
 Before you expand objects or relationships in the Tree view, all objects and expansion
headings have a beside them, regardless of whether data is available for the expansion. If
you expand an object that has no data, the disappears.
 If you have the Look Ahead option turned on, you can see the number of objects involved
in each relationship in parentheses beside the menu command. For more information, see
Look ahead for associations (on page 81).

Reset the Tree view

 Click Clear Tree to reset the Tree view and clear all expansions.
 Clearing the Tree view resets it to its original state by clearing any expansions that are
displayed.
 You can also clear the tree view using commands available from the shortcut menu that
appears when you right-click the Tree title bar.
Use the New Items window

As you create objects in the Desktop Client, they are added to the New Items window to give
you easy access to the objects.

 Add objects to the New Items window (on page 56)
 Show or hide the New Items window (on page 56)
 Clear the New Items window (on page 57)
Add objects to the New Items window

You can add items to the New Items window to traverse relationships from an object in the Tree
view.
1. Select an item in the Tree view.
2. Drag the object while holding the CTRL key into the New Items window.
Show or hide the New Items window

1. Click Window > New Items to display the New Items window.
2. Click Window > New Items to clear the New Items window selection and hide the window.
Drag the splitter (between the Tree View and the New Items window) up or down to
change the relative size of the New Items window.

Clear the New Items window

 Click Clear Tree to clear the New Items window.
Use the Properties window

The Properties window displays the names and values of the properties associated with the
object.
The Properties window contains read-only data. To edit the data, you must use the Update
dialog box for the object.
Properties window
Displays read-only properties for the selected object. You can change the display of properties
in the Properties window by clicking one of the following buttons.
Alphabetic - Displays an alphabetical list of properties for the selected object.
Categorized - Displays a categorical list of properties for the selected object.
Extended - Displays an extended view of the properties for the selected object.
Brief - Displays a brief listing of the properties for the selected object.

 Show or hide the Properties window (on page 57)
 Change the Properties window view (on page 58)
Show or hide the Properties window

Click Window > Properties to display the Properties window, which contains an alphabetical or
categorical list of properties for the selected object.
When the Properties window is displayed, a check mark appears beside the Properties
command on the Window menu.
 The Properties window displays an alphabetical or categorical list of properties for the
selected object.
 When the Properties window is displayed, a check mark appears beside the Properties
command on the Window menu.
 You can also close the Properties window by clicking the Close button in the top-right
corner.
 The display mode (modal or extended system) of the Properties window is saved in the
user preferences between sessions. Modal is a brief listing of the properties and extended
system is an extended view of the properties.

Change the Properties window view

 Click or to switch between alphabetic and categorized view of the data in the
Properties window.
By default, the categorized view of data appears in the Properties window.
 Click or to switch between a brief listing of the properties and an extended view of
properties in the Properties window.
By default, the brief view of data appears in the Properties window.
Use the List view

The Desktop Client displays object data in the List view. You can change the display of data in
the List view, and you can export the contents of the List view to multiple templates and file
types.
Custom Sort dialog box

Allows you to set custom sorting for list views. Set up multi-column sorting by adding columns to
the Sort by list. Items are sorted by the column at the top of the Sort by list first, then by the
second, and so on.
Available columns - The list of columns available for custom sorting.
Sort by - The list of columns that are used in the custom sort.
Add - Adds the selected column to the Sort by list.
Remove - Removes the selected column from the Sort by list.
Move Up - Moves the selected column up in the Sort by list.
Move Down - Moves the selected column down in the Sort by list.
Ascending - Changes the sort order for the selected column to ascending order.
Descending - Changes the sort order for the selected column to descending order.
Export (Select Template) dialog box

Select a file to use as a template. The contents of the List view window are exported to Excel
using the selected file as a template.

 Change the display of data in the List View (on page 59)
 Export the contents of a List View to the default template (on page 59)
 Export the contents of a List View to the selected template (on page 59)
 Export the contents of a List View to Excel (on page 60)
 Export the contents of a List View to a text file (on page 60)

Change the display of data in the List View

 To rearrange the order in which columns appear, you can drag a column heading and drop it
in a new location in the column heading row.
 You can sort tables by a particular column by clicking that column heading. You can also
sort tables by multiple columns by right-clicking a column heading, and then clicking Sort >
Custom Sort on the shortcut menu.
If your system administrator has defined custom sorting for list views, you can edit
that sorting using the Custom Sort dialog box.
 You can filter the contents of a table so that only rows that contain a certain value are
displayed. To filter the table, right-click a column heading, click Filter on the shortcut menu,
and select a value.
The software hides rows that do not contain the filter value, and the column heading used to
filter the table contains the filter icon .
 To display all table rows again after filtering, right-click a column heading, and click Filter >
All on the shortcut menu.
 To change the alignment of the text in a column, right-click the column heading, click Align
Text on the shortcut menu, and select an alignment.
These settings are not saved beyond the current list view session. Column sets are used
for more permanent changes to the appearance of columns in the list view.
Export the contents of a List View to the default template

The File > Export (Default Template) command allows you to export the contents of a window
into a Microsoft Excel file.
1. Display in a list view the items for which you want to export data.
You can use a query to find the items that you want to export.
2. Click the list view that contains your items to make it the active view.
3. Click File > Export (Default Template).
The items you have selected open in Microsoft Excel.
You must have Microsoft Excel installed on the client computer to use this command.
Export the contents of a List View to the selected template

The File > Export (Selected Template) command allows you to export the contents of a list
view window into a Microsoft Excel file.
3. Click File > Export (Select Template).
4. In the Define Excel Template dialog box, select a template from the list. For more
information on creating a new template, see Configure export template (on page 407).
5. Click OK.

Export the contents of a List View to Excel

The File > Extract List to Excel command allows you to export the contents of a window into a
Microsoft Excel file.
1. Display in a list view the items for which you want to export data to Excel.
You can use a query to find the items you want to export.
3. Click File > Extract List To Excel.
 You must have Microsoft Excel installed on the client computer to use this command.
 You must set your Internet security level to low to use this command. Click Tools > Internet
Options > Security > Local Intranet > Custom Level in Internet Explorer and then set
Initialize and script ActiveX controls not marked as safe to Enable or Prompt.
Export the contents of a List View to a text file

You can export the contents of the selected list view window to a text file. The delimiter used
between values in the text file is specified in argument 1 of the ExtractToText method.
3. Click File > Extract List to Text File.
4. In the Save As dialog box, browse to the location where you want to store the text file, and
select an existing text file or type a name for the file in the File name box.
5. Click Save.
The text file contains the same information as the list view window you selected,
separated by the delimiter specified on the method. For example, the following text file contains
document names, descriptions, revisions, versions, and so on, separated by commas.
Name,Description,Revision,Version,Class,Workflow Name,Workflow
Status,Creation Date,Last Updated,Owning Group,Owner
Doc001,Document 1,B01,3,Dimensional Data Documents,,,14/10/2009
10:04:15,14/10/2009 10:04:15,,
Doc001,Document 1,C01,3,Dimensional Data Documents,,,14/10/2009
10:04:15,14/10/2009 10:04:15,,
Doc002,,A01,2,Dimensional Data Documents,,,14/10/2009
10:04:15,14/10/2009 10:04:15,,
Doc002,,B01,1,Dimensional Data Documents,,,14/10/2009
10:04:15,14/10/2009 10:04:15,,

Use the List Edit window

The List Edit window allows you to edit and format data from the list view window of the
Desktop Client. The List Edit window can be configured to allow you to create and delete list
items.
List Edit window

Allows users to edit and format data from the list view window of the Desktop Client or from a list
document. Users can edit existing items, create new items, and delete items.
The List Edit window also allows users to customize the appearance of the list and export the
list to Excel.
Save List As New <Object> - If list management functionality has been configured, this will
save the list as a new list document.
Save List to Existing <Object> - If list management functionality has been configured, this will
save the list as an existing list document.
List Edit Options dialog box

If multiple List Edit windows are available for this item type, you must choose which window to
open.
Name - Choose an available configuration of the List Edit window to open.
Filter dialog box

Allows you to filter the items that are displayed in the List Edit window based on a value in the
column.
Group items - Groups items together based on their values for the property in the selected
column.
New items - Creates a separate group for new items for each grouping.
Modified items - Creates a separate group for modified items for each grouping.
Clear Filter - Resets the filter and displays all items.
Selecting Clear Filter also removes all sorting from the columns.
Close - Close the Filter dialog box and return to the List Edit window.
Unit of Measure dialog box

Select a unit of measure. You can also enter the first letters of the UOM to jump to the UOM in
the list.
 The Unit of Measure dialog box converts the value you enter to the UOM you select.
 If a default UOM has been set for this column, that UOM will already be selected when the
UOM dialog box appears.

Edit Relationships dialog box

Allows you to query for values to assign to a property in the List Edit window.
Enter search criteria in the criteria box and click Find.
Search results appear in the left side of the dialog box. Use the right arrow to move values into
the right side of the dialog box, and the left arrow to move them back to the left side. The values
on the right will be assigned to the property when you click OK.
You may be allowed to assign multiple values to a property, or the property might be
restricted to only one value. This depends on the rules of the relationship.
Resolve Conflicts dialog box

Allows you to resolve problems with objects edited or created in the List Edit window.
Name - The name of the object.
Type - The type of conflict. The two types are Validation and Out-Of-Date. The value in this
column changes to Resolved when the conflict is addressed.
Message - Displays details about the conflict.
Resolve - Click to resolve the conflict.
Out of Date Object dialog box

Allows users to resolve differences between property values and relationships in the List Edit
window and the values in the database. Click the value you want to use. Click the New Local
Value or Server Value column header to select all values in the column.
Property - The property that is out of date.
Relationship - The relationship that is out of date.
Original Local Value - The value for the property or relationship that was current when you
opened the List Edit window.
New Local Value - The value for the property or relationship that you entered in the List Edit
window.
Server Value - The value for the property or relationship that is in the database.

 Open the List Edit window (on page 63)
 Set the date and time in the List Edit window (on page 64)
 Configure the list in the List Edit window (on page 65)
 Sort columns in the List Edit window (on page 65)
 Filter items to display (on page 65)
 Freeze a column (on page 66)
 Export list to Excel (on page 66)
 Edit the properties of an object in the List Edit window (on page 66)
 Create a new object in the List Edit window (on page 68)
 Copy and paste in the List Edit window (on page 69)
 Delete an object in the List View window (on page 69)
 Personalize status code colors (on page 69)

 Resolve conflicts in the List Edit window (on page 70)

 Save lists as documents (on page 72)
Open the List Edit window

You can open the List Edit window from a shortcut menu or from the toolbar.
Open the List Edit window from a shortcut menu

1. Right-click one or more items in the list view. All items selected must have a common
interface. In most cases, this means that the objects must be of the same type.
2. Click List Edit on the shortcut menu.
List editing is configurable, and the list editing commands on your shortcut menu may
be different.
The List Edit window appears, containing the selected items.
Open the List Edit window from the toolbar

 Your software might be configured with a List Edit toolbar. When the List Edit window is
opened from the toolbar, it is populated with the contents of the active list view window.
 There must be a list view window active for the List Edit window to be opened. If there is
not an active list view, you are prompted that a list view must be active for the List Edit
window to be opened.
 The items in the list view must have a common interface. In most cases, this means that the
items must be of the same type. If they are not, you are prompted that list editing is not
available, and the List Edit window is not opened.
 Click the List Edit button on the toolbar to open the List Edit window.
Select a List Edit window from multiple configurations

If multiple configurations of the List Edit window are available for the selected type of item, you
must choose which configuration to open after clicking List Edit.
In the following example, the software has been configured with a standard List Edit window for
equipment tags and a List Edit window with the capability to save the equipment list as a
document.

This is an example of available List Edit options. Based on the configuration of your
software, the options you see here might be different.
Set the date and time in the List Edit window

You can update the date and time properties by double-clicking any date field (Creation Date,
Last Updated, and so on) in the List Edit window. Dates can also be changed by using
copy/paste, entered manually or selected from a dialog box.
1. Click a cell containing a date in the List Edit window.
2. Double-click the date to open the Set Date window.
3. Click Calendar and select a date.

4. Click OK to save the date.
 Click Clear to remove the data from the field.

 Date and time are shown in the date/time format specified for the user's location.
 Depending on how the Administrator sets up the property, the dialog box displays
month/day/year or the month/day/year and time.
 Users can copy and paste the date in any date field in the List Edit window.

Configure the list in the List Edit window

The List Edit window allows you to configure the display of the list of items, similar to change
the look of a spreadsheet.
 Drag the column headers to new locations to change the order of the columns.
 Drag the column splitter to resize columns.
 Filter and group items to be displayed based on their property values. See Filter items to
display (on page 65) for more information.
 Column sorting, filtering, and changes you make to the order of the columns are not saved
between List Edit window sessions.
 To alter the columns displayed in the List Edit window permanently, an administrator must
edit the column set. This affects all new list documents that are created from this list. List
documents created before the change is made still use the previous column set because the
column set is saved with the list document. For more information about list documents, see
Save lists as documents (on page 72).
For more information about column sets and the List Edit window, see Manage Column Items
for Edit and List Management Console in How to Configure the GUI Model.
Sort columns in the List Edit window

 Click a column header to sort the items in ascending order.
 Click again for descending order.
 Hold down the SHIFT key and click another column for multi-column sorting.
 Selecting Clear Filter on the Filter dialog box also removes sorting from the columns.
 When you add a new item to the list, or change a value in a sorted column, the new values
are automatically placed in the correct sort order.
Filter items to display

 Click the Filter button in the column header to open the Filter dialog box.
 Select properties to display only items that match the selected criteria.

 Select the Group items option to group items together based on their values for the
property in the selected column.
 Select the New items option to create a separate group for newly created items for each
grouping.
 Select the Modified items option to create a separate group for items that have been
modified in the List Edit window. The items are also sorted by group.
 Click Clear Filter to reset the filter, remove all sorting, and display all items.
 Click Close to close the Filter dialog box.
 When a column is filtered, the Filter button is highlighted in blue .

 Click the Filter button to change or clear the filter.
Freeze a column
You can freeze a column's placement in the List Edit window. When you scroll the window, the
frozen column stays in place.
 Right-click a cell and select Freeze This Column on the shortcut menu to freeze the
column.
 Select UnFreeze This Column on the column's shortcut menu to return to the column's
normal behavior.
Export list to Excel

1. Select a cell in the List Edit window.
2. Click Export to Excel on the shortcut menu to export the contents of the List Edit window
to a new Excel spreadsheet.
Edit the properties of an object in the List Edit window

You can edit the properties of an existing list item in the List Edit window.
 Some properties may be read-only. See Status codes (on page 45) for more information
about the color-coded status indicators in the List Edit window.
 Any changes are saved to the database when you click Apply or OK. You cannot undo any
changes that have been saved to the database. If you close the List Edit window without
clicking Apply or OK to save your changes to the database, you are prompted that your
changes will be lost.
Units of measure
You can change the unit of measure (UOM) of a property in the List Edit window.

1. Click or type in a cell for a property that is defined by a UOM to open the UOM dialog box.
2. Select a unit of measure. You can also type the first letters of the UoM to jump to the UoM in
the list.
 The UOM dialog box converts the value you enter to the UoM you select.
 If a default UoM has been set for this column, that UoM is already selected when the
UOM dialog box appears.
Select a value from the Edit Relationships dialog box

Some properties in your list can be configured to allow you to select values from the Edit
Relationships dialog box.
1. Select a cell in the List Edit window to open the Edit Relationships dialog box.

2. Type search criteria and click Find to query for values.

Search results appear on the left side of the dialog box.
3. Highlight one or more values and click the right arrow to move the values to the right
side of the dialog box.
4. Click the left arrow to move values you do not want to assign back to the left side of
the dialog box.
You may be allowed to assign multiple values to a property, or the property might be
restricted to only one value. This depends on the rules of the relationship.
5. Click OK to assign the value or values to the property.
Create a new object in the List Edit window

Add a new object to an empty row
You might not have permission to create new list items in the List Edit window. The
commands available depend on how your administrator has configured the software.
1. Type values in the empty row at the bottom of the list.
 When you create a new item, you can enter values for properties that are designated as
read-only. Read-only properties cannot be edited after they have been saved to the
database.
 Mandatory values are marked by an asterisk (*) in the column header.
2. Click Apply to create the new object in the database. Click OK to create the item in the
database and close the window.
Copy and append a row

You can also create a new item by copying an existing row and appending it to the list.
You might not see this command on the shortcut menu. Available commands depend on
how your administrator has configured the software. See the How to Configure the GUI Model
and How to Configure Document Management administration guides for details.
1. Right-click a cell, and select Select Row(s) Then Copy and Append on the shortcut menu.
A copy of the selected row or rows is appended to the list. The new rows are marked by a
blue cell to the left of the row.

You can also click Select Row(s) on the shortcut menu of the cell, and then click Copy
and Append Selected Rows.
2. Change the values in the new row for the item you want to create.
When you create a new item in this way, all the properties are copied from the
source object to the target object. This includes properties that are not displayed.
3. Click Apply to create the new item.
Copy and paste in the List Edit window

 Use the keyboard combination CTRL+C to copy the contents of one cell.
 Use CTRL+V to paste from one cell into one or many cells.
You can also copy the contents of multiple cells and paste into multiple cells.
The value you select for one property or relationship may determine the list of values
available for another property or relationship. You can copy and paste properties and
relationships selected from these cells just like other values in the List Edit window. Any cells
that represent properties or relationship values dependent on others changed by a copy and
paste operation are updated appropriately.
Delete an object in the List View window

You might not see this command on the shortcut menu. Available commands depend on
how your administrator has configured the software. See the How to Configure the GUI Model
and How to Configure Document Management administration guides for details.
1. Highlight the row or rows that represent the item or items you want to delete (right-click the
cell, and then click Select Rows on the shortcut menu).
Right-click the row, and select Delete Selected Rows or press the DELETE key.
2. Click Yes to delete the item from the list.
 The item is not deleted from the database until you click Apply or OK in the List Edit
window. If you click Cancel in the List Edit window, and dismiss the List Edit window
before you delete the item from the database, the item is reinstated in the list.
 Depending on how your software is configured, the object is deleted or terminated.
Personalize status code colors

1. Click a color in the key to open the Color dialog box.

2. Click a color on the Color dialog box, and then click OK. You cannot define custom colors.
The color key and the colors in the table are updated in the List Edit window.
 The selected colors are saved between sessions of the Desktop Client. Each user can have
a separate set of colors.
 When you click OK or Apply and save the changes to the database, the colors disappear.
Resolve conflicts in the List Edit window

The List Edit window validates new or edited objects when you click OK or Apply. The software
checks items that have been changed in the List Edit window against the objects in the
database, and validates new objects using rules defined in the schema. If there are any
conflicts, the Resolve Conflicts dialog box appears.
The Resolve Conflicts dialog box displays the name of the object, the type of conflict, and a
detailed message about the conflict.
There are two types of conflicts: validation and out of date objects.
Validation
To resolve a validation conflict, do the following:
1. In the Resolve Conflicts dialog box, select the object, and click Resolve.
The item is highlighted in the List Edit window and the Resolve Conflicts dialog box
remains visible.

2. Make the necessary corrections in the List Edit window, as described in the Message
column of the Resolve Conflicts dialog box.
The value in the Type column changes to Resolved, and the count at the bottom of the
Resolve Conflicts dialog box is updated.
Click a column header to sort the conflicts.
The dialog box disappears when all conflicts have been resolved. Click Close to return to
the List Edit window without resolving all conflicts.
Out of date conflicts

Out of date conflicts occur when items you have edited in the List Edit window have been
updated by another user since you opened the List Edit window. This results in a conflict
between the values you have entered and the values already in the database.
For properties, the software compares the values of properties you have edited in the List Edit
window with the property values in the database.
For relationships, the software checks for any relationships that have been terminated, created,
or changed outside the List Edit window since you started the editing the list. Only relationships
available in the List Edit window are considered.
Out-of-date property conflicts and relationship conflicts for an item are listed in the Resolve
Conflicts dialog box. This dialog box displays three possible different values for each out of
date property or relationship.
Original Local Value - The value of the property or relationship that was current when you
opened the List Edit window.
New Local Value - The value that you set in the List Edit window.
Server Value - The value that is currently stored in the database.
The example below shows an out-of-date property (Overall height) and an out of date
relationship (Tag type). The original local value for the Tag type relationship is blank, which
means that no relationship existed when the user opened the List Edit window. Another user
has created a Tag type relationship since the user opened the List Edit window, and that value
is displayed as the Server Value. The New Local Value is the value the List Edit window user
has entered in this List Edit window session.
If a relationship has multiple values, all the related values are displayed as coma-separated
string values.
Resolving Out of Date Conflicts

You can resolve an out of date property or relationship for an item.

1. In the Resolve Conflicts dialog box, select the item.

2. Click Resolve to display the Out Of Date Object - Resolve Conflicts dialog box.
3. Click the value for each property or relationship that you want to use. You can select the
New Local Value or the Server Value.
The font becomes bold, signifying that it is the value you want to use.
Click the New Local Value or Server Value column header to select all values in the
column.
If the out-of-date item is a relationship that has dependent column items or that
depends on column items, the software restricts the selection to the selection of all the local
values or all the server values for the related set.
4. Click OK to update the item with the selected values. The item's last updated date is
modified, so the object is no longer out of date relative to the database.
After you resolve an out-of-date conflict for an item that supports multiple relationships,
the software prompts you to click Apply in the List Edit control to save your changes to the
database before making further changes to the item.
Save lists as documents

Based on your configuration, it may be possible to save a list as a list document from the List
Edit window. You can attach the list to an existing list document or save the list as a new list
document.
For more information, see List Documents (on page 226) or List Management Document
Configuration in How to Configure Document Management.
Get to know keyboard shortcuts

SmartPlant Foundation has keyboard shortcuts that let you perform the following commands
without selecting menus and using the mouse.
Command Shortcut
Copy selection CTRL + C
Cut selection CTRL + X
Delete selection DELETE

Help F1
Paste CTRL + V
Access keys
SmartPlant Foundation has access keys that correspond to an underlined letter on a dialog box
or control.
 To use an access key, locate a control or button on the dialog box for which the letter is
underlined, then click ALT + <letter>.

For example, on the New Design Document dialog box, click ALT +F to complete creation
of the document.
Below is a list of common access keys that can be used:
Command Access Key

Add ALT + A
Apply ALT + A
Back ALT + <
Browse ALT + D
Clear All ALT + C
Collapse All ALT + C
Expand All ALT + E
Finish ALT + F
Help ALT + H
Next ALT + N
OK ALT + O
Print ALT + P
Remove ALT + R
Select All ALT + S
 Access keys may vary between dialog boxes and controls.

 Access keys associated with buttons may require that you press ENTER to activate the
control after using the access key.


SECTION 3
User Options
In the SmartPlant Foundation Desktop Client, you can set various user options to configure the
Desktop Client.
These options include:
 Set the active scope for object creation and query.
 Select roles for the active scope.
 Change your user password.
 Change preferences for the number of query results you want the software to return and the
number of results at which you want the software to display a warning message.
 Set the refresh rate for the To Do List.
 Set your preferences for list view windows.
 Turn look ahead for associations on and off.
 Change effective dates.
Set user options

Use the following topics to set user options in the SmartPlant Foundation Desktop Client.
Set Active Scope dialog box

Allows you to set the active scope for viewing, creating, modifying, and terminating data in
SmartPlant Foundation. You can view data in any configuration or configurations selected in this
dialog box, but you may choose only one configuration in which to make changes.
Set the Active Configuration by Query - Allows you to filter the list of available roles by first
selecting the configurations in which you want to create or query data.
Set the Active Configuration by Roles - Allows you to filter the list of available configurations
by first selecting the role.
Query scope - Lists plants and projects in which you can view data. If you selected the Set the
Active Configuration by Roles option, then this list displays only the configurations for which
you have been granted the roles selected in the Selected roles list.
Status filter - Defines the lifecycle status of configurations to be displayed in the Query scope
tree.
Clear Query Scope - Clears both the currently selected configurations and status filter.
Selecting at least one option under the Status filter is required to display the query scope, and
clicking Clear Query Scope removes the query scope from view.
Select All - Selects all configurations in the Query scope tree.
Query by selected configurations only - Restricts queries to only the selected configurations
and not higher configurations. For example, if you select Project1 in PlantA with this option
selected, your queries return only data from Project1, not from PlantA.
Selected roles - Lists the available roles. If you selected the Set the Active Configuration by
Query option, then this list is filtered to only those available to you for the configurations
selected in the Query scope tree.
Create scope - Defines the plant or project in which you can create and update objects.

User Options
Tooltip - You can pause over the Selected Roles, Query Scope, and Create/Update
Scope status bars with your pointer and see the name and description of your roles and scope.
Change Password dialog box

Allows you to change the password for the current user.
User name - Displays the user name for the current user. This option is read only.
Enter old password - Type the password that you want to change.
Enter new password - Type the new password.
Confirm new password - Retype the new password.
 SmartPlant Foundation passwords and Windows passwords are not connected in any way,
unless you have implemented Windows authentication for SmartPlant Foundation.
 When using Windows authentication for SmartPlant Foundation, do not set any expiration
for SmartPlant Foundation user passwords in that software. If the SmartPlant Foundation
password is set to expire, the Change Password dialog box appears after the defined
numbers of days. That dialog box allows user to change the user password in SmartPlant
Foundation only, causing a synchronization issue with Windows.
 When creating a new password, Intergraph recommend using strong passwords. For more
information, see the Windows Help and Support Center.
Change User dialog box

Allows you to log on as a different user.
User name - Type your SmartPlant Foundation user name.
Password - Type the password for your user account.
Server - Select the name of the SmartPlant Foundation site connection to which you want to
connect. You can also add a new site connection or edit an existing one by clicking Options and
then clicking Edit or New.
 If you have only one site connection in your Server list, and Windows authentication is set
up on that server, you will be logged in automatically if your Windows user name is valid for
that SmartPlant Foundation site.
 If you have more than one server in your list and Windows authentication is set up on your
server, even though your Windows user name is valid in the site, your user name and
password will be unavailable on the Logon Information dialog box. Click OK to log on using
your Windows user name and password.
Effective Date dialog box

Sets the effective date for the Desktop Client, setting the point in time in which you want to view
the data in the database.
Calendar - Select a date from the calendar. The calendar is available only if the Show data
available option is set to On.
Now - Sets the effective date to the current system date. The calendar is unavailable when you
select this option.
On - Makes the calendar available for selecting an effective date and time.

User Options
Time - Sets the hour, minute, and second of the date indicated in the calendar when you want to
view the data in the database. Select the values from the lists. This option is available only if the
Show data available option is set to On.
 All date and time options are stored in the database in Greenwich Mean Time (GMT), but
displayed in local time, as determined by the regional settings on the local computer.
 When the effective date is set to anything other than Now, the data displayed is read-only.
To create, modify, or delete any objects, you must first set the effective data back to Now.
Change User Preferences dialog box

Sets various user preferences for the Desktop Client, including expansion and menu options,
window management options, and configuration setup options.
User preferences are defined using the following tabs:
 General tab
 Windows tab
 Expansion tab
 APIs tab
 Claim tab
 Default ContainerIDs tab
 3D Viewing tab

 Learn more about setting the active scope (on page 78)
 Set the active configuration by roles (on page 79)
 Set the active configuration by query
 Change user password (on page 80)
 Change user (on page 81)
 Look ahead for associations (on page 81)
 Change the effective date (on page 82)
 Reset user profile (on page 82)
 Change user preferences (on page 83)

User Options
Learn more about setting the active scope

Setting the active scope in SmartPlant Foundation allows you to view, create, modify, and
terminate data within the context of a selected configuration.
In SmartPlant Foundation, roles determine a user's access to specific configurations. Each user
works in the context of two active configurations, or scopes:
 The query scope is used for all data queries and relationship expansions; it determines what
objects you can see in SmartPlant Foundation. The query scope can consist of more than
one configuration.
 The create scope is used for data creation, modification, and termination. The create scope
is always one of the query configurations.
The highest level of the selected create configuration is displayed in the Desktop Client tree
view. Only objects that support configurations can be part of the configuration tree. Typically,
configuration trees contain plants and projects. In the example below, the create configuration,
PlantA, is expanded to show its sub configurations, Projects 1-4.
When you select a scope for creating data, any data that you create becomes a part of that
scope. For example, if you select PlantA, Project1 as your create scope, any data that you
create is part of Project1 in PlantA.
When you select a scope for querying data, you are defining the scope in which you want to
conduct searches. For example, if you select PlantB as your query scope, searches only return
data that is part of PlantB. However, when projects, or sub-configurations exist under a plant,
queries return objects in both the project and the plant when the query scope is set to a project.
For example, if you set your query scope as Project 3 of PlantB, then your queries return
objects that exist in either Project 3 or Plant B.
To override this behavior so that queries made at the project level return only objects that
exist in the project and not objects that exist in the plant, select the Query by selected
configurations only option on the Set Active Scope dialog box.
You can change your create or query scope at any time. However, you can only select from
plants and projects in the configuration tree to which you have access to in SmartPlant
Foundation.
Data created or modified within a project can be merged into the parent configuration.
 You have the option to expand items in the tree view to a new window, to the Tree, or to the
New Items window.
 To see your currently selected query configurations for a plant in the tree view, right-click the
plant and click Relations > Show Selected Query Sub Configurations.
 To see the query configurations that are available to you for the plant in the tree view,
right-click the plant and click Relations > Show Possible Query Sub Configurations.

User Options
Set the active configuration by roles

The File > Set Active Scope command allows you to set the active scope for viewing and
printing, data viewing, and creating, modifying, and terminating data within the context of a
selected configuration.
When you set the active configuration by roles, the available query scopes are filtered by the
selected roles. Setting the configuration by role is useful if you have two or more roles in your
organization and you need to work in one of those roles across projects.
The list of roles contains all of the roles to which you have access. As you select roles, the list of
available configurations changes to show all of the configurations in which you have the
selected roles. A configuration is displayed only if you have access to all of the selected roles in
that configuration.
 Your query scope defines the configuration in which you want to search for data.
 Your role determines the features and commands available in the selected configuration.
 Your create scope defines the configuration in which you can create and update objects.
1. Click File > Set Active Scope.
 You can also set the active scope by clicking Selected Roles, Query Scope, or
Create/Update Scope in the Desktop Client status bar.
2. In the Set Active Scope dialog box, select Set active configuration by roles.
3. Select the appropriate user role or roles from the Selected roles list.
The roles in the list are all of the roles available to you. Your role selection
determines the configurations that are available in the Query scope list.
4. In the Status filter box, select the lifecycle status filter or filters for the configurations.
 By default, only the active configurations are displayed in the list.

 To display other configurations in the list, such as configurations for newly created,
merged, or completed projects, select the appropriate filter.
 You can use the Query by selected configurations only option to restrict queries to
only the selected configurations and not higher configurations. For example, if you
select Project1 in PlantA with this option selected, the queries return only data from
Project1, not from PlantA.
5. In the Query scope list, select the option beside the configuration or configurations in which
you want to search for objects.
 Only configurations to which you have query access are in the list.
 When you select a configuration in the Query scope list that is also a valid create
configuration for the selected role, then that configuration is added to the Create scope
list.
6. To set the Create scope, select the option beside the plant or project in which you want to
create and modify objects.

User Options
 You can select only one plant or project for the create scope.
 To set the create scope for the top-level configuration, select the Scope Not Set option.
System administrators can use this setting for creating configuration-independent items,
such as administration items.
7. Click OK to save your changes.
Plant and Project Data in SmartPlant Foundation

Access to data in SmartPlant Foundation is controlled by a role-based security model that is
defined by a system administrator. Role definitions determine user access to data and to
functionality in SmartPlant Foundation. The system administrator assigns individual users to
roles within specific plant/project configurations. Users can belong to more than one role per
configuration.
When you log on to the Desktop Client and set your active scope, you must select the
appropriate role or roles for the available configurations. Your role selection governs the data
and the command options that are available to you within those configurations.
For administrative information about defining roles, refer to How To Configure the Security
Model.
Change user password

The File > Change Password command allows you to change the password you use to log on
to the SmartPlant Foundation Desktop Client.
 SmartPlant Foundation passwords and Windows passwords are not connected in any way,
unless you have implemented Windows authentication for SmartPlant Foundation.
 When using Windows authentication for SmartPlant Foundation, do not set any expiration
for SmartPlant Foundation user passwords in that software. If the SmartPlant Foundation
password is set to expire, the Change Password dialog box appears after the defined
numbers of days. That dialog box allows user to change the user password in SmartPlant
Foundation only, causing a synchronization issue with Windows.
 When creating a new password, we recommend using strong passwords. For more
information, see the Windows Help and Support Center.
1. Click File > Change Password.
2. In the Change Password dialog box, type your old password, your new password, and then
a confirmation of the new password.
3. Click OK.

User Options
Change user
The Change User command allows you to log out of the SmartPlant Foundation Desktop Client
as one user and log on as another. Additionally, since the Logon Information dialog box allows
you to specify a site connection, this command allows you to disconnect from one site and
connect to a different one.
1. Click File > Change User.
2. Type a user name and password, and choose a site connection in the Server field.
3. Click OK to connect to the specified site.
Look ahead for associations

The View > Look Ahead command allows you to see the number of related objects in
parentheses beside expansion headings in the tree view and beside shortcut menu commands
that display particular relationships. The Look Ahead option can filter the relationship expansion
options on the context menu to only those that have objects to expand.
The following graphic shows a tree view with expansion headings.
Click View > Look Ahead to turn the functionality on or off.

A check mark beside the Look Ahead command on the View menu indicates that look
ahead is turned on.
The Look Ahead feature can slow the performance of the software. For more information
on software performance, see the How to Configure Performance guide.

User Options
Change the effective date

The Effective Date command allows you to view data from the SmartPlant Foundation
database as the data existed at a particular time in the past. This command is available in the
status bar at the bottom of the window.
1. Click the current effective date to the right of the Effective Date label in the Desktop Client
status bar.
2. Click On to select a specific date and time at which to view data in the database.
3. Select the month and year.
4. Click the day of the month.
5. Type the time (using a 24-hour clock) in the Time box.
 When you set the effective date to a date in the past, you cannot change the data. You can
only view the data that was valid at that point in history.
 To set effective back to so that you can view the current data, reopen the Effective Date
dialog box, and choose the Now option.
 When you change the effective date, the software clears all views in the Desktop Client. The
effective date to the right of the Effective Date label at the bottom of Desktop Client window
changes to the month, day, year, and time that you specify.
 All date and time settings are stored in the database in Greenwich Mean Time (GMT), but
Reset user profile

The File > Reset User Profile option allows you to update your user profile that the Desktop
Client saves each time you exit.
 The user profile contains positional information for the tree view, the new items window, the
Properties window, and the display settings for the windows, such as whether the windows
are docked or floating. If the To Do List is displayed, the user profile also saves the To Do
List location. When you open the software again, the Desktop Client user interface displays
these windows in the same locations they were when you exited.
 The user profile does not save list view windows or their contents.
Click File > Reset User Profile.

User Options
Change user preferences

The File > Change User Preferences command allows you to set various preferences for the
Desktop Client, including expansion and menu options, window management options, and
configuration setup options.
All settings defined in the Change User Preferences dialog box are saved when you close the
Desktop Client.
Change User Preferences General tab

Defines various user interface settings in the Desktop Client.
Warning dialog number - Sets the number of results to find in a query before the software
displays a warning. The warning dialog number must be less than the maximum query limit.
Maximum query limit - Sets the upper limit for the number of items found in a query.
The Warning dialog number and Maximum query limit settings in the Change User
Preferences dialog box also apply when you right-click an object and display relationships or
relationship edges. Using these settings allows you to improve performance by limiting the
number of objects returned during an expansion.
To Do List refresh interval in minutes - Sets the number of minutes the computer waits before
it refreshes the To Do List.
Default UOM - Sets the default unit of measurement that will be used to display data in the
Properties and list view windows and dialog boxes that display object data. This setting allows
you to select a display set, typically Imperial or Metric. If a default setting is not selected, the
value appears as it was stored in the database.
Picklist item display - Specifies whether item names, descriptions, or both appear for picklist
values in the user interface.
Hyperlink destination - Specifies whether hyperlink targets objects appear in a new window, in
the tree view, or in the New Items window.
Nested reference file level - Specifies the maximum number of levels of reference files that
can be linked to a master file. For example, a Microsoft Word file can link to other files, such as
an Excel file or another Word file and so on, which can, in turn, link to another file and so on.
This setting determines how many levels of relationships are supported.
Format type for e-mail digest - Choose the format in which you want to receive e-mail digest
messages, if applicable. Choose between HTML and text formats. Each e-mail forming part of
the e-mail digest can have HTML links; these links can be turned on or off depending on this
setting.
E-mail digest duration in hours - Indicates the number of hours for which you want to include
notifications in each e-mail digest message. For example, if you set this value to 4, you will
receive one e-mail message every 4 hours that includes notification messages for the previous 4
hours.
Notification type - Allows you to select the type of notification you prefer. Choose between
Notify, which indicates that messages will appear in the List of Notifications window in the
SmartPlant Foundation Desktop Client; Email, which indicates that messages will be delivered
to your e-mail separate from SmartPlant Foundation; or Email and Notify to receive the
notifications in both formats. This option applies only to notifications sent for subscriptions.
Show all items on update references dialog – Select this option to display reference
relationships of all types in the Update Reference Relationships dialog box. Files with a
reference relationship of Always Fixed are displayed as inactive, while files with the reference
relationships such as Always Update, Prompt Update, and Always Update Working

User Options
Revisions are displayed as active or inactive depending on their reference relationships with
the master document. If this option is not selected, the Update Reference Relationships dialog
box is displayed only for files that do not have an up-to-date reference relationship with the
master document. This option is selected by default.
Group e-mail per project - Indicates that e-mail messages included in an e-mail digest
message should be grouped according to the project with which they are associated.
Show description in tree - Specifies whether the description of an item will appear after the
name of the item in the tree view.
Show hidden files - Turns the display of hidden files on or off.
Force uppercase in toolbar - Indicates that text should be forced into uppercase when using
Quick Find on the toolbar.
Print window - Allows you to print only the viewable area of a form.
Display internal object names - Allows you to display the internal names of objects.
This option is only useful for objects that have had their names overridden using the
Display Name system property. Only a system administrator can override an object name; thus,
selecting this option may have no effect on the object name unless a system administrator has
provided a display name that is different from the internal name of the object.
Display internal names for user interface - Allows you to display menu items by their internal
names when configuring menus and forms.
Refresh automatically after right click - Specifies whether automatic refresh on right-click is
enabled. If it is enabled, when you right-click an object, the system checks against the server to
make sure it is up-to-date before you are allowed to perform any actions on the object.
Auto refresh/display To Do List – With this option enabled, your To Do List is refreshed with
new tasks assigned to you each time you complete a workflow action. The system checks the
server for all up-to-date workflow tasks before you can continue working.
Case sensitive quick find - Allows you to find objects in the database using case-sensitive
quick finds. In a case-sensitive search, the software searches for objects that match the case of
the text you type (upper case, lower case, or mixed case).
Visual Style - Allows you to change the visual style of the windows in the Desktop Client.
Change User Preferences Windows tab

Defines the behavior of windows in the Desktop Client.
For changes to the user preference for windows to take effect, you must restart
Single window, always docked - Sets new windows to display as a docked window.
No tabs - Specifies that the list view display will not contain tabs. This option is available only
when you have selected Single window, always docked and means that any information you
are viewing is replaced when new information is displayed.
Multiple floating windows, dockable - Sets new windows to display as floating dialog boxes.
You can dock these windows against any edge of the main window.
Create all new windows as tabs - Enables or disables display of all finds, queries, and
expansions in new windows. Each new window is placed inside one main window as a tab. You
can select the tabs to move between windows, and if you right-click a tab, you can close that
tab. This option is available only if the Multiple floating windows, dockable option is selected.
Create only query windows as tabs - Enables or disables display of all finds and queries that
are grouped inside one main window as tabs. This option is available only if the Multiple
floating windows, dockable option is selected.

User Options
Show relationship expansions as tabs - Enables or disables display of all expansions that are
grouped inside one main window as tabs. This option is available only if the Multiple floating
windows, dockable option is selected.
Display a separate window per configuration - Allows you to open a separate window for
each configuration.
Close windows when the configuration is changed - Closes all list views and refreshes the
tree view when you change your active configuration. Using this option prevents you from
seeing data that was retrieved in the context of a different configuration.
Show tabs in To Do List automatically - Allows you to have the To Do Lists and the List of
Notification tabbed together. This option applies only with the Multiple floating windows,
dockable option.
Modeless forms - Allows you to have multiple forms open at the same time.
Maximize external file viewing windows - Allows you to display the selected file in a separate
maximized window. The system administrator must set two methods to enable this option. The
Display Mode must be set to OPEN for the FileViewNavigate and ViewNavigateFiles
methods.
Change User Preferences Expansion tab

Defines how relationships expand in the Desktop Client.
Expand to new window - Displays items in a new window.
Expand to tree - Displays items in the tree view.
Expand to New Items window - Displays items in the New Items window.
Show submenus on context menus - Groups action shortcut menu commands as submenus
under the Actions menu and also groups relationship shortcut menu commands as submenus
under the Relations menu.
 The Show submenus on context menus preference refers to shortcut menu options
only.
 If the Show submenus on context menus box is cleared, both action and relationship
commands appear in one list of the shortcut menu instead of submenus.
 This option does not affect the default grouping of the submenus.
Always update Properties window to reflect selected item - Enables or disables the display
of properties values. If this item is turned on, right-clicking an item will display its properties in
the Properties window.
Windows Classic menu style - Enables or disables the display of Windows-style menus. If this
option is turned off, the menus display as web-style menus.
The Windows Classic menu style option is available for users with graphic cards that are
incompatible with SmartPlant Foundation. To resolve the incompatibility issue, enable the
Windows Classic menu style feature.
Turn off look ahead on filtered and multi-path relationship (edge) expansion - Turns off the
Look Ahead feature on shortcut menu options that apply to relationship expansions that
traverse multiple objects (using edges). This option applies only when the Look Ahead feature
is enabled. Selecting this option can improve performance for shortcut menus because the
Desktop Client queries the database for less information when you right-click an object.

User Options
Change User Preferences APIs tab

Displays the APIs delivered with SmartPlant Foundation and any custom APIs.
References - Shows any APIs that are included by custom references.
APIs - Shows APIs that are available in SmartPlant Foundation.
Change User Preferences Claim tab

Allows you to set options for claiming objects to a parallel project.
Exclusive claim - Restricts each item so that it may be claimed into only one configuration at a
time.
Explicit claim - Requires users perform a claim operation on an object before editing it.
Implicit claim confirmation - Notifies you that the action you perform will cause the system to
claim the object first. This is the default setting if neither Exclusive claim nor Explicit claim are
selected.
Change User Preferences Default ContainerIDs tab

Allows you to set the Container ID for each object and relationship created in SmartPlant
Foundation. For each type of data, you may choose an existing container form the list or you
may type a new value in the box to create a new container by that name.
SCHEMA - Indicates the container where new SmartPlant Foundation schema objects used to
define all objects within the system will be stored.
SPF - Indicates the container in which to store new common items that do not include
configuration and that do not need to be published, such as ad-hoc reports, folders, templates
suppliers and departments, watermarks and labels.
SPFREFERENCE - Indicates the container in which to store common items that could include
configuration, such as companies, classification items, and plants and projects.
SPFAUTHORING - Indicates the container in which to store new objects created in SmartPlant
Foundation, including documents and tags.
ADMIN - Indicates the container in which to store new data used to configure the SmartPlant
Foundation user interface, such as methods, menus, and the access to each of the items.
DWShared - Indicates the container in which to store new shared objects from published tool
data, including data published from SmartPlant Foundation. Each tool publishes data to a
specific data warehouse domain, and correlated objects are linked through shared objects in
DWShared.
Change User Preferences 3D Viewing tab

Allows you to define individual viewing preferences for symbology when viewing 3D models in
SmartPlant Foundation, such as color, line weight, line style, and render mode.
 If you select an option containing Native, the item appears as defined in the model.
 It is possible to turn off the display of all items except for the selected items. To view all
items in the display again, click Outline/Smooth Shaded. This command also reverses
any symbology changes applied using the 3D Viewing tab.
 Line weight and Line style changes only apply to wire frame items.

User Options
3D model folder - Defines the location for VUE files. If the folder is not specified, the software
does not look for the VUE files.
Streamed 3D data folder - Defines a cache location for streamed 3D data files. By default, your
Temporary Internet Files folder is used to cache 3D data files. Specifying none turns off the
caching.
Selected items
Color - Choose the display color for the selected item(s). From this list box, you can choose to
use the native color, as defined in the drawing, or choose Custom, and click the corresponding
box to choose the color for matching items.
Line weight - Choose the display line weight for the selected item.
Line style - Choose the display line style for the selected item. You can choose to use the
native style from the drawing or select from a number of other line styles.
Render mode - Choose the display render mode for selected items. You can display items with
the render defined in the original drawing, or you can choose to display them as outlines or as
solid objects with shading.
Other Items
Display - Allows for the display of non-selected items. If this option is not selected, only the
selected items appear in the display.
Color - Choose the color in which the non-selected items display. From this list box, you can
choose to use the native color, as defined in the drawing, or choose Custom, and click the
corresponding box to choose the color you want to use for non-selected items.
Line weight - Choose the line weight for which to display non-selected items.
Line style - Select a line style to display non-selected items. You can select the native style
from the drawing or select from a number of other line styles.
Render mode - Choose the display render mode for non-selected items. You can display items
with the render defined in the original drawing, or you can choose to display them as outlines or
as solid objects with shading.

 Change general user preferences (on page 88)
 Change user preferences for windows (on page 90)
 Display objects in a separate window by configuration (on page 91)
 Change user preferences for expansion (on page 91)
 Change user preferences for APIs (on page 92)
 Change user preferences for claiming objects (on page 92)
 Change default containerIDs for new objects (on page 93)
 Change user preferences for 3D viewing (on page 93)

User Options
Change general user preferences

1. Click File > Change User Preferences. The Change User Preferences dialog box opens
to the General tab.
2. Type the number of query results in the Warning dialog number box that you want the
software to find before displaying a warning.
For example, if you set the warning dialog number to 50, the software displays a
warning message box when the query results are greater than 50. You can continue running
the query anyway by clicking OK on the message box.
3. Type the maximum number of query results you want the software to find in the Maximum
query limit box.
For example, if you set the maximum query limit number dialog number to 75, the
software displays the first 75 matching objects encountered in the database.
 If objects are missing in the search results, set the maximum query limit to a higher
number and then re-run the query, for example set the query limit to 3000.
 The Warning dialog number and Maximum query limit settings in the Change User
Preferences dialog box also apply when you right-click an object and display
relationships or relationship edges. Using these settings allows you to improve
performance by limiting the number of objects returned during an expansion.
 The warning dialog number must be less than the maximum query limit.
 You can set SmartPlant Foundation to ignore the Maximum query limit option by using
the Paged Query feature for searches configured to use it. To display the Paging
toolbar, set the Paged Query Size argument on any Query or QFind method. See
Configure Paging Queries in the How to Configure the GUI Model guide.
4. Type how often, in minutes, you want the software to update your To Do List in the To Do
List refresh interval in minutes box.
5. Select a default unit of measurement display set for data sheets, the Properties window,
and other data views in the Default UOM box. Example UOM sets delivered with
SmartPlant Foundation are Imperial and Metric.
6. Select whether to display item names, descriptions, or both in pick lists.
7. Select a destination for clicked hyperlinks.
8. In the Nested reference file level box, specify the number of levels of reference files that
may be linked to a master document.
9. From the list available in the Format type for e-mail digest box, choose the format in which
you want to receive e-mail digest messages. Choose from HTML and text.
10. Type the number of hours for which you want to include notifications in each e-mail digest
message in the E-mail digest duration in hours box.
For example, if you set the e-mail digest duration to 4, you will receive one e-mail message
every four hours that includes notification messages for the previous 4 hours.
11. From the list available in the Notification type box, choose the type of notification you
prefer.
 Notify - Notifications appear in a list view in the Desktop Client.
 E-mail - Notifications are sent through e-mail. You can use the e-mail digest
functionality to group e-mail messages (by project, for example) as described above.
 E-mail and notify - Notifications are sent to the list view and through e-mail.

User Options
This option applies only to notifications sent for subscriptions.

12. If you want to display reference relationships of all types in the Update Reference
Relationships dialog box, select the Show all items on update references dialog option.
If this option is selected, the Update Reference Relationships dialog box displays
the files with reference relationship of Always Fixed as inactive, while files with the
reference relationships, such as Always Update, Prompt Update, and Always Update
Working Revisions, are displayed as active or inactive, depending on their reference
relationships with the master document. If this option is not selected, the Update Reference
Relationships dialog box is displayed only for files that do not have up-to-date reference
relationship with the master document.
13. If you want your e-mail messages in a digest message to be grouped by the applicable
project, select the Group e-mail by project option.
14. If you want to display item descriptions in the tree view, select the Show description in tree
option.
15. If you want to display hidden files, select the Show hidden files option.
16. If you want text forced into uppercase when entering text for searches in the Quick Find box
on the toolbar, select the Force uppercase on toolbar option.
17. If you want to print only the viewable area of a form using the Print command on the form,
select the Print window option. If you do not select this option, the entire contents of the
form are printed when you click the Print command on the form.
18. If you want to display objects by their internal names, select the Display internal object
names option.
The default display name is the display name text as specified in an object definition.
This option and the next option can help system administrator find menus and methods by
their internal names.
19. If you want to display menu items by their internal names when configuring menus and
forms, turn on the Display internal names for user interface option.
20. If you want to turn on automatic refresh for objects, turn on the Refresh automatically after
right click option. If it is enabled, when you right-click an object, the system checks against
the server to make sure it is up-to-date before you are allowed to perform any actions on the
object.
21. If you want to your To Do List to be automatically refreshed with new tasks assigned to you
each time you complete a workflow action, select the Auto refresh/display To Do List
option. If it is enabled, the system checks against the server to make sure it is up-to-date
with all workflow tasks before you are allowed to perform any further workflow actions.
If you experience a performance issue with a large To Do List loading, clear this option.
When it is disabled, only the completed workflow step is refreshed in the To Do List when an
action is completed.
22. If you want to perform case sensitive searches in the Quick Find box on the toolbar, select
the Case sensitive quick find option. By default, this option is not selected; therefore,
SmartPlant Foundation ignores whether the text you type is in upper-case, lower-case, or
mixed case.
23. Select a visual style for the windows in the Desktop Client by choosing one of the Visual
Style options.
All settings defined in the Change User Preferences dialog box are saved when you
close the Desktop Client.

User Options
Change user preferences for windows

3. If you want to display list view windows in one fixed window, with new windows opening as
tabbed items in the same space, turn on the Single window, always docked option. With
this option selected, you can close tabbed items by clicking the X in the top right corner.
This action will not close the window, only the tabbed item. Other windows (such as the New
Items window or Properties window) are unaffected by this option and can be moved,
docked, and undocked.
4. If you want to display list view windows in one fixed window without tabs, select the No tabs
option along with the Single window, always docked option. With the No tabs option
selected, each new list view window replaces the previously opened window. Clicking the X
in the top right corner closes the window.
5. If you want to display list view windows as floating windows, select the Multiple floating
windows, dockable option. Floating windows can be hidden and docked.
6. If you want to display new windows as tabs, select the Create all new windows as tabs
option. If this option is turned off, all new windows appear as separate windows.
7. If you want only query windows to display as tabs, select the Create only query windows
as tabs option.
8. If you want windows that display the results of relationship expansion commands to display
as tabs, select the Show relationship expansions as tabs option. If this option is turned
off, the results will appear in a new window.
9. If you want each configuration to use a separate window, select the Display a separate
window per configuration option.
10. If you want to close all list view windows and refresh the tree view when you change your
active create configuration, select the Close windows when the configuration is changed
option. Using this option prevents you from seeing data that was retrieved in the context of a
different configuration.
11. If you want to have the To Do Lists and the List of Notification tabbed together, select the
Show tabs in the To Do List automatically option.
This option applies only to the Multi floating windows, dockable option.
12. If you want to display multiple forms at the same time, select the Modeless forms option.
This option allows you to leave forms open while performing other activities. For
example, you can leave a create form open while you create or query for dependent data. If
this option is unselected, you must close the current form to perform other activities.
13. If you want to display the files displayed in external viewers in separate, maximized
windows, select the Maximize external file viewing windows option.
The system administrator must set specific options on two methods to enable this
option. The Display Mode must be set to OPEN for the FileViewNavigate and
ViewNavigateFiles methods.
For changes on this tab to take effect, you must restart the Desktop Client.

User Options
Display objects in a separate window by configuration

You can set your user preferences to display objects from different plants of projects in separate
windows.
3. Select the Multiple floating windows, dockable option.
4. Select the Display a separate window per configuration option.
 If you run a query, the Paging toolbar appears on each window when you have multiple
plants and roles set on Set Active Scope, or if you select the Display a separate window
per configuration option.
 Running paging queries is unaffected by multiple window setup or by multiple windows left
open for an unspecified duration. However, to view any updated changes, you must click
Refresh or re-run the query.
Change user preferences for expansion

2. Click the Expansion tab.
3. Select an option for expanding items in the Expansion and menu options frame.
For expansion options, you can select one of the following:
 Expand to new window - Creates a new window and places the expansion results in
that window.
 Expand to tree - Displays expansion results in the tree view.
 Expand to New Items window - Displays expansion results in the New Items window.
4. If you want to organize the shortcut menu command by arranging them into cascading
menus for Actions and Relations, select the Show submenus on context menus option.
5. If you want to display the details for an object on the Properties window when you right-
click that object, select the Always update Properties window to reflect selected item
option. If this option is not selected, then a left-click populates the Properties window.
6. If you want to turn off the Look Ahead feature on shortcut menu options that expand
relationships that traverse multiple objects (using edges), click Turn off look ahead on
filtered and multi-path relationship (edge) expansion. This option applies only when the
Look Ahead feature is enabled. Selecting this option can improve performance for shortcut
menus because the Desktop Client queries the database for less information when you
right-click an object.

User Options
Change user preferences for APIs

The APIs tab displays the loaded custom assemblies and the APIs that are loaded for each
assembly.
Change user preferences for claiming objects

2. Click the Claim tab.
3. To force an exclusive claim, select the Exclusive claim option. An exclusive claim means
that items may be claimed into only one configuration at a time.
This applies to both tags and documents.
4. To force an explicit claim, select the Explicit claim option. An explicit claim means that you
must use the Claim command to claim an object into a sub-configuration to modify it. See
Claim an object (on page 471) for more information.
This option does not apply to documents.

User Options
5. If you want the software to present you with a confirmation dialog box before claiming an
object, select the Implicit claim confirmation option.
 This option does not apply to documents.

 This is the default claim option if neither Exclusive claim nor Explicit claim are
selected.
 The confirmation box notifies you that the action you are performing will cause the
system to claim the object first. For example, if you update a tag in the project
configuration, the system first claims the tag to the project.
The options on this tab are user-level settings and may be overridden by system-wide
preferences set by your system administrator.
Change default containerIDs for new objects

Each object and relationship in SmartPlant Foundation can have a container ID, which is used to
separate the data into sub-groups. When you set a default container ID for a domain, then any
objects and relationships you create are stamped automatically with that container ID. Then, you
can export or query by container ID.
Refer to How to Set Up and Administer SmartPlant Foundation for more information about
container management.
2. Click the Default ContainerIDs tab.
3. Use the down arrows to select the default container ID for each domain, or type a new
container.
Change user preferences for 3D viewing

2. Click the 3D Viewing tab.
3. To define a folder for VUE files, click Change beside the 3D model folder box and select
the appropriate folder.
If the folder is not specified, the software does not look for the VUE files.
4. To define a temporary location for streamed 3D data files, click Change beside the
Streamed 3D data folder box and select the appropriate folder.
By default, your Temporary Internet Files folder is used to cache 3D data files.
Specifying none turns off the caching.
5. Under View Item in Model Symbology, define options for selected items in 3D models
under Selected items.
6. Under Other items, define whether you want other items to appear in 3D models and the
symbology and options for those items.
 If you select an option containing Native, the item appears as defined in the model.
 It is possible to turn off the display of all items except for the selected items. To view all
items in the display again, click Outline/Smooth Shaded. This command also reverses
any symbology changes applied using the 3D Viewing tab.
 Line weight and Line style changes only apply to wire frame items.

User Options

SECTION 4
Search for Objects

The SmartPlant Foundation Desktop Client search functions allow you to find objects based on
your search criteria. You can perform two types of searches in SmartPlant Foundation: queries
and quick finds.
If you install the Full-Text Retrieval (FTR) components, you can also search for documents
using FTR (Full-Text Retrieval). For more information, see Full-Text Retrieval (FTR) (on page
104).
Searching for objects in the SmartPlant Foundation

Desktop Client
You can search for objects multiple ways in the SmartPlant Foundation Desktop Client, based
on detailed information about the object, the name of the object, and the type of object.
Find dialog box

Allows you to perform a quick search for an object by name.
Enter name - Allows you to type your object name search criteria. In some cases, the title of this
option is the name of the kind of item for which you are querying. For example, if you select,
Find > Pipe Line, the name of this label is Pipe Line, rather than Enter name.
Force upper case - Select this option to display all characters in the Enter name box as upper
case. If the option is cleared, you can type upper case and lower case characters in the Enter
name box.
Query dialog box

Allows you to search for an object by the object properties. The options that appear on this
dialog box vary, depending on what type of object you are querying for and how your model was
configured by your system administrator.
Options are available on all standard query forms. The availability of other options is determined
by the system administrator, who configures and manages forms, and depends on the type of
object for which you are searching.
Details
Name - Searches on the name of the object.
Description - Searches against text provided in the description of the object.
ContainerID - Displays the Container ID for the object and relationship.
General details
Creation date - Searches for objects that were created on a specific date. When you click this
box, the Set Date and Time dialog box appears, providing additional options for setting dates
and times for use in queries.

Search for Objects
Create user - Searches for objects created by a specific SmartPlant Foundation user.
Last updated - Searches for objects based on the date on which the object was last changed.
When you click this box, the Set Date and Time dialog box appears, providing additional
options for setting dates and times for use in queries.
All date and time settings are stored in the database in Greenwich Mean Time (GMT), but
Set Date and Time dialog box

Allows you to control the date and time used in a query to return information before, after, or at a
specific time. Additionally, you can specify two dates to request information applicable only
between them.
The calendar at the top of this dialog box allows you to specify the date used in the query. Click
the and buttons to find the correct month, and then click the appropriate date.
Query operation - Indicates if you want to query on, before, or after the selected date, or
between two specified dates.
 = (Equals) - Indicates that the query should return information for only the selected date.
 < (Less than) - Specifies that the query should return information from before the selected
date.
 > (Greater than) - Indicates that the query should return information applicable since the
selected date.
 <> (Between dates) - Specifies that the query should return information from between the
two dates specified in the From Date and To Date boxes.
 From Date - If you selected <> (Between dates), select a date in the calendar and click the
Set button to specify the first date of the query range.
 To Date - If you selected <> (Between dates), select a date in the calendar and click the
Set button to specify the last date of the query range.
Save Query dialog box

Allows you to save a query so that you can run the query later.
Query name - Type a name for the query.
Description - Type a description for the query.
GUI display as - Type the name for the query to use on the shortcut menu. For example, if you
type My Query of Reports, and then click Saved Queries. My Query of Reports appears on
the shortcut menu.
If your system is configured to run a new query from an object in the classification tree
using the shortcut menu, you cannot save the query. Saving queries is only available from the
Query dialog box called from the main Query menu.

Search for Objects
Full Text Search dialog box

Allows you to search for objects or files with properties or content that contain specified search
text. The search is limited to the current query configuration as displayed in the Query scope.
1. Enter the search text in the Text to search box.

2. Select Properties to search only document properties.
3. Select Content to search only content.
Select both Properties and Content to search content along with properties.
4. Select Display matching files to display matching file objects. This option is available when
Content is selected.
5. Click OK to search the typed string.
You can specify advanced search criterion in the Advanced Search Criteria section. This
section is collapsed initially. Click to expand the Advanced Search Criteria section.
The left pane has three tabs:
 File types
 Classification types
 Class definitions
You can specify the advanced search criterion from the available three tabs.

Search for Objects
The advanced search criteria selected is displayed as a tree view in the right pane.
 The tree view is read-only. You can only expand or collapse the nodes in the tree view.
 The selected criteria from the three tabs are displayed in bold in the tree view.

 Find an object (on page 99)
 Query for an object (on page 99)
 Save a query (on page 100)
 Run a saved query (on page 100)
 Update saved queries (on page 100)
 Edit a previous query (on page 100)
 Delete a saved query (on page 101)
 Navigate queries (on page 101)
 Find an object using an FTR search (on page 102)

Search for Objects
Find an object
The Find > <object> command allows you to search by name for objects of the selected type.
1. On the Find menu, click the object for which you want to search.
Type the name of the object for which you want to search.
You can type the entire name, part of the name, a wildcard (%, *, or ?), or a
combination of the name and wildcard (for example, n%).
2. If you do not want to search for only uppercase occurrences of the criteria you typed, clear
the Force upper case option.
3. Click OK to find objects with the criteria you specified.
 You can define options for quick finds on the General tab of the Change User Preferences
dialog box. To display the dialog box, click File > Change User Preferences. To force text
into uppercase for quick finds, check the Force Uppercase in Toolbar option. To perform
case sensitive quick finds, in which the software searches for objects that match the case of
the text you type, check the Case sensitive quick find option.
 To define additional search criteria for a particular object, you can use the commands on the
Query menu.
Query for an object

The Query > <object> command allows you to perform a detailed search based on object
properties for objects of the selected type.
1. On the Query menu, click the object for which you want to search.
2. Type or select your search criteria.
When you perform a search using the * wildcard, you restrict the records returned
based on your criteria. If you perform a search using blank values instead of wildcards, a
query returns all objects in the results because no criteria have been specified. For example,
if you search for an object using Name = * and UID def = *, your search results are reduced
in number because the criteria specifies all objects with a name value AND all objects with a
UID def value.
3. Click Apply or Finish.
 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 QuickFind
menu.
 To save the query, click Save.

Search for Objects
Save a query
1. On the Query menu, click the object for which you want to search.
3. Click Save at the bottom of the Query dialog box.
If the Save is not available, you cannot save the query, see Queries (on page 102)
for further information.
4. Type a name, description, and GUI display value for the saved query. The GUI display value
is the name for the query to use on the shortcut menu.
5. Click OK.
To run the saved query immediately, click OK in the Query dialog box.
Run a saved query

1. Click Query > Saved Queries.
2. On the shortcut menu, click the name of the saved query that you want to run.
Update saved queries

The Query > Saved Queries > Manage Saved Queries command allows you to update or
delete saved queries.
1. Click Query > Saved Queries > Manage Saved Queries.
2. In the Saved Query List, right-click the query that you want to modify, and click Edit Saved
Query.
3. Make changes to the query.
4. Click Save.
Edit a previous query

The Query > Edit Query command allows you to quickly retrieve and modify a previous query,
and re- perform a search without entering all new search criteria. This command is available
from the Query menu of a selected item.
1. Click Query, and click the object for which you want to search.
3. Click OK.
4. To edit the query you just performed, select the list view containing your previous query
results.
5. Click Query > Edit Query to open the Query dialog box.
6. Edit your query criteria, and click OK to query the database again.
 You must activate the appropriate list view to launch the previously used Query dialog data.
 This command is not applicable to the results obtained using quick find.
 You must select a list view before you click Query > Edit Query to edit query criteria.

Search for Objects
Delete a saved query

1. Click Find > Query > Manage Saved Queries.
2. In the Saved Query List, right-click the query that you want to delete.
3. Click Delete.
Navigate queries
When you search for objects using the Find, Query, or Quick Find menus, the results of your
search display one page at a time. The Paging toolbar at the top of the List View window
allows you to navigate the query results page by page.
Your system administrator must configure paging queries for this toolbar to appear. See
Configuring Paging Queries in the SmartPlant Foundation How to Configure the GUI Model
guide.
The Displaying page box shows the page you are viewing and the total number of pages that
can be viewed. By entering a page number in the Displaying page box, you can go to a specific
page in the query. The records appear in an alphabetically sorted list view, sorted by name. You
can click Previous Page and Next Page buttons to view additional pages.
Click Edit Query to change the query criteria (same functionality as Query > Edit Query) and
quickly re-run the query. Refresh allows you to run an update on the current query to get the
latest information.
You can configure the paging toolbar to display the Show All button. Click Show All to view all
the items in the search. For more information, see Configure Paging Queries in the SmartPlant
Foundation How to Configure the GUI Model guide.
When you click Show All, a message displays the number of objects being retrieved.
Click OK to continue.
Standard list view functionality is available, but only for the page currently displayed. For
example, you can use File > Extract List to Excel to export items displayed in the List View to
a spreadsheet as well as print the List View.
 The number of objects that appear on a page is configured by your system administrator.
 The paging query is not available for relationship expansion, any master/details forms or any
ad-hoc reports.
 Sort and Filter commands only work on the displayed pages.
 You can modify the sort order by either clicking a column heading or using the Multiple
Column Sort dialog box.
 Only the displayed page can be printed or exported.
 If the query is smaller than the page limit, the Paging toolbar does not appear.

Search for Objects
 The Refresh Interval set in Change User Preferences is disabled.

 When you want to see a specific page of the query, the software retrieves the results only
for that page and places these in the cache.
 The query is a report of information available at the moment the query is run. If an item is
created or deleted after the original query is run, you can click Refresh or re-run the query
by clicking Edit Query on the toolbar to see the new or updated information.
Find an object using an FTR search

1. Click Find > FTR Search.
2. Under Search Details, type your search criteria in the Text to search box.
You can use the following wildcard and character replacement operators to search for
information: * and ?.
3. Select to search for specific properties or for specific properties or specific text of an object.
4. Click OK.
Learn more about searching for objects in SmartPlant

Foundation
This topic provides additional information about queries, quick finds, and FTR in SmartPlant
Foundation.

 Queries (on page 102)
 Navigating queries (on page 103)
 Quick finds (on page 103)
 Wildcards (on page 103)
 Symbol and special character searches (on page 104)
 Search results (on page 104)
 Full-Text Retrieval (FTR) (on page 104)
Queries
Queries allow you to find objects based on detailed information about the object. These search
options are available from the Query menu. During a detailed query, you can specify search
criteria that applies to several different properties of an object.
The commands that are available on the Find and Query menus are determined by how
your system administrator configures your system.
After you define your search criteria for a query, you can save that query and run it again later.
Saved queries are saved across Desktop Client sessions, allowing you to access queries any
time you are using the Desktop Client. After you save queries, you can also rename queries,
update the search criteria contained in queries, and delete queries.

Search for Objects
If your system is configured so that you can run a query from an object in the
classification tree using the shortcut menu, you cannot save the query. You can only save
queries on the Query dialog box run from the Query menu.
You can use the Query > Edit Query command to retrieve and modify criteria that you
previously used to perform a query. This allows you to re-perform a search without entering all
new data. You can also save the query so that you can run it again later.
You must select the appropriate list view to launch the previously used query dialog data.
Navigating queries
When you search for objects using the Find, Query, or Quick Find menus, a Paging toolbar
appears at the top of the List View window, allowing you to navigate the query results page by
page. For more information, see Navigate queries (on page 101).
Quick finds
A quick find allows you to search for various objects using all or part of the object's name. The
Quick Find options are available on the Find menu and in the Find box on the Desktop Client
main toolbar. During a quick find, you can specify the object name, part of the name, or a
combination of the name and the valid wildcard characters (for example, n%).
Wildcards
The following wildcards can be applied to all searches for fine tuning:
 ? - Finds any single character
 * - Finds any string of characters
 % - Performs the same function as *
 _ - Performs the same function as ?
 Your system administrator can configure the underscore (_) character to be used as a
wildcard that returns any single character (same as the ?) in name searches by setting the
UnderscoreIsWildcard property to True (the default is False) in your site's Property listing in
SmartPlant Foundation Server Manager. For more information on modifying site properties,
see the Server Manager User's Guide.
 You can define options for quick finds on the General tab of the Change User Preferences
dialog box. To display the dialog box, click File > Change User Preferences. To force text
into uppercase for quick finds, check the Force Uppercase in Toolbar option. To perform
case sensitive quick finds, in which the software searches for objects that match the case of
the text you type, check the Case sensitive quick find option.
When you perform a search using the * wildcard, you restrict the records returned based
on your criteria. If you perform a search using blank values instead of wildcards, a query returns
all objects in the results because no criteria have been specified. For example, if you search for
an object using Name = * and UID def = *, your search results are reduced in number because
the criteria specifies all objects with a name value AND all objects with a UID def value.

Search for Objects
Symbol and special character searches

Special characters and symbols (%, *, ? which are true by default, and _ which is false by
default) can be used within the name of an object. For example, an object can be named
ABC%123. When searching objects with symbols or special characters embedded in the name,
a \ must be added to the search criteria immediately in front of the special character. If the \
character does not precede the special character in the search, the special character is used as
a wildcard. For example, to search for ABC%123, enter ABC\%123 (adding the \ between C and
%). The result displays as ABC%123. If ABC%123 is entered for the search, the % character is
used as a wildcard.
Search results
When a search is complete, a list of the matching items displays in a list view window if there is
at least one match. If no matches are found during a quick find or a query, then a dialog box
appears to let you know that no matching results exist in the SmartPlant Foundation database.
Full-Text Retrieval (FTR)

Full Text Retrieval (FTR) is 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. FTR creates an inverted index (a list of the individual words with locations in the
files) and uses this index at search time.
The software provides a user interface to the FTR functionality for both FTR configuration and
retrieval of information where the storage and indexing of objects are automated.
FTR Search
In SmartPlant Foundation, the Find > FTR Search command allows you to search the Full Text
Retrieval index for objects with specific properties or for specific text in the object properties, or
in files attached to documents.
Using Wildcards for Searches

FTR search strings can be complex combinations of search terms and various operators. You
can use methods to limit or extend searches to particular parts of the index.
The order of operations is left to right, but '&' (And) has a higher precedence than '|' (Or), unless
it is grouped in parentheses. Unary operators operate on the search term that follows them.
Search terms can be single words or groups of valid search terms.
You must separate each term or operator (including parenthesis) by a blank space.
Otherwise, the operator (or parenthesis) will be considered as part of a search term. For
example, "!owner & (cat | dog)" is not in a proper syntax. It should be entered as: "! owner & (
cat | dog )". Note that this blank space rule does not apply in ExecSQL, because the search
strings entered in ExecSQL are not parsed (they are required to be in correct SQL syntax).
The values of operators listed in this section are the default values.
Operator Name Description

* Wildcard Expands a single word to all words starting with the
preceding characters. The * can match several
characters, a single character, or no characters. There
must be characters to the left of this operator.

Search for Objects
? Character Expands a single word to all words that exactly match

Replacement the specified letters and have any letter in the location
designated by the ?. The ? can match only a single
character. There must be characters to the left of this
operator.
& And Joins two search terms together and requires both to
be found in a document for the search to be
successful.
| Or Joins two search terms together and requires at least
one of them to be found in a document for the search
to be successful.
! Not Negates a single search term and requires that it not
exist in a document for a search to be successful.
() Group Associates one or more sequences of search terms
and operators. The group notation requires the
contained clause to be evaluated before the other
parts of the search string. This is the only means for
overriding the default order of operations. Grouped
search terms are treated as a single term and can be
negated, combined, and so forth.
 You cannot use single quotes when formatting a search string. Only double quotes are
allowed. You can nest quotes using the / (slash) symbol.
 If special characters, such as * (asterisk), ? (question mark) or " (double quote), need to be
used without being parsed, preceded each special character with an escape character \
(back slash). For example:
ON\-LINE
This would match the following words and phrases.
ON<tab>LINE ON.LINE ON; LINE
ON<newline>LINE ON&LINE ON. LINE
ON LINE ON ; LINE ON\LINE
ON-LINE ON. LINE ON A LINE
ON;LINE ON &LINE
Examples
doc*
Finds all documents containing words starting with doc (for example: doctor, document,
documentary, docket, and doctrine).
13?45
Finds all documents containing words starting with 13 and ending with 45 (for example: 13445,
13845, and 13045).
owner & ( cat | dog )
Finds all documents containing the word owner and the word cat or dog.
owner | cat & dog

Search for Objects
Finds all documents containing the words cat and dog or the word owner. This is due to the fact
that '&' has a higher precedence over '|'. In other words, this search string returns the same
result as: owner | ( cat & dog ).
"past the deadline"
Finds all documents containing the phrase past the deadline.

SECTION 5
Graphical Navigation
Graphical navigation allows you to navigate design files, models, or drawings associated with
document revisions. To navigate the drawing, you can use the drawing view controls. To view
more information about an object in the drawing, you can display the Properties window, and
then select the object in the drawing to view its properties. To see additional information and
actions pertaining to the selected object, right-click the object in the View and Markup window
and use the shortcut menu.
To use graphical navigation, you must have SmartPlant Markup Plus installed on
the same computer with the Desktop Client. For more information about using the Markup
commands, refer to the SmartPlant Markup Plus Help.
When viewing published data in an integrated environment, you may not be able view all
the properties that you published. You can configure view definitions to allow you to see
additional properties. For more information about defining view definitions in the SmartPlant
schema, see View Definitions and Create a View Definition in the Schema Editor User's Guide.
For further assistance with visualizing data in SmartPlant Foundation, contact Intergraph
Support Services.
View and mark up files

The Files > View and Markup command allows you to view design files. If SmartPlant Markup
Plus is installed on your client computer, the file appears inside the View and Markup window
with the SmartPlant Markup Plus commands available for viewing and marking up the file.
For more information about using the Markup commands, refer to the SmartPlant Markup
Plus Help.
If the file is a master file, it can be viewed along with its nested references:
 If the Show Nested Dialog parameter on the Navigate API is set to True, when the
selected object contains one or more masters with associated reference files, a dialog box
showing the nested structure of the reference files is displayed, allowing you to select the
master and reference files to be viewed. If there are multiple masters but no reference files,
a flat structure is displayed for selection. If there is only one master with no reference files,
no selection dialog box is displayed.
 If the Show Nested Dialog parameter on the Navigate API is set to False, when there are
multiple masters, a flat structure is displayed. If there is only one master, with or without
reference files, no selection dialog box is displayed.
 In order to view Microsoft Office files, the software converts the files to .CSF format. When
viewing Microsoft Office files, the default viewer only uses the .CSF file (not the original
Microsoft Office files).
 When you select the View and Markup command for a Microsoft Office file, and the view
rendition (.CSF file) does not exist, it is created automatically if you have selected the View
Rendition Auto Convert option on the SPF System Options dialog box.
 You can manually convert any file type (including Microsoft Office files) by using the
Generate View Renditions command.

The Files menu with this command is available when you right-click certain objects.
 There are limits to the number of drawings/documents that can be opened simultaneously.
This limit varies by hardware and memory resources available on the end-user computer.
Intergraph recommends to not open more than ten documents simultaneously.
 You cannot navigate SmartPlant 3D drawings until the 3D Model has been published.

 View items in SmartPlant Foundation Desktop Client (on page 108)
 Cache 3D model files (on page 108)
 Cache file types to the SmartPlant Foundation server (on page 108)
View items in SmartPlant Foundation Desktop Client

Other commands are available for viewing specific items within drawings. The View Item in
Drawing, View Item in Model, View Continuation Drawing, and View Item in SmartPlant
Review commands provide a variety of tools to allow you to see just the specific items in which
you are interested. The View commands that are available depend upon the specific object you
select. New view controls are available that allow you to more easily navigate 3D models in a
"gaming" environment.
Cache 3D model files

To improve performance when using the View and Markup, View in SmartPlant Review, and
View Item in SmartPlant Review commands, use caching so that the model is retained on the
SmartPlant Foundation client and the local cached model can be used when the same model is
displayed again. Caching means storing data in a place that can be accessed quickly when the
data is needed. Caching makes viewing large files much faster.
To allow caching, specify the Streamed 3D data folder location in the Change User
Preferences dialog box.
To allow caching or learn about other 3D Viewing options, see Change user preferences for 3D
viewing (on page 93).
Cache file types to the SmartPlant Foundation server

You can also specify a list of file types for the SmartPlant Foundation server to cache when the
files are opened. Caching these files instead of opening and decompressing them every time
you view them reduces the time it takes to view large files.
To indicate what types of files you want the server to cache, add file extensions to the list of
Cached File Extensions in SmartPlant Foundation Server Manager. The Cached File
Extensions setting is one of the file service settings of the site. 3D models (with the file
extension .zvf) are included in this list by default.
See Modifying File Service Extensions in the SmartPlant Foundation Server Manager User's
Guide for more information.

View and annotate files

You can view design files attached to document revisions using the View and Markup
command. This command displays the selected file, allows you to provide comments and create
redline layers for a file using SmartPlant Markup Plus (if it is installed on your computer), and
allows you to display properties of a selected object in the Properties window.
You can access the View and Markup command from a document object or from a file attached
to a document. To access the command from a document object, right-click the document and
click Files > View and Markup. To access the command from a file, right-click the file and
select View and Markup.
You must have SmartPlant Markup Plus installed on your local computer to use the
View and Markup command as described here.
View and Markup window for 2D files

When you select a drawing or document revision and display a file attached to it using the View
and Markup command, a window similar to the following example displays within the Desktop
Client and shows the content of the selected file.
To get more information about an object in a drawing, you can click the object in the drawing to
display properties for the object in the Properties window. The Properties window must be
displayed to view the properties of the object.
To see additional information and actions pertaining to the selected object, right-click the object
in the View and Markup window and use the shortcut menu. The available menu commands for
each object contain most of the same commands that you can see when you right-click the
object in a tree or list view.
For more information about using the Markup commands, refer to the SmartPlant Markup
Plus Help.
If you are viewing a SmartPlant P&ID typical plant item, the following layers display by default.
 Typicals
 TypicalsNotes
 TypicalsLabels
 TypicalsHT
 TypicalsHeatTrace
 TypicalsConsistencyChecks
By default, the following layers do not display when viewing a SmartPlant P&ID typical plant
item.
 Default
 Labels
 HeatTrace
If SmartPlant Markup Plus is installed on your client computer, the file displays in
SmartPlant Markup Plus within the View and Markup window.
You cannot navigate drawings or models until they have been published and loaded.
View and Markup window for 3D files

When you select a model drawing from PDS or SmartPlant 3D and select the View and Markup
command, the View and Markup window displays, as illustrated by the following example. The

View and Markup window for models has slightly different commands than the window for 2D
drawings.
Select - Locates one or more objects to apply a specific command.

Locate Filter - Choose the type of items you want to select in the view. The option you choose
from this drop-down list box determines what items in the view can be selected with the Select
Tool. The Features option allows you to select features in the model. The Runs options allow
you to select pipe runs in the model. The All option allows you to select any item in the model
except for runs and features.
Set Colors - Sets the background, selected item, and highlight colors on a drawing. The
background color selection is valid for only the active drawing. The selected item and highlight
colors are saved on a per session basis. That is, each drawing you view until you log off uses
the selected item and highlight color you select.
Outline/Smooth Shaded - Switches the view of the items in the model between an outline
and smooth shaded rendering. In outline mode, objects appear with edges as a single line and
the surfaces solid; edge lines and faces not within the normal view are hidden. In the smooth
shaded mode, objects appear solid with smooth shaded surfaces.
Common Views - Displays a two-dimensional or isometric orientation of objects in the
active view. This command opens the Common Views dialog box, which displays a
three-dimensional wireframe box. This box consists of white circles on each corner and three
white arrows that point to the faces. Each corner circle, arrow, or face of the box highlights in
yellow as you pause the pointer over it. You can select one of the six faces of the 3D box to
change your view to a 2D view, or you can select one of the eight corner circles to change your

view to an isometric view. A message at the bottom of the dialog box indicates the direction or
type of your selection, such as Plan, Isometric, and so forth.
Move Forward/Back, Left/Right - Moves the depth of the view point forward or back in
reference to the object you are looking at in the model when you move the cursor up or down.
Moving the mouse left or right causes the view to rotate left or right.
Pan Up/Down, Left/Right - Increase or decreases the elevation of the view origin when you
move the mouse up or down. Moving the mouse left or right moves the vies in a line parallel to
the far clipping plane.
Rotate Vertical/Horizontal - Tilts the view up or down when you move the mouse up or
down. Moving the mouse left or right rotates the view left and right.
Measure - Allows you to measure points, distances, and minimum distances. Click a point to
display its coordinates in the model. Click a second point to display the distance (both the total
distance and distances along each axis) between the points. If the first click selects an object,
double-click a second object to display the minimum distance (both the total distance and the
distances along each axis) between the objects.
 At any point, you can reset the command by right-clicking to return to a previous step. By
resetting, the last selected point or object becomes the starting point.
 The current measurement is displayed until you press the ESC key or select a different
toolbar command.
Rotate View - Rotates or turns a view freely about the view center or about a principal
vector originating from the view center.
Fit View to Object - Fits a selected object in the model in the active view. Click this
command and then choose an object to set the focus on that specific object.
Zoom Tool - Increases or decreases the display size of objects in the model. You can zoom
in to get a closer view of an object or zoom out to see more of the model at a reduced size. Click
the left mouse button and drag the pointer upward in the window to increase the view of an
object as though you were moving closer to it. Drag the pointer downward in the window to
reduce the view as though you were moving farther away from the object.
Zoom Area - Magnifies an area of the model. Drag or click two points to create a fence
around an object or area of the model that you want to enlarge.
Zoom In - Increases the drawing view magnification so you can better see details in the
drawing.
Zoom Out - Decreases the drawing view magnification so you can better see the overall
drawing.
Fit - Fits all visible objects in the active view.
Pan - Moves the view up, down, left, or right to let you see other areas of the model. The
pointer appears as a hand when this command is active.
SmartPlant Markup Plus - Opens the model for review in the SmartPlant Markup Plus
application. This command opens the view in a new window, outside SmartPlant Foundation.
SmartPlant Review - Opens the model in the SmartPlant Review application. This
command opens the view in a new window, outside SmartPlant Foundation. This functionality is
available only when SmartPlant Review is installed on the local computer. For more information
about the commands available in this view, refer to the SmartPlant Review User's Guide or
SmartPlant Review Help.

Common Views dialog box

Provides a graphical display used to select the angle from which you view the 3D file. Select a
face of the displayed box to view the area two-dimensionally from the specified side, or select a
corner of the box to open an isometric view of the area.
Click one of the eight corner circles to change your view to an isometric view.
Click one of the six faces of the 3D box to change your view to a 2D view.
Click one of the three white arrows that point to a face to see that view.
The text at the bottom of the Common Views dialog box provides a description of the view that
you select.
Lock or Unlock Markup dialog box

Allows you to lock or unlock a group of markup files. This dialog box appears when you select a
revision or a file and use the Lock or Unlock Markup command. If you use that command after
selecting an individual Markup file, use the Lock Layers dialog box.
Current Status - Indicates whether the selected markup file is currently locked or not. To
change the status, click either the Lock or Unlock button.
Lock - Clicking this button locks a markup file. This button is active only if the markup file is not
yet locked, and the status in the Current Status option is Unlocked.
Unlock - Clicking this button unlocks a markup file. This button is active only if the markup file
was previously locked, and the status in the Current Status option is Locked.

Lock Layers dialog box

Allows you to lock saved markup layers to prevent further changes. This dialog box appears
when you select an individual markup file and use the Lock or Unlock Markup command.
Color - Displays the name and a sample of the color used for the elements in each markup
layer.
Description - Provides the brief description entered for each layer when it was first saved.
User - Displays the user name of the person who created each layer.
Date - Indicates the date on which each layer was created.
Lock - Indicates whether each layer has already been locked to prevent changes. Layers with a
Yes value in this column cannot be modified or deleted.
Select All - Quickly selects all the markup layers available for the file and included in the list.
Selected layers are locked when you click the OK button.
Clear All - Removes highlighting from any items in the list of available layers. Selected layers
are locked when you click the OK button.

 View a 2D file (on page 114)
 View a 3D model (on page 114)
 View an item in a drawing (on page 115)
 View an item in a model (on page 115)
 Select a standard isometric or orthographic view (on page 115)
 View a connected drawing (on page 116)
 Use 3D model relationships (on page 116)
 Place a published P&ID in a 3D model (on page 116)
 Print a 3D model (on page 117)
 Lock a Markup file (on page 117)
 Unlock a Markup file (on page 118)
 View alternate files (on page 118)
 View with native application (on page 118)
 Convert files for navigation (on page 118)

View a 2D file
1. Right-click the document that you want to navigate the associated file in the tree or list view.
2. If there are multiple files associated with the selected document revision, select the file that
you want to navigate under the Select column, and then click OK.
 If a single file is associated with the document revision, the file opens automatically
when you click Files > View and Markup.
 When this command is selected, SmartPlant Foundation opens the file in SmartPlant
Markup Plus.
3. Use the drawing view controls on the toolbar to zoom in or out, fit, pan, and magnify different
areas of the view file.
4. To view properties for an object in the Properties window, click Markup > Select Tool
on the View and Markup menu bar, and then click the object in the file.
 If the Properties window is not already displayed, click View > Properties on the
Desktop Client menu bar to display it before you click the object in the view file.
 To view details for an object, right-click the object and click Details.
5. To see additional information and actions pertaining to the selected object, right-click the
object in the View and Markup window and use the shortcut menu.
Shortcut menus for objects work the same when you are navigating a file as they do
throughout the rest of the application.
6. You can use the Markup commands to add comments to the file.
 You must have SmartPlant Markup Plus installed on your local computer to use the Markup
commands.
 For more information about using the Markup commands, refer to the SmartPlant Markup
Plus Help.
 You cannot navigate drawings or models until they have been published and loaded.
View a 3D model
1. Right-click the document revision that you want to navigate the associated file in the tree or
list view and click Files > View and Markup.
2. If there are multiple files associated with the selected document revision, select the file that
you want to navigate under the Select column, and then click OK.
If a single file is associated with the document revision, the file opens automatically
when you click Files > View and Markup.
3. Use the drawing view controls on the toolbar to zoom in or out, fit, pan, and magnify different
areas of the view file.
4. To view properties for an object in the Properties window, click Select , and then click
the object in the file.
 If the Properties window is not already displayed, click View > Properties on the
Desktop Client menu bar to display it before you click the object in the view file.
 To view details for an object, right-click the object and click Details.

5. To see additional information and actions pertaining to the selected object, right-click the
object in the View and Markup window and use the shortcut menu.
Shortcut menus for objects work the same when you are navigating a file as they do
throughout the rest of the application.
 To annotate the file with the SmartPlant Markup Plus commands, you must open 3D files in
an external window of the SmartPlant Markup Plus application. To do this, click SmartPlant
Markup Plus on the toolbar. For more information about using SmartPlant Markup
Plus, see the SmartPlant Markup Plus Help.
 You can also view the file in an external window of SmartPlant Review, if it is installed on
your computer, by clicking SmartPlant Review on the toolbar.
View an item in a drawing

The View Item in Drawing command allows you to view and navigate the drawing file that
contains the selected item. This command is available when you right-click an object.
1. Right-click the drawing item in the list view and select View Item in Drawing.
2. Select a revision of the drawing item, if necessary.
3. Click OK. The drawing displays in the drawing view, with the drawing item highlighted and
zoomed into view. By default, the Rotate View option is active for viewing the model.
This command is available for published plant items only.
View an item in a model

The View Item in Model command allows you to view and navigate the model file that contains
the selected item. This command is available when you right-click a plant item that is displayed
in a 3D model published from the Model Loader software or from SmartPlant 3D.
1. Right-click the plant item in the list view and select View Item in Model.
2. Select a revision of the model file, if more than one is available.
3. Click OK. The plant appears in the model display, with the selected item highlighted and
zoomed into view. By default, the Rotate View option is active for viewing the model.
This command is available when you right-click a plant item that is displayed in a 3D
model published from the Model Loader software or from SmartPlant 3D.
Select a standard isometric or orthographic view

1. Select the view that you want to modify.
2. Click Common Views on the toolbar at the top of the View and Markup window.
3. To select an isometric view, click one of the eight circles.
4. To select an orthographic view, click a white arrow or one of the six sides of the box.

View a connected drawing

The View Continuation Drawing command allows you to view and navigate a drawing that is
connected to the drawing currently in the drawing view. This command is available when you
right-click an off-page connector.
 Right-click the off-page connector in the drawing view and select View Continuation
Drawing to display the connected drawing in the drawing view with the off-page connector
highlighted and zoomed into view.
This command is available for published SmartPlant P&ID drawings only.
Use 3D model relationships

Because of the way information is correlated with items in 3D models, additional relationships
have been added to allow you to show a portion of the model by selecting a related piece and
using a Show command on the shortcut menu.
When navigating in Isometric and Orthographic drawings produced by SmartPlant 3D, you can
select parts, but not features. Because features are correlated in SmartPlant 3D, it is necessary
to be able to select features and view them in the model. You can now use a relationship to
select the part, and from that selection, show the features associated with it.
When you have selected a part in the View and Markup window, a Show Defining Features
command is available from the shortcut menu. Use that command to select the feature rather
than the part.
Once a feature is selected, a shortcut menu option is available to get the associated parts.
Right-click the feature and select the Show Parts option.
Similarly, you are not able to select a pipe run from the drawing view. However, once you have
selected a part, a Show Path Run command is available on the shortcut menu, allowing you to
get the pipe run to view in the model. Once you have selected the pipe run, the Show Parts
command in available on the shortcut menu.
Place a published P&ID in a 3D model

Any published P&ID or isometric drawing can be placed in a published 3D model. The 3D model
must first be displayed. You can select the P&ID, drag the P&ID to the 3D model, and then
release the P&ID where you want it to display. When the P&ID display completes, all 2D plant
items highlight and also display in the Graphic Results tree view pane.
1. Select File > View and Markup to open an existing published 3D model. For details about
the View and Markup command, refer to View and Markup Command.
2. Locate a published 2D drawing (for example, a P&ID drawing).
3. Click to select the published 2D drawing.
4. Drag the selected 2D drawing on to the displayed 3D model.

5. All shared 2D plant items in the 2D drawing and the 3D model highlight. The 2D items also
display in the Graphic Results tree view pane. The color of the displayed 2D drawing item
matches the color displayed in the Graphic Results tree view pane. These colors are
predefined.
Print a 3D model
Any supported 3D model (for example, a SmartPlant 3D model) can be printed using Print on
the 3D toolbar.
1. Click in the 3D model window.
2. Click Print .
Lock a Markup file

The Lock or Unlock Markup command allows you to restrict or allow access to a single or
group of markup files. This command is available when you right-click a revision, a file, or a
markup file.
Select a revision and use this command to lock or unlock all markup files attached to all files of
that revision. Select a file and use this command to lock or unlock all markups files attached to
that file, or select a markup file and use this command to lock or unlock on that specific markup
file.
1. Right-click a revision or file for which you want to lock all markup files or on a specific
markup file that you want to lock, to prevent other users from editing or deleting it.
2. On the shortcut menu, click Files > Lock Markups.
3. Click OK in the confirmation box.

Unlock a Markup file

1. Right-click a revision or file for which you want to unlock all the markup files or on a specific
markup file that you want to unlock, to allow other users to edit or delete it.
2. On the shortcut menu, click Files > Unlock Markups.
3. Click OK in the confirmation box.
View alternate files

The Files > View Alternate command allows you to view the PDF file created from the attached
file, if a PDF file has been generated. PDF files can be generated from attached files if your
administrator has configured alternate rendition for your system.
Alternate rendition is used to take a file that may be specific to a CAD application and generate
a viewable file of a different type. Currently, only PDF file types are configured for output. When
alternate renditions are generated, they are displayed in SmartPlant Foundation for view and
mark up in preference to the original file.
For more information about configuring alternate rendition, see Configure PDF Generation in
How to Configure Document Management.
View with native application

The Files > View Native command allows you to view attached files using the native application
of the file, based on its file extension. For example, using this command, you can open an
attached Microsoft Word (.doc) file in Microsoft Word.
This command also handles the reference files, such that the reference files along with
the master files are displayed in the Native Viewer.
Convert files for navigation

The Convert for Navigation command for documents and viewable files allows you to convert
a single file for graphical navigation without having to convert all files of that type.
 If you set the Conversion required for navigation flag for a specific file type, then files of
that type automatically converts for navigation when the View and Markup command is run.
 If the SmartConverter hotspotting rules are changed and a file has already been converted
for navigation, the Convert for Navigation command converts the file again using the
updated hotspotting rules.
 Refer to Configuring the SmartConverter for Graphical Navigation in the SmartPlant
Foundation Server Customization Guide for more information about the SmartConverter.
 Right-click the file in the list view, and click Files > Convert for Navigation.
A confirmation dialog box indicates that the conversion was successful.
 This command is available for viewable files only.

 If multiple files are attached to a single document, you are prompted to select the file to
be converted.
 You must have SmartSketch installed on the SmartPlant Foundation server, and you
must have SmartPlant Markup Plus installed on the SmartPlant Foundation client to use
this command.

3D Navigation Controls
Select navigation controls that are most comfortable or familiar to you. To access
navigation-specific help at any time, press Q or click Help in the 3D Navigator. To access
additional product help, press F1 or go to the Help menu.
Use the 3D Navigator (on page 124)
Use Keyboard Controls

Arrow keys as well as the gaming standard W (Move In), A (Left), S (Move Out) and D (Right)
are supported.

Use Mouse Controls (Fly Mode)

Press F to enable Fly mode. You have the option to use only your mouse for navigation or to
use keyboard + mouse combinations.
Application-Specific Information
The 3D Navigator component is integrated into the following Intergraph Process, Power &
Marine applications:
 SmartPlant Review
 SmartPlant 3D/SmartMarine 3D
 SmartPlant Construction
 SmartPlant Markup Plus
Any information or behavior that is specific to an application is noted. If your application is not
listed, then there is no additional information.
 See Graphics Card Information (on page 129) for the basic requirements needed for 3D
navigation.
 You can press and hold the 3D Navigator Look and Move controls for continuous motion.
 Press and hold the center Move control to drag the 3D Navigator to a different location
on/off the view window.
Use Keyboard-Only 3D Navigation

You can use the keys below for 3D navigation. The keyboard can be used at all times to move
through the model data set.
The use of WASD keys offers an ergonomic solution when used in conjunction with a
right-handed mouse.
To... Use...
Open quick-help to get Q
information on 3D navigation
controls
Move in W

Move Left A
Move out S
Move right D
Move up E
Move down C
To move or walk through your model in a first-person perspective. Press and hold the
designated direction key. Move left and right is a sidestepping motion.
To... Use...
Move forward and left. W+A
Move forward and right W+D
Move backward and left S+A
Move backward and right S+D
Walk at various angles through your model. Hold down the desired two direction keys
simultaneously.
To... Use...
Look up I
Look left J
Look down K
Look right L
Look around the model as if you were turning your head. Simply move the mouse up/down,
left/right from the crosshair point.
To... Use...
Return to the default, H
isometric home view of your
model
Create your own custom CTRL+H
home view
Reset a customized home CTRL+SHIF
view back to the original T+H
default home view
Press the H key if you are 'lost' in the model or need to return to the default model view.

Use Mouse Only or Mouse + Keyboard Combinations (Fly

Mode)
Fly mode offers a fluid, first-person movement in any direction within your model. In Fly mode
operation, use your mouse to look around as well as work in conjunction with your keyboard for
motion in all directions. You change the viewing direction with the mouse and move around with
the keyboard.
By using mouse-only or mouse + keyboard controls, you can:
 Look 360 degrees around from a stationary point.
 Travel through your model and move up/down stairs and ramps
 Move sideways in a sidestepping motion.
 Move up and down to change your elevation.
When you are in Fly mode, your cursor changes to a crosshair that is located at the center
of your view window. When you exit Fly mode, the cursor changes back to its original pointer.
SmartPlant/SmartMarine 3D Fly Mode Information
 When you exit Fly mode, right-click or press ESC twice to exit 3D navigation.
SmartPlant Construction Fly Mode Information
 To encircle or rotate around a selected object, use the SmartPlant Construction Encircle
Model command in the Toolbox. In SmartPlant Construction, you will not be able to use the
left-mouse drag operation to encircle objects.
Fly mode actions:
To... Use...
Open quick-help to get Q
information on 3D
navigation
Enter/Exit Fly mode F (Toggle to enter/exit)
Exit fly mode, cancel all fly F again (Toggle on/off), ESC or
mode operations right-click
Turn on/off crosshair X (Toggle on/off)
Enter and exit fly mode to use mouse and keyboard combination navigation controls.
To... Use...
Move in Mouse Wheel Forward -or- W
Move in (factor of 2) Middle Mouse Button/Wheel Click
Move left A
Move out Mouse Wheel Backward -or- S

Move out (factor of 2) SHIFT + Middle Mouse Button/Wheel

Click
Move right D
Move up E
Move down C
 Walk through your model in the direction of the crosshair. Roll the middle mouse wheel
forward and back, or press and hold the designated WASD key. A left or right move is a
sidestepping motion.
 A middle mouse click moves you halfway in to your target point. Use SHIFT + middle mouse
click to move back out the distance of the eye point from the target. The perspective angle
does not change.
To... Use...
Move in and left. W + A -or- Mouse Wheel Forward + A
Move in and right W + D -or- Mouse Wheel Forward + D
Move out and left S + A -or- Mouse Wheel Backward + A
Move out and right S + D -or- Mouse Wheel Backward + D
Move left/right/up/down Middle Mouse Drag
 Walk at various angles through your model. Roll the mouse wheel forward and backward
while holding down the designated direction key. Or, hold down the desired two direction
keys simultaneously.
In a key combination move, if you release one directional key, you still continue moving
in the direction of the other key.
 Press and hold the middle mouse button to side-step left or right. This enables you to move
the model without changing the direction in which you are looking.
To... Use...
Look up I -or- Mouse Move Forward
Look left J -or- Mouse Move Left
Look down K -or- Mouse Move Backward
Look right L -or- Mouse Move Right
Look around the model as if you were turning your head. Simply move the mouse up/down,
left/right from the crosshair point.
To... Use...
Return to the default view H
of your model
Create your own custom CTRL+H
home view
Reset a customized home CTRL+SHIFT+H
view back to the original
default home view

Press the H key if you are 'lost' in the model or need to get back to a known view.
To... Use...
Select or De-select objects Left mouse - double click
Encircle or rotate around Left mouse - press and hold
an object
When rotating around an object, the encircle point is the current center point; not the center of
the selected object.
Use the 3D Navigator

The 3D Navigator tool supports the common navigation movements you can perform with the
mouse and keyboard, such as look and move.
SmartPlant/SmartMarine 3D Navigator Information
 To start 3D navigation in SmartPlant/SmartMarine 3D applications, press Ctrl+Shift+F, or
click Navigate View on the main toolbar.
 Select on the 3D Navigator is not available. To select an object, navigate to the required
location in your model and click Navigate View to disable the 3D Navigator. Click Select on
the SmartPlant 3D/SmartMarine 3D toolbar to select objects. Use SmartPlant
3D/SmartMarine 3D commands to perform required operations.
 When you right-click to end fly mode, right-click again to exit 3D navigation.
 The Close button on the 3D Navigator removes it from the display. You can still use the
keyboard for navigation.

3D Navigator Controls
 Quick Help - Displays help specific to 3D navigation.
 Home (Default View) - Returns to the startup view of the model. You can also create your
own home view.
 Fly Mode - Enters Fly mode where you use the mouse and/or keyboard to interactively
move and look through the model. When you are in Fly mode, the 3D Navigator does not
display, and your cursor changes to a crosshair located at the center of your view. You can
press F or ESC to exit Fly mode. The 3D Navigator then displays at its last position.
 Look - Changes your view direction as if you were turning your head. You can look around
in all directions.
 Move In/Out - Takes you closer to or further away from model objects.
 Move (Up/Down/Left/Right) - Changes your position in the model at the crosshair cursor
level as if you are 'walking' around in the model. You can move in any direction.
 Fit - Places all visible elements in the view window if no objects are currently selected. If any
objects are selected, the control zooms to the selected objects.
 Select - Turns Select mode on and off (not available in the SmartPlant and SmartMarine
applications).
After you move your cursor off of the 3D Navigator, it fades into a transparent shadow so that it
does not distract from the current view. The 3D Navigator reappears when you move the cursor
back over it. You can select and move the 3D Navigator to place it wherever you want in or out
of your view window. To use the 3D Navigator, just click on the desired action. A single click
causes short movements while a click + hold action on the look and move controls enables you
to move continuously.
While you are using 3D Navigator controls, you can use the following mouse operations:
 Mouse wheel forward/backward
 Middle-mouse drag to move sideways and up/down in the model.
You can also use the keyboard in conjunction with the 3D Navigator to move in one direction
while looking in another. This can simulate walking through the plant as you are looking on
either side.
 The 3D Navigator controls are synchronized with the mouse and keyboard movements to
display the current move or look action. For example, if you are pressing W to move in, the
Move In button in the 3D Navigator is highlighted.
 When you are in Fly mode, the 3D Navigator does not display.
Return to Default View

Click the Default View or Home control at any time to return to the default top-right isometric
view of your model.

Enter Fly Mode

You can start Fly mode from the 3D Navigator by clicking the Fly Mode control .
SmartPlant/SmartMarine 3D Fly Mode Information
 When you exit Fly mode, right-click or press ESC twice to exit 3D navigation.
You can also press the F key to start fly mode.
 After you enter Fly mode, the 3D Navigator no longer displays. Use your mouse and
keyboard to move around through the model.
 To exit Fly mode, right-click, press F again or press ESC. The cursor changes back to its
original icon and the 3D Navigator displays.
 In Fly mode, your cursor changes to a crosshair that is located at the center of your view
window.
Look Around
Press and hold any of the four Look controls to continuously look or turn in that direction as if
you were turning your head. Use the Look control in the 3D Navigator to look around from your
current position in the model.
Move
Move vs. Zoom: a Move operation changes the eye point as you get closer or further from the
target. A Zoom operation is a perspective angle change.
 Use the Move controls in the 3D Navigator to walk smoothly in left/right/up/down directions.
 Use Move In/Out controls to get closer to or further away from model objects. The
perspective angle does not change during a move operation.
 Press and hold any of the Move controls to continuously move in that direction.
 As you move through the model, the closer you get to your target, the slower the movement
rate becomes. The further away from the target, the faster the movement rate.
 The Move operations enable you to move through solid objects such as walls, doors and
slabs.

Select an Object
Click Select as you navigate around your model to select an object.
SmartPlant Construction Select Information
 To encircle or rotate around a selected object, use the SmartPlant Construction Encircle
Model command in the Common Tools toolbox.
SmartPlant Markup Plus Select Information
 A question mark icon displays to indicate the QuickPick feature is enabled. Use QuickPick
to select an object in a dense or crowded area. Each of the numbers in the QuickPick tool
corresponds to an object in the area and is highlighted when you select the number.
SmartPlant/SmartMarine 3D Select Information

 When an object is selected, press and hold the left mouse button to encircle or rotate
around the object. The encircle point is the current center point; not the center of the
selected object(s).
 Select mode stays active until you click the Select control in the 3D Navigator.
 You can use the CTRL key to select multiple objects.
SmartPlant Review Select Information

 Click Select in the 3D Navigator to enable the SmartPlant Review Select mode.
 When you select an object, it remains highlighted until you select another object or press
ESC.
 Select mode/Auto-Highlight stays active until you select any other Mouse Drag mode.
Fit to Object(s)
The Fit tool places all visible objects in the active view if no objects are currently selected. If any
objects are selected, the command zooms to the selected elements. Because the display is
adjusted independently of the current view orientation, the objects in that display area are not
clipped when performing rotate operations.
In addition, the Fit tool zooms or fits to any objects that were selected before running 3D
navigation.
SmartPlant Review Fit Behavior
In SmartPlant Review, the Navigator Fit command is a conditional fit. It performs a fit based on
the objects that are selected.
 Fits to the selected object.
 Fits to selected item(s) in the SmartPlant Review Project Manager.

 Fits to the whole model and any visible objects.
1. Select one or more objects in the current view.

2. Click Fit on the 3D Navigator.
The system flies to the selected objects.
 If no objects are selected, the system fits all objects into the current view.
 You can also perform a SHIFT + Fit operation that enables you to view the entire
selected object within the current window size. Any rotation operations later performed
in that view do not clip the selected object.
3. When you perform a Fit operation, you can continue selecting other objects as well as
moving from the fitted location.
3D Navigation Tips
Motion Tips
 As you move through the model, the closer you get to your target, the slower the movement
rate becomes. The further away from the target, the faster the movement rate.
 The Move operations enable you to move through solid objects such as walls, doors and
slabs.
 Press ESC to end a navigation operation.
 To make small left/right/up/down movements, click and hold the middle mouse button as
you move in the desired direction. It can sometimes be difficult to make small movements
with the mouse and keyboard because the distance of motion for each key press is greater
than what is needed. This is especially true when you are close to objects within the 3D
model.
SmartPlant/SmartMarine 3D Navigation Tips
The Navigate View command always sets the current tilt angle to 0 when it is enabled. The
system does not restore the previous tilt angle when 3D navigation is turned off. To get back to
the rotated view you were using before entering 3D navigation, select View menu > Previous
View.
Fine Tuning/Customization
 You can change the Repeat Delay and Repeat Rate keyboard settings to fine-tune your
keyboard motion during navigation. For more information, refer to your operating system's
documentation on setting keyboard properties.
Messages
The color scheme has been changed to [Windows Vista Basic/Windows 7]. A running
program isn't compatible with certain visual elements of windows.
 Meaning: This message may display when you open a 3D model. To correctly display the
cross hair (in fly mode) as well as support all capabilities of this operating system, the
application automatically unchecks the Enable desktop composition setting. This setting is
in Control Panel > System > Advanced system settings > Advanced tab > Performance
Settings > Visual Effects.

 Recovery: If you click to see more information on the message, the Windows information
dialog box displays. Check the Don't show me this again option if you do not want the
above message to display each time a 3D model is opened.
Graphics Card Information

To take advantage of the performance enhancements available for viewing 3D models, your
graphics card needs to have at least the minimum requirements listed below. Cards with less
than the minimum requirements are supported; however, they might not be able to successfully
use all the performance enhancements.
Minimum Recommended
(for systems with large
models)
OpenGL 2.0 OpenGL 2.1 or later
128 MB RAM 512 or more MB RAM
Additional requirements and/or recommendations for cards include:
 In general, workstation-level graphics cards provide better overall performance with 3D
model files than desktop graphics cards.
 The card must be manufactured within the last three years.
 Use updated drivers (at least within the last 6 months).
Systems running Citrix and remote desktop applications currently do not support
the hardware acceleration performance enhancements.

Troubleshoot 3D Navigation
Graphics Card Troubleshooting
You do not see graphics in the window display of a dual-monitor setup when using an
ATI V3600 FireGL (driver ver. 8.62 released on 7/21/2009) card.
Follow the steps below to configure graphics card.
1. Select Start > Catalyst Control Center.
2. Select Workstations > Settings.
3. Click Shared Front/Back/Z Dual Screen Mode.
4. Click OK and then exit the application.
5. Reboot your system.
The 3D Navigator is flickering.
Check your card properties and make sure you have Hardware Acceleration enabled.
 Checking Hardware Acceleration Settings - Microsoft Vista/Windows 7 Instructions (on page
132)
 Checking Hardware Acceleration Settings - Microsoft Windows XP Instructions (on page
135)
For NVIDIA Quadro cards (Windows XP), you can turn off the Overlay setting in the NVIDIA
control panel.
1. Open the NVIDIA Control Panel application.
2. Go to 3D Settings > Manage 3D Settings.
3. Select Off for the Enable Overlay setting.
4. Save your change and close the application.
General Display Issues

The 3D Navigator tooltips are flickering.
Set the transition effect for menus and tooltips to the Scroll Effect:

1. From your desktop, right-click and select Properties to open the Display Properties dialog
box.
2. Click the Appearance tab.

3. Click Effects and select Scroll Effect under the Use the following transition effect for
menus and tooltips setting.
4. Click OK to save your change.

5. Click OK to close the Display Properties dialog box.
General Messages
The color scheme has been changed to [Windows Vista Basic/Windows 7]. A running
program isn't compatible with certain visual elements of windows.
 Meaning: This message may display when you open a 3D model. To correctly display the
cross hair (in fly mode) as well as support all capabilities of this operating system, the
application automatically unchecks the Enable desktop composition setting. This setting is
in Control Panel > System > Advanced system settings > Advanced tab > Performance
Settings > Visual Effects.

 Recovery: If you click to see more information on the message, the Windows information
dialog box displays. Check the Don't show me this again option if you do not want the
above message to display each time a 3D model is opened.
Checking Hardware Acceleration Settings - Microsoft

Vista/Windows 7 Instructions
The images used in the steps below show NVIDIA card settings, which represent just one
type of card that can be used. These images are intended to be used only as examples. The
settings for your graphics card may differ from those shown in the steps below.
1. Select Start > Control Panel.
2. Select Appearance and Personalization > Display Settings.

3. Click Advanced Settings.

4. Click the Troubleshoot tab.
If your driver does not allow changes (as shown in the above image), you may have
to contact your video card manufacturer for instructions on turning on/off hardware
acceleration.

5. If available, click Change settings.
6. Move the Hardware acceleration slider bar to Full.

7. Click OK to save edits and exit the dialog box. Click OK again to exit the Display Settings
dialog box.
Checking Hardware Acceleration Settings - Microsoft

Windows XP Instructions
The images used in the steps below show NVIDIA card settings, which represent just one
type of card that can be used. These images are intended to be used only as examples. The
settings for your graphics card may differ from those shown in the steps below.
1. Select Start > Control Panel > Display.

2. Click the Settings tab in the Display Properties dialog box.
3. Click Advanced.

4. Click the Troubleshoot tab.
5. Move the Hardware acceleration slider bar to Full.

6. Click OK to save edits and exit the dialog box. Click OK again to exit the Display
Properties dialog box.
Clip volumes
A clipping volume in SmartPlant 3D is a 3D wireframe box that can be manipulated to limit the
objects that can be seen in a view. The Clip Volume command displays the clip volume box in
the model along with the Clip Volume dialog box that lets you select which clipping plane
face(s) are being adjusted. The size or range of the clipping volume depends on the number of
objects that you have selected in the model. If there are no selected objects, the clipping volume
defaults to half of the total size of the loaded model. When clipping is turned on in the Clip
Volume dialog box, SmartPlant 3D displays only the objects within the wireframe clip volume
box.
Clip Volume Wireframe

The clip volume wireframe is a 3D wireframe box that overlays the model and is used to set the
clipping volume. You can edit the size of the clip volume wireframe to limit the objects that can
be seen in a view. The Clip Volume dialog box provides the controls for manipulating the size of
the clipping volume as well as turning clipping on and off. When clipping is on, SmartPlant 3D
displays only the objects within the clip volume wireframe.

Things to Know
 The clip volume wireframe cannot be extended beyond the current model range. In addition,
the clipping volume cannot be reduced to the point where there is no width, height, or depth.
 The clip volume wireframe only displays when the Clip Volume command is enabled. When
the Clip Volume dialog box is closed, the clip volume box is dismissed.
 If the Clipping Control is enabled when the Clip Volume dialog box is closed, clipping
volume remains on.
 For more precise control when resizing the clip volume wireframe, click the slider in the Clip
Volume dialog box and then use the mouse wheel, the Up/Down arrow keys, or the
PgUp/PgDn keys to adjust the clipping volume. The Up/Down arrow keys move the clip
volume wireframe in small increments while the PgUp/PgDn keys move the box in larger
increments.
 Click the slider and then press the Home key to move the slider bar to the top, and expand
the clip volume wireframe. Click the slider and then press the End key to move the slider bar
to the bottom and reduce the clip volume wireframe.

 If the slider is at its limits (top or bottom position), click again on the face or faces being
adjusted to reset the slider position to the middle. The slider can only expand the selected
clipping volume face(s) to double the initial amount from its starting middle position.
 The solid red line on the clip volume wireframe indicates the plane face(s) being adjusted. A
solid yellow line indicates the face(s) that are not moving.
 The number of objects selected in the model when you click Clip Volume determines the
size of the clip volume box. If one object is selected, the clip volume wireframe surrounds
that object. If multiple objects are selected, the clip volume wireframe covers the area to
surround all the selected objects. If no objects are selected, the clip volume wireframe is
placed in the center of the model.
 You can use Clip Volume in conjunction with Common Views to synchronize the
orientation of the model and the clip volume box. When you use the Common Views dialog
box to select a view orientation, you can then open the Clip Volume dialog box, which has
the same view orientation selected.
 To expand plane face(s) to more than twice the distance, select the same plane face(s) in
the Clip Volume dialog box again.
Clip Volume dialog box

Provides a graphical display and controls to set and modify the clip volume box size, and turn
clipping on and off. For ease of use, the three-dimensional box in the Clip Volume dialog box is
similar to the one used in the SmartPlant 3D Common Views dialog box. The Clip Volume
dialog box can be moved anywhere in or out of the display window.
Clip Volume Wireframe - Supports the following operations:

 Click one of the eight corner circles to set the volume plane faces that you want to use in
resizing the clipping volume.
 Click one of the six faces of the volume box you want to use in resizing the clipping volume.
In addition, you can click one of the arrows to select the Bottom, Back, or Right face of the
clip volume box.
 If you click in the gray area of the dialog box outside the volume box, all faces of the clip
volume box are adjusted simultaneously.

In the example below, the Top Front Left corner is selected. This selection causes the
corresponding clip volume box to highlight (solid red lines) the faces that will move when
you use the slider.
 The clipping plane face(s) not being adjusted display as solid yellow lines.
 The clipping plane face(s) that are being adjusted display as solid red lines.
Make sure your background color is not set to red or yellow so that you can see the clip
volume lines.
Clip Volume Adjustment Slider - Dynamically changes the extent of the clipping volume. Move
the slider up to expand the side up to twice its original size. Move the slider down to shorten the
side to half its original size.
Clipping Control - Turns clipping on or off. When the icon is pressed, clipping has been
enabled and all objects outside of the clipping volume clip are not displayed in the view.
Closing the Clip Volume dialog box does not turn off volume clipping if the Clipping
Control is enabled.
Clip Volume Wireframe Face Selection - Provides an alternate way of selecting plane faces in
the volume box. Use the menu list to select the plane face(s) that you want.

 Set a clipping volume (on page 141)
 Turn off volume clipping (on page 142)

Set a clipping volume

Before you begin, review the setup tips below. These tips are some things that you can do to
make the clipping operations easier.
 Select the graphic objects or display sets that you want to work with. The clip volume
wireframe defaults to the volume that covers all the selected items. If there are no selected
items, the clip volume wireframe defaults to half the volume of the currently-visible model.
 Use the Common Views dialog box to select a view orientation. The Clip Volume dialog
box opens to have the same view orientation. This helps orient you when adjusting the clip
volume wireframe.
 When a clip volume is active, the model Fit commands and functionality are always fit to the
clip volume range.
1. From your 3D model view, click Clip Volume .
A clip volume wireframe displays surrounding any selected objects.
If no objects are selected, the clip volume wireframe is placed around the center of
the entire dataset range.
2. From the Clip Volume dialog box, select the face or corner (faces) that you want to size.
The example below shows the Top Front Right plane faces have been selected.
3. Click and drag the slider up to increase the clip volume wireframe size, or down to reduce
the size as needed. The example below shows the Top Front Right plane faces being
expanded.
 For more precise control when resizing the clip volume box, click the slider in the Clip
Volume dialog box and then use the middle mouse wheel, the Up/Down arrow keys, or
the PgUp/PgDn keys to adjust the clipping volume. The Up/Down arrow keys move the
clip volume box in small increments while the PgUp/PgDn keys move the box in larger
increments.
 Click the slider, and then press the Home key to expand the clip volume wireframe to
the current maximum for the current selected face(s) being adjusted. Click the slider
and then press the End key to minimize the clip volume wireframe for the current
selected face(s) being adjusted.
 If the slider is at its limits (top or bottom position), click again on the desired face or
faces being adjusted to reset the slider position to the middle. The slider can only
expand the selected clipping volume face(s) to double the amount from the starting
middle position.
 The selected face(s) being adjusted display in red in the clip volume wireframe. The
unselected face(s) not being adjusted display in yellow.

4. When the clipping volume is at the required size and location, click Clipping Control in
the Clip Volume dialog box. All objects that are not in the clip volume wireframe are
removed from the display, as shown in the example below.
Clipping Off: Clipping On:
You can perform a zoom or fit to get closer to the displayed objects and continue your work.
Selecting the Fit command automatically takes you to a fitted view of the selected objects
in the view, if any. If no objects are selected, Fit takes you to a fitted view of the active clip
volume. If there is no active clip volume, Fit takes you to a fitted view of the entire model.
Turn off volume clipping

 To turn off volume clipping, click Clipping Control on the Clip Volume dialog box.
After clipping is turned off, all model objects are restored in the view.
 To remove the clip volume wireframe, close the Clip Volume dialog box.
Closing the Clip Volume dialog box does not turn off volume clipping. If the Clipping
Control is enabled when the Clip Volume dialog box is closed, volume clipping remains in
effect.

SmartPlant Review with SmartPlant Foundation

In addition to the current streaming 3D viewing capability already supported by SmartPlant
Foundation, SmartPlant Review can be used to view SmartPlant 3D, PDS 3D, and AVEDA
PDMS models.
SmartPlant Review can display properties from SmartPlant Foundation and the integrated
environment. However, SmartPlant Foundation properties are available only when you access
SmartPlant Review from within SmartPlant Foundation.

 Launch SmartPlant Review from SmartPlant Foundation (on page 143)
 View an item in SmartPlant Review (on page 144)
 View a model in SmartPlant Review (on page 144)
 Build display sets (on page 144)
Launch SmartPlant Review from SmartPlant Foundation

You can access SmartPlant Review from within SmartPlant Foundation in three ways:
 Launching SmartPlant Review from the 3D Viewer - In the 3D viewing environment, the
SmartPlant Review toolbar button allows you to launch SmartPlant Review with the
same view of the model that is currently shown in SmartPlant Foundation.
 Launching SmartPlant Review from the Shortcut Menu in a 3D Model - To display the
3D model in SmartPlant Review, right-click the model in the list view and select View in
SmartPlant Review. In this case, SmartPlant Foundation does not attempt to manipulate
the view or orientation of the model. SmartPlant Review determines the initial view and
orientation of the model.
 Launching SmartPlant Review from a Plant Item in a 3D Model - To display plant items,
such as instruments or equipment, right-click the item in the list view and select View in
SmartPlant Review. If the plant item is contained in exactly one 3D model, the 3D model is
displayed in SmartPlant Review and the view is fitted to the plant item. If the plant item is
contained in more than one 3D model, a list of the 3D models containing the plant item
displays for you to choose which model to view. This command is available only for
published plant items.
 Regardless of which method you use to open SmartPlant Review from SmartPlant
Foundation, SmartPlant Review always displays in a separate window, rather than inside the
existing SmartPlant Foundation window.
 You can launch only one session of SmartPlant Review for each active session of
SmartPlant Foundation. If you attempt to open a second SmartPlant Review session from
SmartPlant Foundation, the first SmartPlant Review session is closed before the new one
opens.

View an item in SmartPlant Review

The View Item in SmartPlant Review command allows you to launch SmartPlant Review to
review an item from a 3D model.
 Right-click the plant item in the list view and select View Item in SmartPlant Review.
 This command is available only for published plant items.

 This functionality is available only when SmartPlant Review is installed on the local
computer.
 When viewing data published from an authoring tool, you may not be able view all the
properties that you published. You can configure view definitions to allow you to see
additional properties. For more information about defining view definitions in the SmartPlant
schema, see Working with View Definitions and Create a View Definition in the Schema
Editor User's Guide. For further assistance with visualizing data in SmartPlant Foundation,
contact Intergraph Support Services.
View a model in SmartPlant Review

The View in SmartPlant Review command allows you to launch SmartPlant Review to view a
3D model. This command is available when you right-click a model in the list view.
This functionality is available only when SmartPlant Review is installed on the local
computer.
 Right-click the model you want to view in the list view and select View in SmartPlant
Review.
Build display sets

SmartPlant Review allows you to create a display set based on integration criteria. SmartPlant
Review displays the list of available item types. When you select an item type, SmartPlant
Review allows you to specify criteria for integrated properties when defining the display set.
When the display set is defined, SmartPlant Review queries SmartPlant Foundation for objects
that satisfy the criteria. The objects satisfying the criteria become the SmartPlant Review display
set. This functionality is available from SmartPlant Review only when it was accessed from
SmartPlant Foundation, as previously described.
When using SmartPlant Review in conjunction with SmartPlant Foundation,
SmartPlant Foundation properties associated with a graphic object displayed in SmartPlant
Review may not directly correspond to the SmartPlant Foundation data available for creating
display sets when using the Item Type query, unless you specifically create view definitions
(Item Types) that map directly to the Property categories, names, and values. For more
information about working with view definitions, refer to the Schema Editor User's Guide.

SECTION 6
Create and Modify Objects

In the SmartPlant Foundation Desktop Client, you can create a variety of objects, depending on
your role assignment and user permissions within a project. You can create objects in
SmartPlant Foundation Desktop Client using a wizard or a dialog box.
You can create some types of objects, like tags and documents, using a wizard, which you can
access by clicking File > New and clicking the type of object that you want to create.
You can use the New Design Document wizard (click File > New > Design document) to
define the document classification, name, description, and other properties. You can also attach
one or more design files to the document.
The commands available on the File > New submenu vary depending on your role
assignment and user permissions within a project.
Not all objects on the File > New submenu have Create wizards associated with them. You can
create these types of objects using dialog boxes or forms. You can access the dialog box for
creating an object in one of two ways:
 If the object appears on the File > New menu, you can click File > New > <Object Name>
to create the object.
 Browse to the type of object that you want to create in the Tree view, right-click the object
type, and then click Create <Object Type> on the shortcut menu.
When using integration, engineering objects are created when a document is published.
In the Desktop Client, you can copy existing objects and modify them as necessary. You can
also update and delete objects as needed.
 When you delete an object, the object is permanently removed from the SmartPlant
Foundation database.
 When you delete a document object, you also delete the attached files from the vault.
 If you do not want to permanently remove the object from the database, use the Terminate
command instead of the Delete command. Using this command preserves the history of the
object in the database.
New <Object> dialog box

Allows you to define properties for creating an object in the Desktop Client.
Main Details
Name - Type the name of the object you want to create.
Description - Type a description of the object you want to create.
 The commands available on the File > New submenu vary depending on your role and user
access.
 The fields available on the New dialog box vary depending on the type of object you are
creating.

Copy dialog box

Allows you to define properties for copying an object in the Desktop Client.
Main details
Name - Displays the name of the object. When creating a copy of an existing object, replace this
value with a new, unique value.
Description - Displays the description of the object.
The fields available on the Copy dialog box vary depending on the type of object you are
copying.
Update dialog box

Allows you to modify properties for an object in the Desktop Client.
Main details
Name - Displays the name of the object. In most cases, this value is read-only.
 The fields available on the Update dialog box vary depending on the type of object you are
copying.
Details dialog box

Allows you to review the existing properties for an object in the Desktop Client.
Main Details
Name - Displays the name of the object.
General Details
Creation date - Displays the date on which the object was created.
Last updated - Displays the date on which the object was last changed.
 The information available on the Details dialog box vary depending on the object.
History dialog box

Allows you to view the update history of the selected object. A green icon indicates current
information, while information that has been updated is displayed in gray lines and marked with
a blue icon.

Object details
Name - Displays the name of the object.
Description - Displays a description of the object.
Options
Hide historic data - Removes historical values from the display and displays only the current
values. Historical values are property values that have been updated. Historical values are
displayed in gray, have a blue icon indicator, and show a termination date and termination user.
Show inconsistencies only - Displays only properties that have inconsistent values between
SmartPlant Foundation and authoring tools.
Show tree - Adds a tree view that displays the object’s properties by interfaces and
relationships.
Property data
Class Definition - Displays the class definition that provides each property if the object is a
complex object, such as a document, that represents more than one class definition.
Additionally, this column may indicate the row provides information about a relationship rather
than a property.
Object - Displays the name of the object, or Rel, that indicates the row provides information
about a relationship rather than property data.
Interface - Displays the interface definition related to the object.
Property - Displays the properties for which values can be set, or the name of the relationship
definition represented by the row.
Value - Displays the values that are set for the object, or the name of the object on the other
end of a relationship.
Source Domain UID - Displays the unique identifier for the source domain of the relationship.
Creation Date - Displays the date the value was provided or the relationship was created.
Creation User - Displays the user that provided the value or created the relationship.
Termination Date - Displays the date the value was replaced or the relationship was
terminated.
Termination User - Displays the user that updated the value or terminated the relationship.
Export to Excel - Exports the information displayed in the Property data table to a Microsoft
Excel spreadsheet.
Print - Prints the history displayed in the Property data table.
Change Owning Group dialog box

Allows you to change the owning group for an item. The owning group (group of users) specifies
the vault where documents or files attached to the object are stored.
<Object> Information
Type - Displays the class definition of which the item is an instance. This option is for display
only.
Name - Displays the name of the item. This option is for display only.
Description - Displays the description of the item. This option is for display only.
Owning group - Displays the current owning group for the item. Select a different value from
this list menu to associate the object with a different owning group.

Owner - Display the current owner for the item. Select a different user from this list menu to
assign a different owner of the object.

 Create a new object using the Create wizard (on page 148)
 Create a new object using the Create dialog box (on page 152)
 Copy an object (on page 153)
 Update an object (on page 153)
 Delete an object (on page 153)
 Terminate an object (on page 154)
 Display details for an object (on page 154)
 Display the history of an object (on page 154)
 Change the owning group for an object (on page 154)
Create a new object using the Create wizard

1. Click File > New and then click the type of object that you want to create. For example, to
create a new design document, click File > New > Design Document.
 The commands available on the File > New shortcut menu vary depending on your
SmartPlant Foundation configuration.
 You can use the wizards to create various types of documents and tags in SmartPlant
Foundation.

2. In the tree view, click the classification for the new object. For example, to create a P&ID
document, click Utility P&ID under P&ID Documents.
3. Click Next.
4. Define details for the new object. For example, during document creation you can specify
the name, description, owning group, and revision information for the document.

Blank spaces in the Name field are treated as underscores in SmartPlant

Foundation. SmartPlant Foundation treats an underscore or a blank space in the object
name. For example, if you name a design document Document 1, SmartPlant Foundation
recognizes the object as Document_1.
 An asterisk (*) indicates that an option is required to create a new object.

 The system administrator defines the sections that appear on the pages in the wizard.
 Click the plus (+) sign to expand a section or click the minus (-) sign to collapse a
section.
 Click Collapse All to close all the sections at once, or click Expand All to open all the
sections at once.
 For more information about using collapsing sections on forms, see Collapse sections
on forms (on page 53).

5. For objects with additional details or actions, click Next. For example, the next page in the
document creation wizard allows you to attach files to the document.
6. Click Finish to create the object.

You can also click Apply to create the object and keep the wizard open in order to
create additional objects.
 New objects are added to the New Items window as you create them.
 You can also create an object by navigating to the object type in the Tree view, right-clicking
the object type, and then clicking New <Object Type>.

Create a new object using the Create dialog box

The File > New > <Object Type> command allows you to create a new object of the specified
type.
1. Click File > New > <Object Type>. For example, to create a new centrifugal pump, click
File > New > Pump.
Blank spaces are treated as underscores in SmartPlant Foundation. You can either
use an underscore or a blank space in the object name, SmartPlant Foundation treats them
both as the same. For example, if you name a design document as Document 1, SmartPlant
Foundation recognizes the object as Document_1.
2. Define details for the new object, including the name and description.
Options followed by an asterisk (*) are required to create the selected object.
 New objects are added to the New Items window as you create them.
 You can also create an object by navigating to the object type in the tree view, right-clicking
the object type, and then clicking New <Object Type> on the shortcut menu. Your
configuration may be different.

Copy an object
The Copy command allows you to create a copy of the selected object.
Once you have created the new copy, you can update properties, add files, or modify the copy
in any way necessary. For most objects, you must provide a unique name for the new object you
are creating.
1. Right-click the object that you want to copy.
2. Click Copy on the shortcut menu.
3. In the Copy dialog box, make changes to the properties for the object you copied.
Options followed by an asterisk (*) are required.
The new object appears in the New Items window.
Update an object
The Update command allows you to update the properties for the selected object.
1. Right-click the object that you want to update.
2. On the shortcut menu, click Update.
3. Type the updated information in the boxes as necessary.
4. Click Finish.
Asterisks (*) indicate required information.
 The system administrator defines the required options.

 Your configuration may vary. The Update command may appear on a submenu from the
shortcut menu, such as Documents > Update document.
 Your role assignments determine which objects have access to the Update command.
Delete an object
The Delete command allows you to delete the selected object.
1. Right-click the object you want to delete.
2. On the shortcut menu, click Delete.
3. Click OK in the confirmation dialog box.
command instead. Using this command preserves the history of the object in the database.
 The Delete command is not available for objects published by other authoring tools.
 Your role assignments determine which objects have access to the Delete command.
When you delete a document, you also delete the attached files from the vault.

Terminate an object
Terminating an object changes 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.
You can view the history of a terminated object by changing the effective date of the database to
a time before the object was terminated.
1. Right-click the object you want to terminate.
2. On the shortcut menu, click Terminate.
3. Click OK in the confirmation dialog box.
Display details for an object

The Details command allows you to view the properties of the selected object. This command is
available when you right-click an object.
1. Right-click the object for which you want to display details.
2. On the shortcut menu, click Details.
Display the history of an object

The History command allows you to view the update history of the selected object. The
command provides you with the current values of attributes of the object, previous values stored
for those attributes, and relationships the object has with other objects in the database. This
command is available when you right-click an object.
1. Right-click the object for which you want to display the history.
2. On the shortcut menu, click History.
Change the owning group for an object

The Change Owner and Owning Group command allows you to change the owning group that
has access to the object and the object owner, who has further permissions to modify the object.
1. Right-click the object for which you want to change the owner or owning group.
You can only change the owning group for objects, such as documents, folders,
reports, and SmartPlant Markup Plus files, that are modeled to have a relationship with
owning groups.
2. On the shortcut menu, click Change Owner or Owning Group or Change Owning Group.
3. In the Owning Group box, select the new owning group from the list.
4. In the Owner box, select the user you want to assign to the object.
5. Click OK.
Objects may be associated with an owning group without a specific owner. For example,
documents belong to an owning group, and this relationship determines which users have
access to the document. However, other objects can have both owners and owning groups. For
example, a saved report is available to be run by users that have access to it through the
owning group. Only the owner of the report can edit the report definition.

SECTION 7
Document Management
The SmartPlant Foundation Desktop Client provides you with the following document
management features:
 Document revision and version control
 Access control, including check in and check out
 User-subscribed notification of document changes, such as revisions and sign offs
Document life cycle

A revisable document is created, modified, released, and revised for further modification in a
controlled process that can be summarized as follows:
Creation The document master, revision, and version database objects
are created and related to each other and optionally files are
attached.
The document state is RESERVED.
The revision state is WORKING.
Modification The properties and relationships of both the master and revision
can be modified.
The version can be checked out, which creates a new version of
the document and relates it to the latest version and brings a
copy of any related electronic files to a client machine for
editing. The version is checked in when the file editing is
complete, and the new version supersedes the previous one.
Sign-off The document is signed off for release.
The document state is set to ISSUED.
The revision of state is set to CURRENT.
The previous current revision, if there is one, is set to
SUPERCEDED.
The properties and relationships of both a master and revision
can no longer be modified except by users of sufficient
privileges. This depends on the security model, and in some
installations no one can edit a released document.

Document Management
Revise A duplicate revision and version of the document are created

and related to the master. The identification sequence of the
revision is incremented according to the revision scheme, or a
different revision scheme can be associated with the new
version.
The document state is set to ISSUED_WKG.
The revision status of the new version is set to WORKING.
The previous revision is still CURRENT but is marked as under
change.
The properties and relationships of the document revision can
be modified, but not those of the document master.
The modification, sign-off, and revise process can be continually repeated.

 Components of the document model (on page 156)
 Document status icons (on page 158)
Components of the document model

Document
A specialized database object that follows a controlled life cycle and usually has files attached.
Revisable documents are composed of a document master, revision, and version.
Document Master
A database object representing the revision-independent information associated with the
document, such as the document title.
Document Revision
A database object representing the revision-specific information associated with the document.
As a document is created and revised, the new revisions are created and attached to the
document master. Properties and relationships of a revision can differ from one revision of a
document to the next. Only one revision can be current with only one working revision in a single
configuration. Multiple revisions can be created by revising into lower configurations to isolate
them until completed when they can be merged back. This is described in more detail in the
How to Configure Concurrent Engineering guide. Revisions are uniquely identified by a revision
code that follows a revision sequence.
Document Version
A database object representing the version-specific information associated with a document.
Files are attached to the document version.
In order to work on the files, a user has to check out the version. This creates a new version of
the revision. When this version is checked back in, the previous version is marked as
superceded but is retained to maintain a history. It is not usual to configure any properties or
relationships on the version as they are only used as placeholders for the files, but it is possible.

Document Management
Revision Scheme
Revision scheme is a document revision sequence that is used while creating or revising a
document to keep track of the various iterations of the document, which in turn reflect the
various iterations of the attached files that the document manages. A revision scheme includes
a number or letter to represent the major revision, a number or letter to represent the optional
minor revisions, and a number that represents the version. Examples include A1 to Z9, and 1A
to 9Z represent using major and minor revisions.
Major Revision
Major revision is the first part of the revision scheme, which normally changes when a document
undergoes a major change.
Minor Revision
Minor revision is the second part of the revision scheme, which normally changes when a
document undergoes an intermediate change and release. Additionally, it might be used to
identify alternate working revisions before final release.
File
A special database object managing a physical file and location in the vault.
PDF Generation (Alternate Rendition)

Alternate rendition is used to take a file that may be specific to a CAD application and generate
a viewable file of a different type. Currently, only PDF file types are configured for output. When

Document Management
alternate renditions are generated, they are displayed in SmartPlant Foundation for view and
mark up in preference to the original file.
Full Text Retrieval (FTR)

The Full Text Retrieval (FTR) functionality provides the system with the capability to store,
index, and search for text either contained in or associated with objects managed by the
SmartPlant Foundation system. FTR supports indexing and searching physical file contents
attached to documents and metadata of the SmartPlant Foundation objects configured for FTR.
A graphical user interface is provided to configure FTR functionality for both FTR configuration
and retrieval of information whereas the storage and indexing of objects is automated.
Vaults
A vault is an identified directory on the network used to store the physical files associated with
an object. Vaults can be related to either owning groups or configurations and optionally to
object interfaces to limit their availability. Conditions are available on the relationships to
determine which vault is used, such as for working or released documents.
These relationships are configured in the Desktop Client and are created in the data between an
interface and a vault.
If a file object is to be stored as a file in the database rather than the vault, the ClassDef
of the file object must realize the ISPFDBFile interface.
Archive and Purge

Vault files, database files, and their file objects can be archived. After archiving, the files and the
corresponding objects are purged to control the vault and database sizes.
Document status icons

The following table displays the icons for the various document lifecycle states.
Under
Change Chec
Action in Same ked Super
Icon State Object RevState Config out seded Icon Name
DocClas DocClass
s
Rev A,1 WORKING FALS FALS SPFDocumentVersi

E E on_W
Checked out Rev A,2 WORKING TRUE FALS SPFDocumentVersi

E on_WC
Superseded Rev A,1 WORKING FALS TRUE SPFDocumentVersi

by check out E on_WS
Checked in Rev A,2 WORKING FALS FALS SPFDocumentVersi

Document Management
Under
Change Chec
Action in Same ked Super
Icon State Object RevState Config out seded Icon Name
E E on_W
Superseded Rev A,1 WORKING FALS TRUE SPFDocumentVersi
by check in E on_WS
Signed Off Rev A,2 CURRENT FALS FALS SPFDocumentVersi

(rev A) E E on_C
Superseded Rev A,1 CURRENT FALS TRUE SPFDocumentVersi
by check in E on_IVS
Revised Rev A,2 CURRENT TRUE FALS FALS SPFDocumentVersi

E E on_CS
Superseded Rev A,1 CURRENT TRUE FALS TRUE SPFDocumentVersi
by check in E on_IVS
Rev B FALSE SPFDocumentVersi
on_W
Signed Off Rev A,2 SUPERSE TRUE FALS FALS SPFDocumentVersi

(rev B) DED E E on_SS
Superseded REV A,1 SUPERSE TRUE FALS TRUE SPFDocumentVersi
by check in DED E on_IVS
Rev B CURRENT FALSE SPFDocumentVersi
on_C
The Issued Version Superseded state is returned for the versions on current or
superseded revisions, which are superseded by check in, but never issued.
Create and manage documents in SmartPlant

Foundation
Use the following topics to understand how to create and manage documents in SmartPlant
Foundation.
Activate dialog box

Used to activate reserved vendor documents, creating the first revision and version.
Name - Displays the name of the vendor document to activate.
Description - Displays an editable description of the vendor document to activate.
Title - Displays an editable title for the document.

Document Management
Status - Displays the status of the vendor document. This option is display only.
Item owning group - Selects the owning group of the document.
Revision Details dialog box

Revision scheme - Select the revision scheme for the document.
Major revision - Set the major revision for the document. The software displays the first major
revision number in the Major revision box.
Minor revision - Set the minor revision for the document, if necessary. The software displays
the first minor revision number in the Minor revision box.
Status - Displays the status of the document. This option is display only.
Save Alternate Renditions dialog box

Allows you to save copies of file renditions.
Path - Displays the folder to which you want to save the files.
Name - Displays the name of the rendition file and a check box that determines whether the
rendition file is to be saved to the local folder. This check box has the following available states:
 Checked - The file is selected to save to the local folder.
 Unchecked - The file is not selected to save to the local folder.
Description - Displays the description of the alternate rendition file. This option is display only.
Revision - Displays the document revision to which the document is attached. This option is
display only.
Revision Status - Displays the revision state of the document.
Out of Date - Specifies whether the attached file or reference file is out of date. This option is
display only.
Viewable - Displays whether you can view the attached file in SmartPlant Foundation. This
option is display only.
Select All - Selects the viewable files to save to the local folder.
Clear All - Clears all selected files so that viewable files can be selected individually.
Expand All - Expands the Select revisions tree to display all nested reference files.
Copy all references - Selects all nested reference files to save to the local folder. This is not
applicable to the alternate rendition because they do not have any reference files.
The first time you use this dialog box, the path displayed by default is to your My
Documents folder. Any time you select a different location and save one or more files to it, that
path is stored in the system to be used as the default location the next time you access this
dialog box.
Attach Files dialog box

Allows you to attach files to a document version.
Name - Displays the name of the attached file. This option is display only.
Description - Displays the description of the attached file.
File Type - Displays the file type of the attached file.
Is Viewable - Indicates whether the file can be viewed in SmartPlant Foundation.
Is Editable - Indicates whether the file can be edited in SmartPlant Foundation.

Document Management
Add File - Allows you to browse to and select the file you want to attach.
Remove File - Allows you to select the file that you no longer want to attach to the document.
Delete local files - Indicates that the local copies of the files being attached are deleted after
they are checked into the vault.
If your configuration allows it, attached files can contain nested reference files.
The first time you open the Attach File dialog box, the Delete local files option is
selected by default. Any time you clear the Delete local files option, the selection is stored in
the local system to be used as default the next time you access this dialog box. Users can
change their preference at any time by selecting this option.
Save Target As dialog box

Allows you to copy any viewable files attached to the selected document locally to the client.
Path - Displays the folder to which you want to save the files.
The table provides read-only information about the documents to be copied locally:
Name - Displays the name of the attached file and a check box that determines whether the file
is to be saved to the local folder. This check box has the following available states:
 Checked - The file is copied to the local folder.
 Unchecked - The file is not copied to the local folder.
 Gray - A file nested under this file is copied to the local folder. The box for the parent file can
be checked or not.
Attaching Document - Displays the name of the document to which the file in the current row is
attached.
Revision - Displays the document revision to which the document is attached.
Out of Date - Specifies whether the attached file or reference file is out of date.
Viewable - Displays whether you can view the attached file in SmartPlant Foundation.
Select All - Selects the viewable files to save to the local folder.
Clear All - Clears all selected files so that viewable files can be selected individually.
Copy all references - Selects all nested reference files to be copied to the local folder.
Reset Default - Changes the current save location setting to a previously defined setting. The
first time you use this dialog box, the path displayed by default is to your My Documents folder.
Any time you select a different location and save one or more files to it, that path is stored in the
system to be used as the default location the next time you access this dialog box.
In general, by selecting Reset Defaults, the Path field displays the most recently saved
location.

 Create a new design document (on page 162)
 Create a new vendor document (on page 165)
 Reserve a vendor document (on page 168)
 Activate a reserved vendor document (on page 169)

Document Management
 Copy a document (on page 170)

 Copy the latest revision of a document (on page 173)
 Delete a document (on page 175)
 Generate PDF copies (on page 175)
 Generate view renditions (on page 175)
 Save alternate renditions (on page 176)
 Attach a file to a document (on page 177)
 Copy attached files (on page 178)
 Create a new template document on page 179
Create a new design document

The Design Document command allows you to create a new design document. This command
creates the document master, and the first revision and version of the document.
1. Click File > New > Design Document.
 Depending on your SmartPlant Foundation configuration, you may be required to select

the type of document that you want to create on the File > New shortcut menu.
 Depending on your configuration, other steps in this procedure may also be different.
2. In the New Design Document dialog box, expand the document category for which you
want to create a document
3. Select the document type for the new document.

Document Management
4. Click Next.
5. Provide additional information for the new document. Asterisks (*) indicate required
information.
section.
 Check the Collapse sections automatically option to make open sections collapse
automatically when you expand another section.
6. Click Next.

Document Management
7. To attach a design file to the document version, click Add File.
8. Browse to the document that you want to attach, and click Open.
selected by default. Any time you clear the Delete local files option, the selection is stored
in the local system to be used as default the next time you access this dialog box. Users can
 If the file that you are attaching references other files and those files are already in
SmartPlant Foundation, the software automatically creates relationships between the
file and the reference files.
 If there are duplicate copies of a reference file in SmartPlant Foundation, the software
prompts you to select the appropriate reference file to attach.
 If the file you attach references files that are not in SmartPlant Foundation, the software
displays an error message to let you know that the referenced files do not already exist.
You can create the relationship to the reference file later, after it has been added to
9. Make any necessary changes to the Description, Is Viewable, and Is Editable columns for
the files in the Attach Files table.
10. To add other files, repeat the previous 3 steps.
11. Click Finish to create the document master, first revision, and first version
 When you create a document master, the status of the document master is set to reserved.
 The status of the first revision is set to working, and the revise state is blank.
You can also create a new design document by right-clicking the document type that you
want to create in the tree view and selecting Design Document.

Document Management
Create a new vendor document

The Vendor Document command allows you to create a new active vendor document.
1. Click File > New > Vendor Document.

the type of document that you want to create by clicking File > New.
2. In the New Vendor Document dialog box, expand the document category for which you
want to create a document
4. Click Next.

Document Management
information.
section.
 Check the Collapse sections automatically option to make open sections collapse
automatically when you expand another section.
6. Click Next.

Document Management
7. To attach a design file to the document version, click Add File.
8. Browse to the document that you want to attach, and click Open.
selected by default. Any time you clear the Delete local files option, the selection is stored
in the local system to be used as default the next time you access this dialog box. Users can
 If the file that you are attaching references other files and those files are already in
SmartPlant Foundation, the software automatically creates relationships between the
file and the reference files.
displays an error message to let you know that the referenced files do not already exist.
You can create the relationship to the reference file later, after it has been added to
the files in the Attach Files table.
10. To add other files, repeat the previous 3 steps.
11. Click Finish to create the vendor document.
 When you create a vendor document, the status of the document is set to reserved.
 The status of the first revision is set to working, and the revise state is blank.
You can also create a new vendor document by right-clicking the document type that you
want to create in the tree view and then selecting Vendor Document.

Document Management
Reserve a vendor document

The Reserve Vendor Document command allows you to create new vendor documents and
reserve these in an inactive state. When you reserve a vendor document, you create a
document master, but not a version or a revision. The revision and version are created when the
reserved vendor document is activated.
1. Click File > New > Reserve Vendor Document.

the type of document that you want to create on the File > New submenu.
2. In the New Reserve Vendor Document dialog box, expand the document category for
which you want to create a document.
4. Click Next.

Document Management
information.
6. Click Finish to reserve the vendor document.
 When you create a vendor document, the status of the document is set to reserved.
You can also reserve a new vendor document by right-clicking the document type that you
want to create in the tree view and selecting Reserve Vendor Document.
Activate a reserved vendor document

The Activate command allows you to activate a reserved vendor document. This command is
available when you right-click a reserved vendor document.
1. Right-click the vendor document that you want to make active and select Activate.
2. Select a revision scheme in the Revision scheme box, and set the Major revision and
Minor revision values.

Document Management
3. Select an owning group in the Item owning group box.
4. Click Finish.
Copy a document
The Copy Document command copies all document master properties, and then creates a new
document master, revision, and version. This command is available when you right-click a
document.
1. Right-click the document that you want to copy and click Document > Copy Document.

Document Management
2. Provide the new document with a unique name, and then provide additional information for
the document copy, as necessary. Asterisks (*) indicate required information.

Document Management
3. Click Next.
4. Select the files to be copied from the source document. To copy markups of the copied files,
select Copy markups.
All the files from the source document are selected by default. The Copy markups
option is also selected by default.
 The visibility of the Files to be copied list can be controlled by configuring the Copy
Files argument on the corresponding method of the CopyObj client API.
 The first time you open the Attach File dialog box, the Delete local files option is
selected by default. Any time you clear the Delete local files option, the selection is
stored in the local system to be used as default the next time you access this dialog
box. Users can change their preference at any time by selecting this option.
5. Click Add File to find other files to attach to the new document.
6. Click Finish.
When you create, copy, or revise a publishable document in the authoring domain,
warehouse domain. This functionality keeps the revision details in the authoring domain and the
data warehouse synchronized for the same revision of a document.

Document Management
Copy the latest revision of a document

The Copy Revision command copies the document master and revision properties, and then
creates a new document master, revision, and version. This command is available when you
right-click a document.
1. Right-click the document that you want to copy and click Document > Copy Revision.
2. Provide a unique name for the new document, and then update any other information for the
new document, as necessary. Asterisks (*) indicate required information.

Document Management
3. Click Next.
4. Select the files to be copied from the source document. To copy markups of the copied files,
select Copy markups.
option is also selected by default.
Files argument on the corresponding method of the CopyObj client API.
5. Click Add File to find other files to attach to the new document.
6. Click Finish.
When you create, copy, or revise a publishable document in the authoring domain,
warehouse domain. This functionality keeps the revision details in the authoring domain and the
data warehouse synchronized for the same revision of a document.

Document Management
Delete a document
The Delete Document command allows you to delete the selected document. This command is
available when you right-click a document.
 You can right-click the object and select Terminate Relationships to delete existing
optional relationships.
When you delete a document, you also delete the attached file(s) associated with
that document from the vault.
1. Right-click the document that you want to delete and click Document > Delete Document.
When you delete a document, the document is permanently removed from the
SmartPlant Foundation database.
2. In the message box, click Yes to delete.
Generate PDF copies

The Generate PDF Copies command allows you to create a PDF representation of one or more
files attached to a selected document. This PDF file is attached to the document along with the
original file, and its revision and version information is managed by the same document. If the
selected document has markups generated in SmartPlant Markup Plus associated with it, the
software includes the markups in the PDF file. Watermarks and labels that are associated with
the document are also included in the PDF file.
 Right-click the document that you want to create a PDF copy and click Files > Generate
PDF Copies.
Generate view renditions

The Generate View Renditions command is used to convert any file type (including Microsoft
Office formats). These file types are converted to the Content Sealed Format (.CSF) file viewing
format.
The default timeout value for processing the conversion is 300 seconds.
 Right-click the document that you want to manually convert and click Files > Generate
View Rendition.

Document Management
Save alternate renditions

The Files > Save Alternate Renditions command allows you to save copies of file renditions.
This command is available when you right-click a document or file in the tree view or when you
select multiple documents or files and right-click on them.
 If the files have alternate rendition of different file types, the SmartPlant Foundation user can
specify the file types to be saved with the respective document/file method configuration.
 You can specify the target file types in separated semicolon-separated list. For example,
FT_PDF;FT_BMP.
1. Right-click the document version for which you want to save alternate renditions and click
Files > Save Alternate Renditions.
From the list, select the files for which you want to save a rendition.
2. Click OK.

Document Management
Attach a file to a document

The Attach File command allows you to attach files to the selected document version. This
command is available from the Files submenu when you right-click on a document or from the
main shortcut menu when you right-click on a file.
1. Right-click the version of the document to which you want to attach a file and click Files >
Attach File.
2. Click Add File and browse to the file you want to attach.
You can select multiple files to attach to the document.

3. Click Open, and then click OK to add the file to the list.
To add other files, repeat steps 3-4.
 If you do not want the attached file to be viewable in SmartPlant Foundation, click the Is
Viewable column and change the selection to False.
 If you do not want the attached file to be editable, click the Is Editable column and
change the selection to False.
 If the Delete local files check box is selected, the local copy of the file will be deleted
once the file is checked into the vault.
 In an integrated environment, you can attach additional files to a document that is
published from an authoring tool.
4. Click OK to attach the file or files to the document.
 If the file you are attaching references other files and those files are already in SmartPlant
Foundation, the software automatically creates relationships between the file and the
reference files.

Document Management
displays an error message to let you know that the referenced files do not already exist. You
can create the relationship to the reference file later, after it has been added to SmartPlant
Foundation.
Copy attached files

The Save Target As command allows you to save local copies of files attached to the selected
document. This command is available on the Files that appears when you right-click one or
more, or it can be accessed by right-clicking on a file object.
1. Right-click the document version for which you want to save a local copy of the attached
files and click Files > Save Target As.
 From the list, select each file that you want to copy.
 If a file references other files, the Save Target As command also copies all its
referenced files to your computer.
2. Specify where you want the software to place the local copy of the file in the Path box.
3. Click OK.

Document Management
Create a new template document

Template documents are used by SmartPlant Foundation to format reports, to provide a basis
for data sheets, or as seed files that are attached to all documents of a specific type on creation.
 Template documents are typically created by system administrators.

 Template documents may be created at the site level and available for use in any plant. Set
your Create Scope to Scope Not Set before you use the steps below.
1. Expand Document Category in the tree and find the Template Documents node.
2. Right-click Template Documents, and click New Template Document.
3. Select the type of template document you want to create.
4. Click Next.
5. Provide additional information for the new template document. Asterisks (*) indicate required
information.
All template documents use the SPFRevisionSchema revision scheme, but you can
choose the major or minor revision number.
6. Click Next.
7. Click Add File, and browse to the document that you want to use as a template.
8. Click Open.
the files in the Attach files table.
10. Click Finish to create the template document.
Unlike files attached to design documents, files attached to template documents are not
stored in a vault. They are stored directly in the database.
Check in and check out a document

When you create a document master, first revision and first version, the document is
automatically checked in, or under the control of SmartPlant Foundation. When a document is
checked in, the vault owns the document, and users cannot make changes to the document
without checking it out. The owning group for the document determines which users have
access to check out the document and what vault stores any files attached to the document
When you need to make modifications to a document in the Desktop Client, you can check out
the document. Checking out the document creates a new version of the document in SmartPlant
Foundation and copies the files attached to that new version of the document to a local directory
that you specify for editing. Checking out a document also marks the previous version of the
document as superseded.
You can use the Run Editor command as an alternative to the Check Out command. The Run
Editor command performs the check out and subsequently launches the files you checked out
in the native application, as determined by your default application settings.
The software maintains the relationship between the copy of the document you check out and
the original so that other SmartPlant Foundation users can see that you have the document
checked out for modification. Two users cannot check out and make changes to a document at
the same time.
If you decide not to modify a document that you have checked out, you can use the Undo
Checkout command to relinquish your claim to the document so that other users can check it
out and modify it. When you cancel a check out, the software deletes the local copy of attached

Document Management
files that were copied when the object was checked out, discarding any changes you might have
made to the files, and deletes the new version of the document that was created when you
performed the checkout operation. The previous version of the document, which was marked as
superceded because of the check out, is returned to the working state.
After you have edited the document, you check it in to return it to the vault. When you check in a
document, any attached files are removed from your local directory and copied to the vault.
Once a document is checked in, other users can make changes to it.
Only the user that checked out the document can undo the checkout.
Check Out dialog box

Allows you to claim a document in order to make changes the attached file or files. Documents
that are checked out cannot be revised by anyone else until they are checked back in by the
user who claimed them.
Path - Displays the folder in which the local copies of the files will be placed. Click to
browse for a folder.
The table provides read-only information in the following fields about the files to be copied
locally for editing
Name - Displays the name of the attached file and a check box that determines whether the file
is copied locally. This check box has the following available states:
 Checked - The file is copied locally for editing.
 Unchecked - The file is not copied from the vault and cannot be modified locally.
 Gray - A file nested under the file is copied locally for editing. The box for the parent file may
be checked or not.
Parent - Displays the name of the document to which the file is attached.
Revision - Displays the document revision to which the document is attached.
Out of Date - Specifies whether the reference document is out of date
Owning Group - Displays the owning group to which the parent document belongs.
Viewable - Displays whether you can view the attached file in SmartPlant Foundation.
Is Editable - Displays whether you can edit the attached file in SmartPlant Foundation.
Check out all references - Selects all nested reference files and documents for checkout.
Expand All - Expands the Select revisions tree to display all nested reference documents.
Reset defaults - Sets the Select revisions view to default selections that were displayed when
the dialog box was opened. By default, all editable files are pre-selected when the dialog box is
opened.
 A file with text that is grayed out in the Select revisions view is not available for checkout.
 The first time you use this dialog box, the path displayed by default is to your My
Documents folder. Any time you select a different location and save one or more files to it,
that path is stored in the system to be used as the default location the next time you access
this dialog box.

Document Management
Run Editor dialog box

Allows you to check out a document and open an attached file in a native application. The
application in which the file is opened is determined by your system settings for the default
applications for file types. This dialog box appears when you use the Run Editor command to
check out a document and launch more than one file. If only one file was selected, this
document will not appear the software will automatically launch the associated application.
Name - Displays the name of the attached files and a check box that determines whether each
file will be opened in the default editor. This option has the following available states:
 Checked - The file is selected for editing.
 Unchecked - The file is not selected for editing.
 Gray - A file nested under the file is selected for editing.
Description - Displays the description of the attached file. This option is display only.
File Local Directory - Displays the location to which the file is checked out.
Undo Check Out dialog box

Allows you to cancel the check out of documents.
The table provides read-only information in the following fields about the documents for which
the check out may be cancelled
Name - Displays the name of the document and a check box that determines whether the
document check out is cancelled. This check box has the following available states:
 Checked - The document check out is selected for cancellation.
 Unchecked - The document check out is not selected for cancellation.
 Gray - A file nested under the document or file is selected for check out cancellation. The
box for the parent document or file may be checked or unchecked.
Description - Displays the description of the document.
Class - Specifies the class definition of the document.
Creation Date - Displays the date on which the document was created.
Created By - Displays the name of the user who created the document.
Last Updated - Displays the date and time when the document check out occurred.
Undo checkout for all references - Selects all nested reference files for check out
cancellation.
opened.
 Only the user that checked out the document can undo the checkout.
 A file with grayed out text in the Select revisions view is not available for check out
cancellation.
Check In dialog box

Allows you to return checked out documents to the SmartPlant Foundation and copy any
updated files to the SmartPlant Foundation vault for storage.

Document Management
The table provides read-only information in the following fields about the documents to be
checked back in to SmartPlant Foundation.
document is selected to be checked into SmartPlant Foundation. This check box has the
following available states:
 Checked - The document is selected for check in to SmartPlant Foundation.
 Unchecked - The document is not selected for check in to SmartPlant Foundation.
 Gray - A file nested under the document is selected for check in to SmartPlant Foundation.
The box for the parent document may be checked or not.
Revision - Displays the document revision number.
Out of Date - Specifies whether the reference document is out of date.
Checked out files - Displays the names of any checked out files attached to the document.
Owner - Displays the name of the user who currently has the document checked out for
modification.
Owning Group - Displays the owning group to which the document belongs.
Expand All - Expands the Select revisions tree to display all nested reference documents.
Check in all checked out references - Selects all nested reference documents for check in to
Delete local files - Specifies whether to delete the local copies of attached files after the files
have been checked back into the vault.
opened.
A document with text that is grayed out in the Select revisions view is not available for
check in.
selected by default. Any time you clear the Delete local files option, the selection is stored in
the local system to be used as default the next time you access this dialog box. Users can

 Check out a document (on page 183)
 Cancel a check out (on page 184)
 Check out and edit a document in an authoring application (on page 185)
 Check in a document (on page 188)

Document Management
Check out a document

The Check Out command allows you to check out documents for editing. This command is
available when you right-click one or more documents.
1. Right-click the document version or versions that you want to check out for modification then
click Edit > Check Out.
Documents created without a configuration value can be checked out, checked in,
revised, updated, or signed off when your active configuration is set above the plant level to
Scope Not Set.
 To use the Check Out command, all of the selected documents must be checked in
(that is, the checked out indicator must be set to False), the status must be working, you
must be a member of the owning group, and the revise state must be blank. If any of the
selected documents do not satisfy these conditions, the Check Out command does not
appear on the shortcut menu.
 To determine whether a file is checked out or not, select the document and review the
information in the Properties window. If the Checked Out property is True, then the file
is currently checked out. You can also view the document properties in the History
dialog box.
2. Click Browse to select the directory into which you want the software to copy the checked
out files.
3. Select each document that you want to check out.

Document Management
4. Click OK.
 When you check out files that have references, the software automatically places
read-only copies all the reference files, any nested reference files, and the master file to
your local computer. These copies are for reference only. If you want to update the
reference files, you must check out the document to which they are attached.
 If the file you check out has duplicate copies of a reference file in the nested structure,
the software displays a message warning you that files with the same name are
attached to multiple files. If you receive this message, click Yes to continue the
checkout process with a single level copied for reference, or click No to cancel the
checkout process.
 If the file you check out has reference files attached to different versions of a document
in the nested structure, the latest version of the document is copied for reference.
If the files you are checking out are already copied for reference to your local
computer, the newly checked out files overwrite the local files.
 When you check out a document version, the previous version is superseded. The software
sets the following properties for the superseded document version: status to working, the
revise state to superseded, the access flag to 9 (no update access), and the version to 1.
 When you check out a document, the software creates a new document version. The
software gives the new version the next version number. The access flag for that new
document is set to 1 (user access only), and the checked out indicator is set to True.
 When you check out a document, any existing markups to files attached to the document
are automatically copied forward with the checked out document.
Cancel a check out

The Undo Check Out command allows you to cancel the check out of documents. This
command is available when you right-click a checked out document or documents.
Only the user that checked out the document can undo the checkout.
1. Right-click the document version or versions for which you want to cancel the checkout
operation and click Edit > Undo Check Out.
2. Select the documents and files for which you want to cancel the checkout operation.

Document Management
 Only the user that checked out the document can undo the checkout.
 When you cancel a checkout, the software deletes the latest working copy (for example,
Rev A Version 3) and resets the previous version (such as Rev A Version 2) as the latest
working document. It also changes the revise state for the previous revision from
superseded to blank, and deletes any markups for files attached to the checked out
document.
Check out and edit a document in an authoring application

The Run Editor command allows you to check out documents for editing and immediately
launch them in their authoring application.
1. Right-click a working version that you want to edit in an authoring application and click Edit
> Run Editor.
Scope Not Set.
 To use the Run Editor command, all of the selected documents must be checked in
(that is, the checked out indicator must be set to False), the status must be set to
working, you must be a member of the owning group, and the revise state must be
blank. If any of the selected documents do not satisfy these conditions, the Run Editor
command is not available.
 To determine whether a file is checked out or not, select the document and review the
information in the Properties window. If the Checked Out property is True, then the file
is currently checked out. You can also view the document properties in the History
dialog box.

Document Management
2. Click Browse to select the directory into which you want the software to copy the checked
out files.
3. Select the check box beside each attached document that you want to check out.
4. Click OK.
 When you check out files that have references, the software automatically places
read-only copies all the reference files, any nested reference files, and the master file to
your local computer. These copies are for reference only. If you want to update the
reference files, you must check out the document to which they are attached.
 If the file you check out has duplicate copies of a reference file in the nested structure,
the software displays a message warning you that files with the same name are
attached to multiple files. If you receive this message, click Yes to continue the
checkout process with a single level copied for reference, or click No to cancel the
checkout process.
 If the file you check out has reference files attached to different versions of a document
in the nested structure, the latest version of the document is copied for reference.

Document Management
5. If you selected multiple files on the Check Out dialog box, the software displays the Run
Editor dialog box. Select each attached document that you want to launch in its authoring
application.
 To use the Run Editor command, the authoring application (or an alternate application
accepting that file type) must be installed on the computer to which you are checking out
to the document.
 The authoring application opens with the required files. For example, if you click the
Run Editor command for a document that was created in SmartSketch and
SmartSketch is installed on your computer, SmartSketch displays. If the native
application is not installed on the local computer, SmartPlant Foundation opens the file
in the application associated with that file type in your system settings
 When you check out a document, the previous version is superseded. The software sets the
following properties for the superseded version: status to working, the revise state to
superseded, the access flag to 9 (no update access), and the version to 1.
 When you check out a document, the software creates a new document version. The
software gives the new document the next version number. The access flag for that new
version is set to 1 (user access only), and the checked out indicator is set to True.
 When you check out a document, any existing markups to files attached to the document
are automatically copied forward with the checked out document.

Document Management
Check in a document
The Check In command allows you to check in documents that previously have been checked
out for editing. This command is available when you right-click one or more checked-out
document.
1. Right-click the document version that you want to check in to SmartPlant Foundation and
click Edit > Check In.
Scope Not Set.
 You must select the document version that you checked out previously. If any of the
selected document version are not checked out, the Check In command does not
appear on the shortcut menu.
 To determine whether a document is checked out and who has the document checked
out, select the document, and review the information in the Properties window. If
Checked Out property is True, then the file is currently checked out. The user who has
the document checked out is listed as the Creation User of that document version.
2. Select the documents and reference documents to check in to SmartPlant Foundation in the
Check In dialog box.
 If the file you check in has reference files and there are duplicate copies of a reference
file in SmartPlant Foundation, the software prompts you to select the appropriate
reference file to attach.
 If the file you check in has references to files that are not in SmartPlant Foundation, the
software displays an error message to let you know that the referenced files do not

Document Management
already exist. You can create the relationship to the reference file later, after it has been
added to SmartPlant Foundation.
 When you check in a document, the software places the attached file or files in a vault
determined a number of relationships, which may include the owning group of the document.
 After the file has been placed in the vault, access to the file is controlled by the owning
document.
 When you check in a document, the software sets the checked in indicator to True and the
checked out indicator to False. If the document has attached files, the software sets the
access flag to 2 for the version, which means that only members of the owning group can
modify the files.
 You cannot attach a file during the check in of the document. However, once the document
is checked in, you can find the latest version of the document and then attach the file.
 When you check in a file that has reference files, all reference file relationships are
maintained and updated for each file that is checked back into SmartPlant Foundation. The
following changes are made to reference file relationships, depending on changes you make
while the document is checked out for modification:
 If you check in a file that no longer references the same files, old reference file
relationships are terminated.
 If you check in a file with different reference files than those referenced previously, old
reference file relationships are terminated, and new reference file relationships are
added.
 If you check in a file that did not have any reference files before, but now references one
or more files, new reference file relationships are created.
 When you check in a file, all Referred by relationships are updated if the master file is not in
the Checked In or Revised state.
 The software terminates the relationship between the master file and the previous
version of this file.
 The software creates a new relationship between the master file and this checked in
version of the file.
Sign off on a document

After modifications to a document revision are complete, you can sign off the document to
finalize it. 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.
To sign off a document, the document must be checked in.
After a document has been signed off, additional changes can only be made to the document by
revising the document. When you revise a document, the software prompts you for the major
and minor revision numbers that you want to associate with the revision.
 You can select multiple documents for check in, check out, undo check out, sign off, and
sign off with form operations.

Document Management
When you delete a document object, you also delete the attached file(s) from the
vault.
Sign Off dialog box

Allows you to sign off, or lock, one or more documents, preventing further changes to the latest
revisions of those documents.
signed off in SmartPlant Foundation.
Name - Displays the name of the document, and a check box that determines whether the
document is signed off in SmartPlant Foundation. This check box has the following available
states:
 Checked - The document is selected for sign off.
 Unchecked - The document is not selected for sign off.
 Gray - A file nested under the document is selected for sign off. The box for the parent
document can be selected or not.
Out of Date - Specifies whether the document is out of date.
Item Owner - Displays the owner to which the document belongs.
Select All - Quickly selects all documents to sign off.
Clear All - Quickly removes all documents for sign off.
Sign off all references - Selects all nested reference files for sign off.
opened.
 A file with text that is grayed out in the Select revisions view is not available for sign off.
Sign Off with Form dialog box

Allows you to sign off documents, add comments to the document properties, and specify the
date on which the sign off occurred.
signed off in SmartPlant Foundation
document is signed off. This check box has the following available states:
 Checked - The document is selected for sign off.
 Unchecked - The document is not selected for sign off.
 Gray - A file nested under the document is selected for sign off. The box for the parent
document can be selected or not.

Document Management

Out of Date - Specifies whether the document is out of date.
Item Owner - Displays the owner to which the document belongs.
Item Owning Group - Displays the owning group to which the document belongs.
Select All - Quickly selects all documents to sign off.
Clear All - Quickly removes all documents for sign off.
Sign off all references - Selects all nested reference files for sign off.
opened.
 A file with text that is grayed out in the Select revisions view is not available for sign off.

 Sign off a document (on page 191)
 Sign off a document with comment (see "Sign off a document with comments" on page 193)
 Undo a document sign off
Sign off a document

The Sign Off command allows you to sign off on a document, indicating that modifications to the
document are complete.
1. Right-click the document or documents that you want to sign off and select Edit > Sign Off.
Scope Not Set.
 If you want to provide comments and the date you approved the document revisions,
click Edit > Sign Off with Form instead.
 To sign off a document, the document status must be working, and the revise state must
be blank. If any of the selected documents do not meet these criteria, the Sign Off
command does not display.

Document Management
2. Select the document revisions and reference files to sign off.
3. Click OK.
4. If reference files that have a status of superseded or working are attached to a revision, the
software either stops the sign off process or prompts you to continue with the sign off or
cancel, depending on your configuration. If working references are allowed, click Yes to sign
off the documents. If working references are not allowed, click OK to exit the signoff
process.
5. If updated revisions of reference files associated with this document exist but are not
associated with this document and those reference files have their maintain relations action
set to Prompt Update, select the files that you want to update to the latest reference file
revision, and then click OK.
 The maintain relations option can be set on the relationship between each reference file
and the master file that references it. For more information, see Update Maintain
Relations properties on reference files (on page 220).
 The options for maintain relations include the following. These options control what
happens during sign off if newer revisions of those reference files are available.
 Prompt Update - Requires user to provide information when an updated revision of
a reference file exists
 Always Update - Automatically updates reference files to the latest signed off
revision in SmartPlant Foundation when you sign off the document revision with
which reference files are associated.
 Always Fixed - Relationships between older revisions of reference files remain the
same.
 Always Update Working Revisions - Automatically updates relationships to
versions of the latest working revisions
 Before you sign off a document, you must check in the document.
 When you sign off a document, the software sets the status for the revision to current and
the revise state to blank.

Document Management
 Signing off a document sets the revise state for any previous revisions to superseded.
 Signing off a document in a project does not update the as-built revision status to
superseded.
 Signing off a document changes the status of the document master to issued.
 Depending on your configuration, you may be able to automatically sign off a document
when you claim a workflow step for that document in your To Do List.
Sign off a document with comments

The Sign Off with Form command allows you to sign off on documents, indicating that
modifications to the documents are complete. The command also allows you to add comments
to the documents and specify the date on which the sign off occurred. This command is
available when you right-click one or more documents.
1. Right-click the document or documents that you want to sign off and select Edit > Sign Off
with Form.
Scope Not Set.
 To sign off a document, the status must be working, and the revise state must be blank.
If any of the selected documents do not meet these criteria, the Sign Off with Form
command does not display.
2. Select the document revisions and reference files to sign off.

Document Management
3. If needed, add comments in the Notes box.

4. Click OK.
5. If reference files that have a status of superseded or working are attached to a revision, the
software either stops the sign off process, or prompts you to continue with the sign off or
cancel, depending on your configuration. If working references are allowed, click Yes to sign
off the documents. If working references are not allowed, click OK to exit the signoff
process.
6. If updated revisions of reference files associated with this document exist but are not
associated with this document and those reference files have their maintain relations action
set to Prompt Update, select the files that you want to update to the latest reference file
revision, and then click OK.
 The maintain relations option can be set on the relationship between each reference file
and the master file that references it. For more information, see Update Maintain
Relations properties on reference files (on page 220).
 Options for maintain relations include the following. These options control what happens
during sign off if newer revisions of those reference files are available.
 Prompt Update - Requires user to provide information when an updated revision of
a reference file exists
 Always Update - Automatically updates reference files to the latest signed off
revision in SmartPlant Foundation when you sign off the document revision with
which reference files are associated.
same.
 Always Update Working Revisions - Automatically updates relationships to
versions of the latest working revisions.
 Before you sign off a document, you must check in the document.
 When you sign off a document, the software sets the status for the revision to current and
the revise state to blank.
 Signing off a document sets the revise state for any previous revisions to superseded.
 Signing off a document in a project does not update the as-built revision status to
superseded.
 Signing off a document changes the status of the document master to issued.
Revisions and versions

A revision is an officially recognized change to a document. Revisions can have major and
minor revision numbers associated with them. A version is an intermediate update to an existing
document that is tracked by the software. Each revision of a document can have multiple
versions.
In the SmartPlant Foundation Desktop Client, you typically see the latest version of the
document, though you can navigate to other versions or revisions using relationships. Access is
provided only to the latest version. Previous versions are superseded when you check in, sign
off, or publish a new one. If you need to see a previous version of a document, start by finding
the current version. Then use the shortcut menu command Master Relationships > Show All
Revisions to navigate to the appropriate revision and the command Revision Relationships >
Show All Versions to see a list of all the versions associated with that revision.

Document Management
For example, a master document MasterDoc might have the following revisions and versions in
the Desktop Client, where A and B are revision numbers, and 1 and 3 are version numbers:
Document MasterDoc
 First Revision [A, 1]
 Second Revision [B, 3]
When you use the Show Latest Revision command from the document master, the software
displays the latest current and working revision of that document.
When you create a document in the Desktop Client, either manually or through publishing a
document in an integrated environment, the master document, the first document revision, and
the first version are created in the Desktop Client.
When you check out a document to modify it and then check it back in, a new version is created.
Using the Revise command on a document creates a new revision. The revision and version
are properties on a document revision in SmartPlant Foundation.
New revisions and versions are also created when documents are published. The document
master and first revision are created when the authoring tool user reserves a revision in
SmartPlant Foundation using the Revise command. During the first publish, the first version of
the document is created in SmartPlant Foundation and the published files are related to the
version and store in the vault. Subsequent publish operations create additional versions of the
document. Using the Revise command in the authoring tool again creates new revision.
When you create, copy, or revise a publishable document in the authoring domain, SmartPlant
Foundation automatically reserves a revision for that document in the data warehouse domain.
This functionality keeps the revision details in the authoring domain and the data warehouse
synchronized for the same revision of a document.

 Revise a document (on page 196)
 Insert a historical revision (on page 198)
 Show all revisions for a document (on page 198)
 Show all versions for a document (on page 198)
 Create a snapshot of a document version (on page 199)
 Generate a document revision report for a document (on page 200)
 Purge superseded versions for a document (on page 200)
 Delete a document revision (on page 200)
 Terminate a document revision (on page 201)

Document Management
Revise a document
The Revise command allows you to create a new revision of the selected document. This
command is available when you right-click one or more signed off documents.
1. Right-click the revision of the document that you want to revise and select Edit > Revise.
Scope Not Set.
To revise a document, the status must be current, which means that the document has
already been signed off.
2. To create a new revision, type the major or minor revision numbers in the Major or Minor
box. The next major and minor revision numbers display in these boxes by default.
 To use the next major revision number for the document, click Next Major. The
software displays the next major revision number in the Major revision box. The
revision number used for the latest current document revision, not the superseded
revision being revised, determines the next major revision number.
 To use the next minor revision number for the current major revision, click Next Minor.
The software displays the current major revision number with the next minor revision

Document Management
number in the Major revision and Minor revision boxes. The revision number used for
the latest current document revision, not the superseded revision being revised,
determines the next minor revision number.
3. Click Next.
4. Select the files to be copied from the source document forward to the revision. To copy
markups of the copied files, select Copy markups.
option is also selected by default. However, this does allow you to leave any supplemental
documents on the previous revision, if necessary.
Files argument on the corresponding method of the Revise client API.
 If there are any files attached to the previous revision, they are displayed in the Files to
be copied list.
5. To attach a different file to the new revision, click Add File. To remove an existing attached
file, click Remove File.
6. Click Finish.
When you revise a document, all reference file relationships are copied for each file
that is attached to the revised document.
 Revising a signed off document creates a new working revision and version of the document
that can be edited.

Document Management
 When you revise a signed off document, the status of the document master changes to
ISSUED_WKG.
 A project/as-built configuration supports only one working revision. If this revision is created
in a project, the as-built revision is assigned a revise state of CURRENT, SUPERSEDED to
show that it is under change. Thus, documents cannot be revised in as-built once they are
revised into a project.
 You cannot edit or revise a document that was created in and published by an authoring tool
outside of SmartPlant Foundation. The tool user must use the Revise command in the
authoring tool to create a new revision.
 When you create, copy, or revise a publishable document in the authoring domain,
warehouse domain. This functionality keeps the revision details in the authoring domain and
the data warehouse synchronized for the same revision of a document.
Insert a historical revision

The Insert Historical Revision command allows you to insert a superseded revision before a
CURRENT revision or SUPERSEDED revision. The revision is inserted with a date that falls
before the selected revision and after any existing previous revisions.
1. Right-click the signed off or superseded document revision for which you want to insert a
historical revision.
Revised documents must be signed off before insertion as a historical revision.
2. In the Insert Historical Revision dialog box, change the Major Revision to a previous
number or letter, if the major revision sequence has a gap. Otherwise, provide a Minor
Revision to a number or letter that places the revisions between the previous existing
revisions.
3. Select an issue date that is a revision before the creation date of the signed off or
superseded version of the document.
4. Click Next to add a file to the inserted revision.
5. Click OK.
Show all revisions for a document

The Show All Revisions command allows you to display all revisions of the selected document.
This command is available when you right-click a document.
 Right-click the document for which you want to view all revisions and select Master
Relationships > Show All Revisions.
Show all versions for a document

The Revision Relationships > Show All Versions command allows you to display all versions
of the selected document associated with that revision. If you use this command from the
current version of the document, then all the versions associated with the current revision are
returned. However, if you navigate to a superseded revision, this command returns all the
versions associated with that revision.
 Right-click the document for which you want to view all versions and select Revision
Relationships > Show All Versions.

Document Management
Create a snapshot of a document version

1. In the Desktop Client, find the document version that you want to snapshot.
To create a snapshot of a list document, you must create the list document from the
List Edit window first.
2. Right-click the version and click Create Snapshot.
The document you select to snapshot must be checked in and in the working state.
The latest version should not be superseded. If these conditions are not met, depending on
your configuration, you may not see the Create Snapshot command, or if you see the
command, the software displays error messages when you click Create Snapshot.
3. In the New Items window, right-click the version and select Show All Files to see the XML
and XLS files created as part of the snapshot.
 Once the snapshot is created, you can share the Excel file with other people or publish the
snapshot to the data warehouse environment; the snapshot contains the data as it existed in
the database when the snapshot was created.
 The snapshot remains attached to the document version so that you can see the data the
document contained at the time the snapshot was created.

Document Management
 The Excel file created for the snapshot of a list document is based on a default template
called Snapshot Template, which has an Excel spreadsheet attached called
SPFSnapshotTemplateFile. This template contains several defined names for the title
block information and others to locate the data for the related items in the list document.
Generate a document revision report for a document

The Revision Report command allows you to generate a list of document revisions for the
related document master.
 Right-click the document version for which you want to generate a report and select
Document > Revision Report.
 The document revision report includes a list of all document revisions for the selected
document master in Excel format including the names, creation date, issue date, and
creation user of each .
 To print the report, click File > Print.
Purge superseded versions for a document

The Purge superseded versions command allows you to purge all superseded versions for a
document. This command is available when you right-click a document or during signoff (or
signoff with form) controlled via a method parameter on signoff methods.
You can perform this command on a document revision or a document master. When
performed on a document master, it purges the superseded versions of all the revisions. When
performed on a document revision, it purges all the superseded versions of that specific
revision.
 Right-click the document for which you want to purge all superseded versions in the tree or
list view and select Document > Purge Superseded Versions.
Delete a document revision

The Delete Latest Revision command allows you to delete the selected document revision.
This command is available when you right-click a document version associated with document
that includes at least two revisions.
command instead, which preserves the history of the object in the database.

Document Management
 You can right-click the object and use the Terminate Relationships command to delete the
existing relationships.
When you delete a document revision, you also delete any versions for that
revision, as well as any files attached to those versions.
1. Right-click the document for which you want to delete the current revision and select
Document > Delete Latest Revision.
2. In the message box, click Yes.
Terminate a document revision

The Terminate Latest Revision command allows you to terminate the latest revision of a
document. This command is available when you right-click a document version associated with
document that includes as least two revisions.
1. Right-click the document for which you want to terminate the current revision and select
Document > Terminate Latest Revision.
2. In the message box, click Yes.
 Terminating a document revision changes its status and revise state to terminated.
However, the document revision still exists in the database; it is not deleted when it is
terminated.
 Terminating a document revision changes the status of the master document to issued. The
current working version and the revision to which it was related are marked as no longer
valid, and a search for the document now returns the last signed off revision
 If you terminate the latest revision for a master document, the last signed off revision of the
document can be revised again, however the revision number use for the revisions that was
terminated cannot be used. You must choose a different major or minor revision number or
letter.
Comparing documents
In the Desktop Client, you can compare document versions of published documents with each
other and the differences in data published to SmartPlant Foundation using the Compare and
View and Compare commands.
When you compare versions, you must select two document versions in the Desktop Client, and
then right-click and select either the Compare command or the View and Compare command,
the Desktop Client displays the comparison results in the View and Compare window, which
displays the view files for the documents side-by-side with changes highlighted. This window
also includes a table that lists the specific changes identified when the documents were
compared. When you select an object in the graphic view or the table, you can also view
properties for that object in the Properties window. A color scheme lets you see at a glance
whether objects were created, deleted, or changed between the two versions being viewed.
The Compare command does not show the view files of the published documents, but uses a
color-coded table to illustrate the difference between to two selected versions of the document
You can also use the Compare command to compare two revisions of a document.
View and Compare window

Displays two documents for comparison.

Document Management
The View and Compare window displays the view files for the documents side-by-side with
changes highlighted. The View and Compare window also includes a table that lists the specific
changes identified when the documents were compared. When you select an object in the
graphic view or the table, you can also view properties for that object in the properties window.
Compare Window
Display the data from two published documents for comparison in a list format. Color coding
illustrates the difference in the data between the two published documents.
Name – Displays the name of the object that was published in at least of the two document
being compared. By drilling down under the object, this column also displays properties for
which data was published for this object.
Class Def – Displays the class def of which the object in an instance.
Document 1 Value – Displays the value published by document 1 for a particular property for
the object.
the object.
Compare State – Indicates whether the data for the object changed between the compared
versions of the document. Values that may appear in this column are described below:
 Updated – Indicates that the value for this property changed between the two versions
of the document.
 Exists in document 1 only – Indicate that the object was deleted between the two
versions of the document.
 Exists in document 2 only – Indicates that the object was created between the two
 Identical – Indicates that there was no change to the value of the property between the
two versions of the published document.
Hide identical objects – Selecting this check box hides any properties for which the data did
not change. If this check box is not selected, then all properties appears in the list, even those
with a Compare state of Identical.
Export – Extracts the information in the table to a Microsoft Excel spreadsheet for review or
sharing.
Compare window
the object.
the object.
of the document.

Document Management
 Exists in document 1 only – Indicates that the object was deleted between the two
not change. If this check box is not selected, then all properties appear in the list, even those
Export – Extract the information in the table to a Microsoft Excel spreadsheet for review or
sharing.
Set Display Preferences dialog box

Provides tabs for selecting the layout, colors, and other view options for the Compare window.
 Layout tab
 Display tab
 Auto-focus tab
Layout tab (Select Display Parameters dialog box)

Allows you to select the layout of the View and Compare window by clicking the button that
corresponds to the configuration you want.
Different colors represent different parts of the View and Compare window:
 Red - First drawing
 Blue - Second drawing
 Yellow - Properties window
 Green - Comparison results table
Display tab (Select Display Parameters dialog box)

Allows you to define color settings and display indicators for the comparison results displayed in
the View and Compare window.
Set Color - Allows you to set the color for the comparison result type you selected in the list.
Restore Default Color - Restores the default color for the comparison result type you selected
in the list. By default, the following colors represent types of comparison results:
 Green - Deleted objects
 Blue - Modified objects
 Red - New objects
 Black - Objects that are the same in both drawings
Restore All Default Colors - Restores the default colors for all comparison results.
Set Color - Allows you to indicate whether you want color to identify comparison results of the
selected type. If the check box is selected beside a comparison result type, color is used to
identify that type of change in the drawings, comparison results table, and Properties window.
Make Bold - Allows you to indicate which of the comparison results of the selected type to bold.
If the check box is selected beside a comparison result type, bold is used to identify that type of
change in the drawings, comparison results table, and Properties window.

Document Management
Display Titlebar in Drawing Frames - Indicates whether you want to display the name of the
drawing and its major and minor revision numbers in the title bars of the drawings in the View
and Compare window.
Auto-focus tab (Select Display Parameters dialog box)

Allows you to define auto-focus settings for the View and Compare window.
When selecting an item in a drawing, do you want to automatically find it in the list of
changes? - Determines whether clicking an object in one of the drawing views automatically
scrolls to the changes for that object in the comparison results table. Click Yes to automatically
find the changes for an object in the comparison results table; click No to turn this option off. By
default, this option is set to No.
When selecting an item in the list of changes, do you want to automatically find it in the
drawings? - Determines whether clicking a change in the comparison results table
automatically finds the object in the drawing views. Click Yes to automatically find the
corresponding objects in the drawing views; click No to turn this option off. By default, this option
is set to Yes.
When finding an item in the drawings, what method do you want to use? - Sets how you
want the Compare window to behave when the software automatically locates an object in the
drawings. Available options include the following:
 Zoom in on minimum bounding box - Zooms the drawing views to the selected object
regardless of the current zoom level in either drawing.
 Center on the item without changing zoom level - Centers the drawing views on the
selected object using the current zoom level.

 View and compare document versions (on page 205)
 Compare document versions (on page 206)
 Select the layout for the Compare window (on page 208)
 Change colors for comparison results (on page 210)
 Change display indicators for comparison results (on page 210)
 Change auto-focus options for comparison results (on page 210)
 Find a change in the Comparison Results table (on page 211)
 Find a selected change in compared drawings (on page 211)
 Learn more about the View and Compare window (on page 212)

Document Management
View and compare document versions

This command is not available for use with 3D models.
1. Press CTRL and select two versions of the same document in the list view.
2. Right-click the versions and select View and Compare.
 The two documents you selected to compare display in side-by-side graphical views.
 A list of differences between the two documents displays in a comparison results table
under the graphical views.
 Differences between the two documents appear in different colors. By default, new
items appear in red, deleted items appear in green, modified items appear in blue, and
items that are the same appear in black. You can change these default colors by
clicking Set View Options .

Document Management
3. To center the display on a particular item in both views, click the item in the table.
 When you click an item in the view or in the table, the software also displays properties
for the selected item in a properties window to the right of the view panes. The
properties are color coded to show whether they are new, deleted, modified, or the
same. If the properties window contains identical properties, you can click Show
Modified to show only modified properties.
 By default, the software centers on an object in the drawings when you click the object
in the comparison results table. You can change the default auto-focus behavior by
clicking Set View Options , and then changing the options on the Auto-focus tab.
 If you right-click a navigable object, a menu for that object displays. If you right-click
elsewhere in the drawing, a menu for the document displays. In some cases the menu
is not be available. For example, if a deleted item is selected, the shortcut menu is not
be available unless the effectivity date is set back to a time when the item existed.
4. To display the changes for a particular item in the properties grid, click the item in the
appropriate graphical view.
To automatically find an object in the comparison results table, click an object in the
graphical view. This behavior is automatic if you have selected Yes for the When selecting
an item in the drawing, do you want to automatically find it in the list of changes?
option on the Auto-focus tab of the Set Display Preferences dialog box.
5. To sort the properties alphabetically, click , or to sort the properties by category, by

clicking .
6. To filter a column in the comparison results table, right-click the column header, point to
Filter, and then click the type of information by which you want to filter the column.
To define a custom filter, click Filter > (Custom). Then define your filter criteria in the
Custom Filter dialog box and click OK.
7. To move through the changes in the comparison results table, use the Next Change
and Previous Change buttons on the toolbar.
Compare document versions

The Compare command allows you to compare two revisions or two versions of a published
document. This command is available only if you have selected two revisions or versions of the
same document.
2. Right-click and select Compare.

Document Management
The Document Version Comparison dialog box displays the differences between the two
versions.

Document Management
3. To create a Microsoft Excel report of the differences, click Export.
Select the layout for the Compare window

1. In the View and Compare window, click Set View Options .

Document Management
2. On the Layout tab, click the layout that you want for the View and Compare window.
On the Layout tab, different colors represent different parts of the View and Compare
window:
3. Click OK.

Document Management
Change colors for comparison results

2. Click the Display tab.
3. Under Color Settings, click the type of comparison result for which you want to change the
display color.
4. Click Set Color.
5. Select the color that you want, and click OK.
6. In the Set Display Preferences dialog box, click OK.
 To restore the default display color for the selected type of comparison results, click
Restore Default Color.
 By default, the following colors represent types of comparison results:
 To restore the default display colors for all results, click Restore All Default Colors.
Change display indicators for comparison results

3. Under Drawing Item Display Indicators, select the Set Color option beside each result
type that you do not want to use color to identify.
By default, color is turned on for all result types.
4. If you want a result type to appear in bold in the drawing, comparison results table, and the
properties window, select the Make Bold option beside that result type.
 By default, bold is turned off for all result types.

 You can combine color and bold text by selecting both the Set Color and Make Bold
options for a result type.
5. Click OK.
Change auto-focus options for comparison results

2. Click the Auto-focus tab.
3. Select the appropriate options to determine the software behavior when you select an object
in the drawing view or the comparison results table.
4. Click OK.

Document Management
Find a change in the Comparison Results table

The Find Change in List command finds the changes for an object in the comparison
results table when you select the object in one of the drawing views. The software finds the
change automatically in the table if the When selecting an item in the drawing, do you want
to automatically find it in the list of changes? option on the Auto-focus tab of the Set
Display Preferences dialog box is set to Yes.
The Previous Change command moves to the previous change in the comparison results
table.
The Next Change command moves to the next change in the comparison results table.
1. In the View and Compare window, click an object in one of the drawing views.
 If you set the When selecting an item in the drawing, do you want to automatically
find it in the list of changes? option on the Auto-focus tab of the Select Display
Parameters dialog box to Yes, the software automatically finds the object in the
comparison results table.
 You can click Set View Options to display the Set Display Preferences dialog box
to change this option.
 If this option is set to No, continue to step 2 to display the selected change in the table.
2. Click Find Change in List .
Find a selected change in compared drawings

The Find Change in Drawing command finds the change you selected in the comparison
results table in the drawing views. The software finds the change automatically in the table if the
drawings? option on the Auto-focus tab of the Select Display Parameters dialog box is set to
Yes.
 You can use the down arrow beside the toolbar button to specify that the command be
applied to the left or right view.
 If you click the icon, the command is applied to both drawings.
1. In the View and Compare window, click a change in the comparison results table.
 If you set the When selecting an item in the list of changes, do you want to
automatically find it in the drawings? option on the Auto-focus tab of the Set
Display Preferences dialog box to Yes, the software automatically finds the object in
both drawings.
 If this option is set to No, continue to step 2 to display the selected change in the
drawings.
2. Click Find Change in Drawing .
 The properties window automatically updates when you click an object in one of the
drawings.

Document Management
Learn more about the View and Compare window

changes highlighted. The following explains more about the options available in the View and
Compare window.

 Set view options (on page 212)
 Zoom in (on page 212)
 Zoom out (on page 212)
 Zoom area (on page 213)
 Fit (on page 213)
 Pan (on page 213)
 Select (on page 213)
 View and markup (on page 214)
Set view options

The Set View Options command allows you to set the layout, colors, and other view options
for the Compare window.
Zoom in
The Zoom In command increases the drawing view magnification. You remain in zoom in
mode until you right-click, click Select , or press ESC.
 This command is available only when a drawing is displayed.

Zoom out
The Zoom Out command decreases the drawing view magnification. You remain in zoom
out mode until you right-click, click Select , or press ESC.


Document Management
Zoom area
The Zoom Area command increases the drawing view magnification of an area that you
define with two points. Click the Zoom Area command from the toolbar, and then click in one of
the drawing views and, holding down the left-mouse button, drag to draw a box around the area
on which you wish to zoom.

Fit
The Fit command resets the drawing view magnification so you can see the entire drawing.

Pan
The Pan command repositions the drawing so you can see another drawing area without
changing the view magnification. You remain in pan mode until you right-click, click Select ,
or press Esc. Click the Pan command on the toolbar, and then click in a drawing view and drag
the image in any direction to change the area displayed in the view.

Select
The Select command turns on the Select mode. When in Select mode, you can click an
item in the drawing to view the item properties. Right-click an item to view the shortcut menu for
that item. You can use Select to exit the continuous zoom and pan modes.
This command is available only when a drawing is displayed.

Document Management
View and Markup

View and Markup command allows you to view design files inside a SmartPlant Markup
window rather than the Compare and View window. If SmartPlant Markup Plus is installed on
your client computer, the file appears inside the View and Markup window with the SmartPlant
Markup Plus commands available for viewing and marking up the file.
For more information about using the Markup commands, refer to the SmartPlant Markup Plus
Help.
If the file is a master file, it can be viewed along with its nested references.
 For more information about using View and Markup commands in SmartPlant Foundation,
see View and mark up files (on page 107).
Archive and purge

The archive and purge functionality is mainly driven from vault and database sizing. Archive is a
process in which all the files attached to selected versions of documents are copied to a
specified location. During the process of archiving, the physical files are moved from the vault or
database to a designated location, and if the purge option is set to true, the designated file
objects are deleted from the database.
System administrators can configure the Archive Files command with the purge option set to
True or False. When the Purge option is set to True, all of the archived file records and the
physical files are deleted from the database.

 Archive files (on page 215)
 Review the archive document and archive information files within Desktop Client (on page
216)

Document Management
Archive files
This command removes the files attached to a selected document version from the vault and
copies them to a specified locations elsewhere. After the archive is complete, the relationships
between the document and the files still exist in the database, and are visible through the
Desktop Client. However you cannot use SmartPlant Foundation to view or check out the files.
This command is available when you right-click a document and then click Files > Archive
Files.
The Archive Files command submits a task to the scheduler, an asynchronous process, to
perform the operation.
1. Right-click the document to be archived and select Files > Archive Files.
2. If you want the software to notify you when the scheduler has completed the archive
process, click Yes in the information box. Click No if you do not want a notification.
 You must wait for the scheduler to complete the process as configured in the scheduler task
for archive and purge.
 Check with your system administrator for the default location for archived files.
 The software creates a folder in this location, using the name of the archived document
as the folder name.
 Attached files are located within this folder.
 An archive document is created in Desktop Client. You must have administrative privileges
to view the archive document.
 An archive information file is also created. Check with your system administrator for the
default location for these files.
 By default, the name of the file is ArchiveInfo<date and time stamp>.txt. (The date
and time stamp is in GMT.)
 If you have administrative privileges, you can access the archive information file within
Desktop Client.
 The Archive Date property of the document can be found on the property grid, or in the
document's history.
 If your system administrator has checked the Purge option for the archive method, then the
archived files are deleted from the original vault when you perform an archive.
1. In the Desktop Client, click Find > Administration > Archive Document.
You must have administrative privileges to access the Find > Administration >
Archive Document command.
2. Right-click the archive document you want to review and select Show All Files to display
the ArchiveInfoFile document.
3. Right-click the ArchiveInfoFile document and select View and Markup to view the content
of the file.

Document Management
The ArchiveInforFile document contains details of what files that are attached to the
archived document, what files were removed from the vault, and the location of the files.
Review the archive document and archive information files

within Desktop Client
1. In the Desktop Client, click Find > Administration > Archive Document.
You must have administrative privileges to access the Find > Administration >
Archive Document command.
2. Right-click the archive document you want to review and select Show All Files to display
the ArchiveInfoFile document.
3. Right-click the ArchiveInfoFile document and select View and Markup to view the content
of the file.
The ArchiveInforFile document contains details of what files that are attached to the
archived document, what files were removed from the vault, and the location of the files.
Reference files
In SmartPlant Foundation, certain file types, such as MicroStation files, AutoCAD files, and
Word files, can reference other files. Files that reference other files are called master files. The
files referenced by master files can be manipulated separately or reused. File types that allow
reference files include MicroStation, AutoCAD, Word, Excel, PowerPoint, Solid Edge, and
SmartSketch files.
SmartPlant Foundation tracks the relationships between these reference files and master files in
order to keep the files associated during check in, check out, viewing, and other SmartPlant
Foundation operations. This tracking is managed by creating reference relationships between
the files. Reference relationships are created between files when a master document is created
and files are attached and when the master file is checked back in after a checkout. These
relationships are created because the user can add or delete reference files while the master file
is checked out.
When a file is attached or checked in, SmartPlant Markup Plus reads the headers of all files,
extracts the reference file names, and supplies the reference file names to SmartPlant
Foundation. As a result, relationships defined in the native application are honored in
SmartPlant Markup Plus must be installed on the SmartPlant Foundation server for
reference file relationships to be created.
When a user checks out or views files that have references, SmartPlant Foundation provides a
copy of the reference files along with the master file to the user's computer.
Reference files can contain links to other reference files. The system administrator can configure
SmartPlant Foundation to process these nested reference files while checking in, checking out,
viewing, and other operations on the master file. The maximum number of nested reference files
allowed in these operations is set in the User Preferences. For more information, see Change
user preferences (on page 83).
The system administrator can also configure SmartPlant Foundation to allow files to reference
themselves or to reference each other in a cyclical relationship. Document A can reference
document B, and document B can reference document A. These relationships can be created in
SmartPlant Foundation by dragging reference files onto the files they reference.

Document Management
In the following example, the 3A document is a reference file of 2A, which in turn is a reference
file for 1A. However, document 1A is also a reference file for document 3A.
 If the file you are attaching references other files and those files are already in SmartPlant
Foundation, the software automatically creates relationships between the file and the
reference files.
displays an error message to let you know that the referenced files do not already exist. You
can create the relationship to the reference file later after it has been added to SmartPlant
Foundation.
 To delete a reference file that was attached to a master file that was deleted, right-click the
document and select Refresh.
Update Reference Relationships dialog box

Allows you to choose what version of a reference file is associated with the master document.

Document Management
Name - Displays the name of the master document and a list of any reference files associated
with it.
Parent Revision Name - Displays the name of the parent revision.
Update Reference Relationship To - Select the version of the reference file to which you want
to create a relationship for the master document. You can choose from the out-of-date version,
the latest released version, or the latest working version of the reference file.
Out of Date Revision - Displays the name, revision, and version number of the superseded
version to which the master file is currently related.
Latest Released Revision - Displays the name of the latest revision that was released for
distribution.
Latest Working Revision - Displays the name of the latest revision that has been created but
was not yet released for distribution.
Reference Control - Indicates the option selected for managing the relationship between the
master file and this references file. This field is display only.
You must select the Show all items on update references dialog option on the
General tab of the Change User Preferences dialog box to view the files with reference
relationships in the Update Reference Relations dialog box.
 If Show all items on update references dialog option is set to True, the files with
reference relationship of Always Fixed is displayed as inactive, while files with the reference
relationships such as Always Update, Prompt Update and Always Update Working
Revisions are displayed as active or inactive depending on their reference relationships
with the master document.
 If Show all items on update references dialog option is set to False, the Update
Reference Relations dialog box does not display the files with up to date reference relation
and the files which do not have up to date reference relation with their Master documents
are displayed as active.
 If Show all items on update references dialog option is set to False, the Update
Reference Relations dialog box does not display when all the files have up to date
reference relation with their Master documents.
Show Nested Reference Files dialog box

Shows the references files associated with a document and how they are related.
Name of item - Shows the selected file at the top of a hierarchical tree with all the reference
files associated with it listed below.
Rev - Indicates the revision number of the document.
Revision - Indicates the full revision and issue number of the document.
Default Status - Shows the current status of the selected document and its reference files.
Classification - Provides the classification for each file.
Last Updated - Specifies when each file was last updated.

 Learn more about file types for reference files (on page 219)
 Update Maintain Relations properties on reference files (on page 220)
 Update reference relationships (on page 221)

Document Management
 Show nested reference files (on page 221)

 View reference files for a document revision (on page 222)
Learn more about file types for reference files

Before you start creating reference files, you need to understand what files types can be
associated as reference files to master files. The following table illustrates what types of
reference files (listed down the left side of the table) can be associated with master files of a
specific type (listed along the top of the table). For some types of files, specific versions of the
software or configurations are required.
Microsoft Microsoft Microsoft Linking

Word Excel PowerPoint Types
Microsoft OK OK Master file should be All
Word created using Office XP
or a later version.
Excel created using Office XP
or a later version.
PowerPoint created using Office XP
or a later version.
Notepad Master file should be Master file should be Master file should be All
created using Office XP created using Office XP created using Office XP
or a later version. The or a later version. The or a later version. The
Link and Display as Link and Display as Link and Display as
icon check boxes icon check boxes icon check boxes
should be selected should be selected should be selected
while creating while creating while creating
references. references. references.
JPEG Master file should be Master file should be Master file should be All
BMP Master file should be Master file should be Master file should be All

Document Management
Microsoft Microsoft Microsoft Linking

Word Excel PowerPoint Types
PDF Master file should be Master file should be Master file should be All
Update Maintain Relations properties on reference files

1. Right-click the master design file for which you want to update the maintain relations
properties for reference files and select Show Referenced Files.
 Master design files are those that have reference files associated with them.
 To display the master file, right-click the document revision with which the file is
associated and then select Show All Files.
2. Right-click the reference file for which you want to update the maintain relations property
and select Update Relationship.
3. In the Maintain Relations list, select the relationship that you want to preserve between the
revision and its reference files during document sign off if newer revisions of reference files
exist in SmartPlant Foundation.
You can also right-click the master design file and select Edit Reference
Relationships. On the Edit Relationships dialog box, click Maintain Attributes.
An asterisk (*) indicates that an option is required to create a new object.

The options for the maintain relations action include the following. These options
control what happens during sign off if newer revisions of those reference files are available.
same.
 Always Update - Automatically updates reference files to the latest revision in
SmartPlant Foundation when you sign off the document revision with which reference
files are associated.

Document Management
 Always Update Working Revisions - Automatically updates relationships to versions

of the latest working revisions.
 Prompt Update - Requires user to provide information when an updated revision of a
reference file exists
4. Click OK.
Update reference relationships

The Update Reference Relationships command allows you update out-of-date reference files
on a master document. This command is available when you right-click a document, then click
Reference Documents > Update Reference Relationships.
1. Right-click a document revision for which you want to update reference relationships and
select Reference Documents > Update Reference Relationships to open the Update
Reference Relationships dialog box.
2. Select a document and update the reference relationship.
3. Click Process Updates to save changes.
Show nested reference files

The Show Nested Reference Files command allows you to view a list of all the nested
reference files associated with an object. This command is available when you right-click on a
document in the tree view. Nested references occur when a document references a file that is
also referenced by other documents in SmartPlant Foundation. In the following example, Level 2
Document is a reference file for Level 1 Document, which, in turn is a reference file of Master
Document. In this case, Level 2 Document has a direct relationship with Level 1 Document, but
not Master Document.
 Right-click a document revision for which you want to view reference file and select
Reference Documents > Show Nested References.

Document Management
View reference files for a document revision

The Show Nested References command allows you to view document revisions that are
reference files for a selected document. When you right-click an object for which you want to
view reference files, the Show Nested References command displays.
 Right-click a document revision for which you want to view reference file and select
Reference Documents > Show Nested References.
Watermarks and labels

Watermarks and labels are lines of text that appear on printed documents. Watermarks are
half-tone text appearing behind the main document content, and labels appear in the header or
footer margins of printed documents. Watermarks and labels can be added to new or existing
documents, and can be used to indicate the status of a printed document, such as Confidential,
Approved, Working, Approved for Construction, and so on.
Watermarks and labels can be associated with documents during document creation or update,
or by dragging and dropping the watermark or label on the document. Watermarks and labels
can also be associated with documents by using a load file. You can edit watermark and label
text when printing document files.
More than one watermark or label can be defined. Each string should be separated by
an ampersand (&). For example, &obj.Name&&obj.Description&.
Your system administrator may also configure watermarks and labels to print by default (such as
an "Uncontrolled copy" watermark). Refer to the How To Configure the Document Management
Model guide for information on strategies for watermarks and labels.
New Watermark dialog box

Allows you to create a new watermark in SmartPlant Foundation.
Name - Specifies the name of the watermark object.
Description - Specifies the description of the watermark.
Watermark text - Displays the text that appears as the watermark on the print document.
Watermark type - Specifies the fill pattern of the watermark text. Choose from outlined text,
filled text, hatch-patterned text, or text that combines the outline and filled styles.
Position - Specifies the position of the watermark on the printed page. The watermark can be
printed vertically, horizontally, or diagonally across the sheet.
Font name - Specifies the font to use for the watermark text. Select either Arial, Courier, Times
New Roman, or Verdana
Font size - Specifies the size of the watermark text. Available font sizes range from 8 to 72
points.
Font style - Specifies whether the watermark text is bold, italic, or regular.
New Label dialog box

Allows you to create a new label in SmartPlant Foundation.
Name - Specifies a name for the new object.
Description - Specifies a description for the new label.
Top left label text - Specifies the text to appear in the upper left corner of the page when a
document associated with the label is printed.

Document Management
Label top center text - Specifies the text to appear in the upper center of the page when a
Label top right text - Specifies the text to appear in the upper right corner of the page when a
Label bottom left text - Specifies the text to appear in the lower left corner of the page when a
Label bottom center text - Specifies the text to appear in the lower center of the page when a
Label bottom right text - Specify the text to appear in the lower right corner of the page when a
Font name - Specifies the font to use for the label text. Select either Arial, Courier, Times New
Roman, or Verdana
Font size - Specifies the size of the label text. Available font sizes range from 8 to 72 points
Font style - Specifies whether the label text will be bold, italic, or regular.

 Create a new watermark (on page 223)
 Attach a watermark to a document (on page 224)
 Print a document with a watermark (on page 225)
 Create a new label (on page 225)
 Attach a label to a document (on page 225)
 Print a document with a label (on page 226)
Create a new watermark

The Watermark command allows you to create a new watermark to be printed behind the
image.
1. Click File > New > Organization / Support Items > Watermark.

Document Management
2. Define details for the new watermark.
Watermarks are visible only when printed.
Attach a watermark to a document

1. Search for the document to which you want to attach a watermark.
For more information about how to find objects, see Search for Objects (on page 95).
2. Search for the watermark that you want to attach to the document.
3. Select the watermark file in the list view and drag it on the document.
4. In the Relationship Name column, select the appropriate option in the list to indicate
whether you want to relate the watermark to the selected document revision or the
document master.
5. On the New Relationship dialog box, click OK.
Attached watermarks are visible only when printed.
You can also right-click the document and select Document > Update Document to open
the update form for the document. From that form, you can select an existing watermark to
associate with the document master.

Document Management
Print a document with a watermark

1. Search for the document that you want to print. For more information, see Search for
Objects (on page 95).
2. Verify the appropriate watermark is attached to the selected file. For more information, see
Attach a watermark to a document (on page 224).
3. Right-click the document and select Files > Print.
Batch printing must be configured to print documents with watermarks.
4. On the Print dialog box, set up the printing information to meet your needs.
5. Click Options to open the Batch Print Options dialog box to allow you to modify the
watermark information for the printed copy of the drawing or document.
Create a new label

The Label command allows you to create a new label.
1. Click File > New > Organization / Support Items > Label.
2. Define details for the new label.
 Options followed by an asterisk (*) are required to create the selected object.
 Attached labels are visible only when printed.
Attach a label to a document

1. Search for the document to which you want to attach a label.
For more information about how to find objects, see Search for Objects
2. Search for the label that you want to attach to the document.
3. Select the label object and drag and drop it onto the document.
4. In the Relationship Name column, select the appropriate option in the list to indicate
whether you want to relate the label to the selected document revision or the document
master
5. On the New Relationship dialog box, click OK.
Attached labels are visible only when printed.
You can also right-click the document and select Document > Update Document to open
the Update form for the document. You can select an existing watermark to associate with the
document master on the Update form.

Document Management
Print a document with a label

1. Search for the document that you want to print.
2. Verify the appropriate label is attached to the selected file.
3. Right-click the document and select Files > Print.
Batch printing must be configured to print documents with labels.
4. On the Print dialog box, set up the printing information to meet your needs.
5. Click Options to open the Batch Print Options dialog box to allow you to modify the label
information for the printed copy of the drawing or document.
List documents
Documents that are configured to manage lists are list documents or list management
documents. The List Edit window is used to create these documents and to manage their
related lists.
After you create a list document, you can create a snapshot of the list document, which creates
XML and XLS files with the data in the database at the time that the snapshot was made for all
the objects included in the list. If your configuration supports it, you can then publish the
snapshot to the data warehouse.
For more information about configuring list management documents, see List Management
Console in How to Configure the GUI Model.
List Edit window (with SaveAs)

The list editing functionality can be configured to save and manage a list of objects as a
document. The list is configured to display any number of instances of some type of object,
along with a specified set of properties of that object. From this list, view in the List Edit window,
you can view the list and data, modify the data of existing objects, create new objects, or
terminate or delete object, depending on your configuration and your user permissions. In
addition to features for managing object data, this environment may include two additional
buttons for saving the list as a new list document in the database or for attaching the list to an
existing list document
Once you have customized the list of items that are displayed in the List Edit window, you can
save the list to a list document. You can create a new list document or attach the list to an
existing document.
See List Edit window (on page 45) for details about using the List Edit window.
The type of list document available varies based on how your administrator has
configured your system. The name of the type of list document to which your list is attached is
reflected in the option on the List Edit window.
If you have changed the list in the List Edit window, you are prompted to save those changes
before attaching the list to a list document.

 Create a new list document (on page 227)
 Edit a list associated with a list document (on page 227)
 Attach the list to an existing document (on page 227)
 Create a list document snapshot (on page 227)
 Create a line list document snapshot (on page 228)

Document Management
Create a new list document

1. In the List Edit window, click the button for saving the list to a new list document to open the
Create form or wizard for the type of document.
The name of the button is provided by your system administrator when they configure
the List Edit window to manage objects
2. Use the create form or wizard to create a new object.
Edit a list associated with a list document

1. Right-click a list document and select List Edit Related Items to edit a a list of objects that
is managed by a list document and open the List Edit window.
2. Use the List Edit window to manage the list of items related to the list document.
See List Edit window (on page 45) for more information on how to use the List Edit window.
Attach the list to an existing document

1. In the List Edit window, click the button for saving the list to an existing list document to
open the Query wizard for the type of document object.
The name of the button is provided by your system administrator when they configure
the list edit window to manage objects
2. Query for the existing list document object to which you want to attach the list.
If the list document object you choose already has a list related to it, you can replace the list
or append your new items to the list.
Create a list document snapshot

1. Find the tag or tags for which you want to create a list document.
2. Right-click the tag or tags and select List Edit with Save as Document.
Depending on your configuration, this command may not be available to you.
3. Click Find > List Documents to find the list document that manages the list for which you
want to create a snapshot view of the database.
4. Right-click the list document, and click Create Snapshot.
The document you select to snapshot must be working and checked in. The latest
version should not be superseded.
When you create a snapshot of a list document from the List Edit window, the
software uses the width of columns defined in the column set by your administrator, not the
column widths the size of the columns as you may have changed them in the List Edit
window. For more information, see How to Configure Document Management.

Document Management
Create a line list document snapshot

1. Find the line list for which you want to create a snapshot. To find the line list, click Find >
Line List > Line Lists.
Creating a snapshot allows you to control what information you publish to the data
warehouse when you publish a particular revision of the line list record snapshot.
2. Right-click the line list, and click Show Line List Record Document.
If the line list record document does not already exist, you can create one by
right-clicking the line list and clicking Create Line List Record Document.
3. Right-click the line list record document, and click Create Snapshot.
If you are working in an integrated environment and have not registered the line list
application (LLA) with the data warehouse, you must register before you can create a line
list record document or snapshot. This is required because a revision has to be reserved in
the warehouse when the document is created. For more information, see Register
SmartPlant Foundation (on page 238).
 When you create a snapshot of a line list document from the line list, the software uses the
column widths defined by your administrator in the SPFLLASnapshotTemplate Excel
template, not the size of the columns in the List Edit window for the line list record. For
more information, see How to Configure Document Management.
 When you create a snapshot, the software creates a new version of the line list document
snapshot and attaches it to the line list document.

SECTION 8
Relationship Management
The Desktop Client provides options for creating, viewing, editing, and terminating relationships
between objects.
You can create a relationship by dragging object onto another object, for example, dragging a
label onto a document. You can also create a relationship by selecting a parent object when you
create a new object. For example, to relate a new unit to an existing area, you would select the
area from the Functional area list on the New Unit form when you create the unit.
The shortcut menu for an object provides options for viewing and terminating relationships.
The procedures in this section are for non-administrative users. If you are a system
administrator, see How to Configure the GUI Model guide for information about configuring
relationship management and managing related items.
New Relationship dialog box

Allows you to create a relationship between two or more objects.
Child Object - Displays the name of the child object.
Relationship Name - Allows you to select the type of relationship that is created.
Properties - Displays the properties for the relationship.
Apply to similar items - Specifies whether the relationship selected in the Relationship Name
column applies to all similar objects in the table. Similar objects have a different color
background to help you identify them. If the Apply to similar items check box is selected and
you select a relationship, the software creates the same relationship for all objects with the
background color.
Manage <Object> dialog box

Allows you to create, update and delete objects and their relationships.
Existing Related Objects Table

Name - Displays the name of objects that have been related.
Move Selected Item Up - Moves the selected object up one position.
Move Selected Item Down - Moves the selected object down one position.
Remove Selected Item - Removes the selected object from the table.
This dialog box can exist with or without a library pane. The Remove Selected Item
behaves differently in these cases. If the library pane is used in the dialog box, Remove
Selected Items only removes relationships between related objects, but does not delete
objects from the database. If the library pane is not displayed, the Removed Selected Item
option deletes the related object from the database.

All Objects Table

Name - Displays the name of objects that are available to be related.
Create - Creates a new object.
Update - Updates an object
Delete - Deletes an object.
Relate Selected Item - Adds the selected object to the related objects table.
Maintain Relationships dialog box

Allows you to add, remove, and edit related items from an object. This dialog box is available
from relationship tabs on an object's Update dialog box.
Available items - Displays items that are not related to the object, but are available to relate.
Related items - Displays items that are related to the object.
Find - Allows you to use quick find to locate objects.
Advanced Find - Allows you to use an object's Query dialog box to locate objects.
Apply to similar items - Select this option to apply any changes made to an item related to the
object. Select this option before clicking Maintain Attributes.
Maintain Attributes - Opens the Update dialog box for the selected relationship in the Related
items list. If the Apply to Similar Items option is selected, any changes you make are applied
to all relationships in the Related items list.

 Drag objects to create relationships (on page 231)
 View relationships (on page 232)
 Update relationship data for an object (on page 232)
 Create, edit, or delete related items in a list edit window (on page 232)
 Maintain relationships for an object (on page 233)
 Terminate relationships (on page 235)

Drag objects to create relationships

You cannot modify or create relationships using data published from other tools.
1. Select the object or objects that you want to relate to another object.
 To display the objects that you want to relate, you can browse to the objects in the tree
view or use the commands on the Find or Query menu to find the objects.
 You can multi-select objects to drag.
 You can drag the object(s) onto another object in the same window or in another
window.
 If the selected object has a default action and your default mouse click action is set to
single click, the default action is performed before you can drag and drop the object.
2. Drag the object or objects onto the other object.
 Some relationships require you to drag in only one direction. If the drag function
between valid objects is not successful in one direction, try the other direction.
 If there are no valid relationships for the objects, the Status Bar displays the message
"No valid relationship definitions found."
3. In the New Relationship dialog box, select the object or object to relate.
 If there are multiple relationships to choose from, you can select the appropriate
relationship in the Relationship Name box.
 If there are multiple possible relationships that could be created to the selected objects,
the objects that are similar are grouped together by color. Changes made in the
Relationship Name box apply to all selected objects if you select the Apply to similar
items check box.
 If a relationship supports attributes, the Properties box displays a Maintain Attributes
hyperlink. Click the hyperlink to edit the attributes for the relationship.

4. Click OK to create the relationship and close the New Relationship dialog box.
View relationships
1. Right-click the object for which you want to display related objects.
2. On the shortcut menu, click the View or Show command for the relationships you want to
view.
 You can select the object for which you want to display relationships from the Tree view, the
New Items window, or the list view.
 If a relationship supports attributes, you can view the attributes by clicking the Show
Attributes hyperlink for the relationship.
Update relationship data for an object

The Update and Details dialog boxes can be configured to display relationship data on tabs.
From a relationship tab on an object Details dialog box, you can view related items. From a
relationship tab on an object Update dialog box, you can add, delete, and edit related items.
You can use the List Edit window to create and relate items to the object.
Right-click a related object on a relationship tab on the Update dialog box or Details dialog box
for viewing and editing options.
Any changes made to related items are saved when you click Finish on the
Update dialog box or Cancel on the Details dialog box.
For more information about configuring relationship tabs, see Configure Relationship Tabs on
Forms in the How to Configure the GUI Model guide.
Create, edit, or delete related items in a list edit

window
If list editing is configured for the related item, you can use the List Edit window to create and
relate items to the object.
If list editing is not configured for the related item, the List Edit button is not visible. For
more information about configuring list editing for an object, see List Editing in the How to
Configure the GUI Model guide.
2. On the shortcut menu, click Update to open the Update dialog box.
3. If there are multiple tabs on the Update dialog box, select the tab for the type of related
object you want to update.
4. Click the List Edit button on the appropriate tab to open the List Edit window.

If more than one type of list editing is configured for the item, the List Edit dialog box
appears. Select the type of list editing you want to use, and click OK. For more information,
see the Multiple List Edit Windows Available section in List Edit window (on page 45).
5. Use the List Edit window to create, delete, or edit items related to the object. Click OK or
Apply to save your changes. For more information about using the List Edit window, see
List Edit window (on page 45).
Changes made to objects in the List Edit window are saved when you click OK or
Apply in the List Edit window. However, the relationships between these objects and the
object you are updating are not saved until you click Finish on the Update dialog box.
Maintain relationships for an object

You can use the Maintain Relationships dialog box to relate items to an object and edit
properties on link interfaces, if applicable.

2. On the shortcut menu, click Update to open the Update dialog box.
3. If there are multiple tabs on the Update dialog box, select the tab for the type of related
object you want to update.
4. Click the Maintain Relationships button on the appropriate tab to open the Maintain
Relationships dialog box.
5. To find items to relate to the object, use the Find or Advanced Find buttons. The Find
button allows you to use quick find to search for an item. The Advanced Find button allows
you to search for an object using the object's Query dialog box.
6. To relate an item to the object, select an item or multiple items in the Available items list,
and click to move the item to the Related Items list.
7. To delete a related item, select an item or items in the Related Items list, and click to
move the item to the Available items list.
 If there are items related to the object through a link interface, the Maintain Attributes
button and the Apply to similar items option are available. To edit an item related to the
object by a link interface, select the item in the Related items list and then click Maintain
Attributes.
 If you want to apply the changes to all the related items, select the Apply to similar items
option and then click Maintain Attributes. Make the desired changes on the relationship's
Update dialog box, and then click OK.

Terminate relationships
1. Right-click the object where you want to terminate relationships.
2. On the context menu, click Terminate Relationships.
3. In the Terminate Relationships dialog box, select the objects for which you want to
terminate relationships.
4. Click OK.


SECTION 9
Use SmartPlant Foundation as an

Authoring Tool
SmartPlant Foundation plays multiple roles within the SmartPlant Enterprise. It is commonly
used as a data warehouse to facilitate integration among discipline-specific applications and
business suites, but also has powerful capabilities to create and modify information for use by
other tools. SmartPlant Foundation can create or edit data by:
 Importing data from XML or NLF files using the Loader.
 Importing data from a spreadsheet using Excel Import.
 Entering data on forms within SmartPlant Foundation; for example, Create a new object
using the Create dialog box (on page 152) or Create a new design document (on page 162).
 Inputting data on data lists and data sheets.
Data Sheets and Data Lists (on page 241)
Line Lists (on page 273)
 Retrieving data from the data warehouse after it has been published by another tool.
Integration (on page 391)
SmartPlant Foundation authoring environment can be configured to have:
 The data warehouse separate from authoring database.
 Both authoring and the data warehouse combined in one database.
The SmartPlant Foundation security model is a flexible mechanism to control role-based user
access to the authoring database and data warehouse. Domains and roles control who can
access data and what they can do with it. For example, in an authoring environment, a user
must have access to the instrumentation domain in authoring to create or edit instruments using
SmartPlant Foundation. To learn more about domains, roles, and users, see the How to
Configure the Security Model guide.
Register SmartPlant Foundation as a Tool

Before you can publish and retrieve data, the authoring tools, including SmartPlant Foundation,
must register each plant in the authoring tool with the SmartPlant Foundation data warehouse.
For more information about registering SmartPlant Foundation to the data warehouse, see the
How to Configure the Authoring and Data Warehouse Models guide.
Your domain and role determine the discipline, or tool, to which SmartPlant Foundation is
registered. For more information about domains, see the How to Configure the Security Model
guide.

 Register SmartPlant Foundation (on page 238)
 Find registered tools (on page 238)

Use SmartPlant Foundation as an Authoring Tool
Register SmartPlant Foundation

1. Click SmartPlant > <Application Type> > Register.
For example, to register SmartPlant Foundation as a process engineering tool, click
SmartPlant > Process > IPDs > Register. To register SmartPlant Foundation as an
instrumentation tool, click SmartPlant > Instrumentation > Register.
2. 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>.
3. In the Plant name list, select the appropriate plant. Be sure that you know the SmartPlant
Foundation plant to which you need to register.
4. Click Finish. If the registration completes successfully, the Register With SmartPlant
Software message box appears.
Find registered tools

The SmartPlant > Registered Tools command allows users to view a list of authoring tools that
are registered with the current plant.
SmartPlant Registration Wizard

Steps you through the process of associating plants in your authoring tool with a SmartPlant
Foundation plant.
SmartPlant Registration Wizard - SmartPlant Foundation URL

This page allows you to register your authoring tool plant with a valid SmartPlant Foundation
URL.
SmartPlant Foundation URL - Enter the node name and virtual directory of the SmartPlant
Foundation database with which you want to register the active application. Use the following
format: http://SPFServer/VirtualDirectory.

Browse - Displays a list of available nodes. After selecting the node name, you must add the
name of the virtual directory to the end of the path.
Next - Opens the next page in the wizard: SmartPlant Foundation Plant.
SmartPlant Registration Wizard - SmartPlant Foundation Plant

This page allows you to specify the SmartPlant Foundation plant with which to register your
authoring tool plant.
Plant name - Select the SmartPlant Foundation plant with which you want to associate your
authoring tool plant. This list reflects the SmartPlant Foundation plants available at the URL you
specified on the previous page.


SECTION 10
Data Sheets and Data Lists

Both data sheets and data lists allow you to view and edit data in SmartPlant Foundation. The
key difference between data sheets and data lists is that data sheets present an extensive set of
data about a single object, whereas data lists present a smaller set of data about multiple
objects. When SmartPlant Foundation is used in an integrated environment, you can publish
data sheets and make them available for retrieval by other tools.
Edit Microsoft Excel security settings for data sheets

and data lists
Excel macros control the edit session in SmartPlant Foundation data sheets and data lists. To
ensure that you can save changes, edit the Excel macro security settings as follows.
If you use Excel 2003, follow the steps below:
1. Click Tools > Macro > Security.
2. On the Security Level tab, select Medium.
3. On the Trusted Publishers tab, select the Trust all installed add-ins and templates and
Trust access to Visual Basic Project options.
If you use Excel 2007, follow the steps below:
1. If the Security Warning message bar is displayed, skip to step 7.
2. Click the Microsoft Office button, and click Excel Options.

3. Click Trust Center, and click Trust Center Settings.
4. Click Message Bar, and select Show the Message Bar in all applications when content
has been blocked.
5. Click Macro Settings, and select Trust access to the VBA project object model.
6. Click OK on the Trust Center dialog box and OK on the Excel Options dialog box.
7. Close the spreadsheet, and open it again. The Security Warning message bar should be
displayed.
8. Click Generate <type> Data Sheet if you are using SmartPlant Foundation to create
datasheets, such as an instrument data sheet or equipment data sheet.
9. Click Options on the Security Warning message bar.
10. Ensure that the File Path is the location where your Excel files or templates are stored.
 If you are generating instrument data sheets or instrument indexes, the path is ...\Local
Settings\Temp\SPFDatasheet.
 If you are generating equipment data sheets, the Excel files are located in the Enhanced
Data Sheets folder.
11. Select Enable this content. The data sheet macro is now enabled.

Data Sheets
In SmartPlant Foundation, data sheets allow you to view, edit, and print the data for an object in
an easy-to-use, configurable format. Data sheets are edited directly in Microsoft Excel. Changes
are then saved in the SmartPlant Foundation database until you are ready to publish the data
sheet for retrieval by other authoring tools. You can also save the data sheet offline for editing
by users who do not have access to SmartPlant Foundation.
In addition to basic data sheet functionality, SmartPlant Foundation also supports the following
specific types or uses for data sheets:
 Partially mapped data sheets (on page 255)
 Document-managed data sheets (on page 256)
 Enhanced mechanical equipment data sheets (on page 261), a separately purchased,
add-on module with SmartPlant Foundation.
Access to project data depends on your role assignment and user permissions within a
project.
The following example process data sheet shows properties for a flow instrument object.
Manage Cases dialog box

Allows you to organize, modify, and remove instrument cases. Use this dialog box to specify
which cases you want to display when generating a data sheet.

Available cases - Displays the currently defined cases for the selected instrument.
Existing cases - Displays the cases currently associated with a data sheet. The order in which
the cases appear in this list is the order in which the information will appear on the data sheet.
Use the Move up and Move down buttons to change the order.
Add - Places the selected available case in the Existing cases list.
Remove - Moves the selected case from the Existing cases list to the Available cases list.
Move up - Moves the selected existing case one level higher in the Existing cases list. This
order defines the placement of the case on the data sheet.
Move down - Moves the selected existing case one level lower in the Existing cases list. This
order defines the placement of the case on the data sheet.
Case name - Displays the name of the selected existing case, allowing you to specify whether it
is the governing case and whether it displays on the data sheet.
Governing case - Select this option when you want the case displayed in the Case name field
to be used as the current setting for the instrument.
Generate Data Sheet dialog box

If there is more than one data sheet template available, the software displays a list of templates
from which you can choose to use when creating a new data sheet. When you select a template
and click OK, that template opens in Microsoft Excel.
Name - Displays the name assigned to each available data sheet template.
Description - Displays a brief description of the data sheet template.
The data sheet templates used to generate data sheets in Microsoft Excel are defined
with the Data Sheet Definer. For more information about defining data sheet templates, refer to
New Data Sheet Example in Configuring the Data Sheet Model.

 Learn about instrument data sheet templates (on page 244)
 Edit Microsoft Excel security settings for data sheets and data lists (on page 241)
 Manage process cases (on page 244)
 Create a process case (on page 245)
 Generate and edit an Instrument data sheet (IPD) online (on page 246)
 Generate and edit a data sheet offline (on page 248)
 Load offline data sheets and data lists (on page 250)
 Publish a data sheet (on page 251)
 Retrieve a data sheet (on page 253)

Learn about instrument data sheet templates

Administrators can create and edit data sheet templates using the Data Sheet Definer in
SmartPlant Foundation Desktop Client. For more information about defining data sheet
templates and about configuring the data sheet model, refer to Configuring the Data Sheet
Model.
The following instrument process data sheet templates (IPDs) are delivered with SmartPlant
Foundation.
 Analyzer
 Control Valve
 Flow
 Level
 Pressure
 Relief Valve
 Temperature
 General Instrument
Manage process cases

Process instruments may use different specifications at different times. For example, to increase
efficiency or productivity, you might change parameters, settings, or even components during
different times of the year or in specific situations. These situations are called cases in
You can define cases for each instrument and display the cases on the data sheet generated for
an instrument. You can also choose which case is current by setting it as the governing case.
Process cases are configuration controlled, meaning that each plant or project has its
own set of process cases. In the delivered SmartPlant Foundation system, sample process
cases are delivered in the EFPLANT-SC-2 plant. If you want to use a different plant or project,
you must create your own cases for that plant or project. See Create a process case (on page
245) for more information.
The Manage IPD Cases command allows you to add available process cases to the list of
existing cases for the selected instrument. You can also set a case to be the governing case.
This command is available when you right-click an instrument.
1. Find the instrument for which you want to manage cases.
Find an object (on page 99)
Query for an object (on page 99)
2. Right-click the object in the tree view, and click Manage IPD Cases.
3. In the Manage Cases for Instrument dialog box, select the case you want to add from the
Available cases list, and click Add.
You can use the Ctrl or Shift keys to select multiple cases.
4. Use the Move up and Move down buttons to control the display order on the data sheet.
Cases are displayed on the data sheet in columns from left to right.

5. To specify a governing case, select the case in the Existing cases list, and select the
Governing case option.
6. Click OK to save the changes.

7. Generate a data sheet for the instrument. You can add process case data directly in the
generated data sheet.
Create a process case

1. Click File > New > Organization/Support Items > Process Cases.
This is an administrator command and requires administrative privileges.
2. In the New Process Case dialog box, type a name and description for the new process
case.

3. If you want to associate the process case with a process case collection, select the process
case collection in the Case collection list.
4. Click Finish.
The new process case appears in the New Items window. The new process case also
appears in the list of available process cases in the Manage Cases for Instrument dialog
box when you update cases for an instrument.
You can also create a process case from a process case collection.
Generate and edit an Instrument data sheet (IPD) online

1. Find the instrument for which you want to create a data sheet.
2. Right-click the instrument object, and select Generate IPD Data Sheet.
3. When the Excel spreadsheet appears, click Enable Macros to run the macros associated
with this data sheet, if prompted.
For the data sheet to work properly, you must edit your Excel macro security settings
as described in Edit Microsoft Excel security settings for data sheets and data lists (on page
241).
4. Complete the information on the data sheet as necessary.
 Properties that have enumerated lists defined display a list of values from which to
choose. Click the box, and then select the correct entry from the list.
 Depending on how the data sheet template was designed, you can define the unit of
measure for the entire row by entering a value in the Units column, or you can define a
unit of measure for any particular value.

 For options that require a unit of measure (UOM), select the UOM from the list first, and
then provide the applicable value.
 Radio buttons are now supported in the spreadsheet. The data sheet can be configured
to use a group of radio buttons for enumerated properties rather than a list.
 For options that require text, click the box, type the appropriate text, and then press
ENTER.
The task pane allows you to save data sheet data into SmartPlant Foundation.
The option to save changes into SmartPlant Foundation is disabled when you are editing
offline.
 You can use the Show History command on the task pane to show the changes
made in the current edit session. Changes are indicated by a red triangle in the
upper-right corner of a cell. Rest the cursor over the triangle to view changes.
 Click the Properties command to expand the task pane and display the
properties for the active cell.
 You can change the transparency level of the task pane by using the Opacity control
below the properties display.
 To move the task pane, click the Intergraph logo and drag the task pane to another
position.
5. After you complete the data sheet, save the changes to the SmartPlant Foundation
database by clicking Save on the task pane.
 If you save the Excel file using the File > Save As command in Excel, you cannot
import the resulting Excel file into SmartPlant Foundation.
 Until you click Save, no changes are made to the data in SmartPlant Foundation.
6. To close the data sheet, click File > Exit on the Excel menu bar.

Generate and edit a data sheet offline

1. Find the object for which you want to create an offline data sheet.
2. Right-click the object, and click Generate DEV Datasheet (Offline).
3. Select a download directory for the offline data sheet.
The offline data sheets can now be accessed, reviewed, and edited by other users,
without SmartPlant Foundation. The file may be moved or distributed as necessary.
4. Browse to the new data sheet, and open it in Excel.
241).
6. Complete the information on the data sheet as necessary.
choose. Click the box, and then select the correct entry from the list.
 Depending on how the data sheet template was designed, you can define the unit of
measure for the entire row by entering a value in the Units column, or you can define a
unit of measure for any particular value.
 For options that require a unit of measure (UOM), select the UOM from the list first, and
then provide the applicable value.
 Radio buttons are now supported in the spreadsheet. The data sheet can be configured
to use a group of radio buttons for enumerated properties rather than a list.
 For options that require text, click the box, type the appropriate text, and then press
ENTER.

The option to save changes into SmartPlant Foundation is disabled when you are editing
offline.
made in the current edit session. Changes are indicated by a red triangle in the
upper-right corner of a cell. Rest the cursor over the triangle to view changes.
position.
7. When you have completed the data sheet changes, save the spreadsheet using File > Save
in Excel.
The changes are saved in the .xls and in the .xml versions of the data sheet.
Either the .xls or .xml version of the datasheet can be loaded in the Desktop
Client to reflect the changes made, into the database. However, if the datasheet definition
supports partially mapped datasheets, the .xml version of the datasheet is not created
during the save operation of the datasheet. In this case, the .xls version of the datasheet
needs to be loaded in the Desktop Client to enable partial mapping.
8. Load the changes back into SmartPlant Foundation using the Loader command in the
Desktop Client. Refer to Load offline data sheets and data lists (on page 250) for more
information.

Load offline data sheets and data lists

Changes made in data sheets and data lists offline can be loaded into SmartPlant Foundation
using the File > Loader command in Desktop Client. The availability of this command depends
on your user role.
1. In the Desktop Client, select the appropriate user roles and configuration.
2. Click File > Loader.
3. Browse to the directory where the offline data sheets or data lists are stored.
4. Select the files to load (either the .xls or .xml version of the offline data sheet), and then click
Open. The files appear in the Selected load files pane.
If the data associated with this data sheet in the SmartPlant Foundation
database has been updated since this offline data sheet was generated, the software will
not load the data. The loader will provide an exception message that warns you that the
data you are trying to load is out-of-date.
5. Click Process. The Processed load files pane displays information about the load process
for each file.

6. Click Load Results to view load process details.
7. Click OK, and then click Close.
Publish a data sheet

SmartPlant Foundation publishes instrument and equipment data sheets for use by other
authoring tools.
 You must register SmartPlant Foundation as an authoring tool before you can publish data
sheets. Refer to Register SmartPlant Foundation (on page 238) for details about registering
1. Click Find > Instrumentation > Instruments to find the object for which you want to publish
a data sheet.
2. Right-click the object on which you want to generate a data sheet, then click Publish
Datasheet (IPD).
To publish multiple data sheets at once, click the appropriate Publish command from the
SmartPlant menu on the menu bar, and then select the documents. For example, to create
an instrumentation data sheet for multiple documents, click SmartPlant > Process > IPDs >
Publish.
3. Review the information displayed about the selected document or documents, and provide
any missing information required.
 When publishing from SmartPlant Foundation, you may be required to choose a revision
scheme before you can initiate the first publish. However, when publishing from other
tools, the revision information is defined when you revise the document before the initial
publish or when creating a new revision. For more information, see Revise a document
(on page 440).

 When multiple documents are selected, only property values shared by all the selected
documents appear in the table.
 SmartPlant Foundation allows you to publish to a default workflow. The default workflow
set in Server Manager for a SmartPlant Foundation site is automatically selected on the
Publish dialog box. However, you can the change the default workflow and choose
another workflow on the Publish dialog box.
 If you create a default workflow to which to publish and do not select a workflow on the
Publish dialog box, documents automatically publish to the default workflow.
A document that has been previously signed off can be re-published into SmartPlant
Foundation. You can revise this document and publish it again by using the SmartPlant
menu options. For more information on revising documents, see Revisable and Locked
Documents.
4. From the Operations list, choose a publish method.
 Select Publish to immediately start the publishing process when you click OK.
 Choose the Background publish option if you want to publish the selected documents
as a background operation. When you use this feature, an e-mail message alerts you
when the process is complete.
If the authoring tool supports scheduled batch publishing, select the Scheduled
publish option to indicate that the publish process should be run in batch mode.
5. Click OK to complete the publishing procedure.
 The SmartPlant Schema file must be checked in to SmartPlant Foundation when you
publish. If the publish operation fails, contact your SmartPlant Foundation system
administrator to make sure the SmartPlant Schema is checked in to SmartPlant
Foundation.
 You can revise documents within the integrated environment without exiting the Publish
dialog box using the Documents to Revise dialog box.
 When the publish process is complete, the following dialog box appears. If the View
Log button on the dialog box is enabled, messages are available concerning the
operation. These messages may include errors, warnings, or informational messages.
Click the View Log button to see these messages.

Retrieve a data sheet

Once data sheets are updated by the authoring tools, they can be retrieved back into
To retrieve instrument data sheets, you must first register SmartPlant Foundation to the plant
from which you will be retrieving.
1. Register SmartPlant Foundation. Refer to Register SmartPlant Foundation (on page 238)
for details about registering SmartPlant Foundation. SmartPlant Foundation only requires
registration once for each authoring application, such as line lists, instrumentation,
mechanical, and so on.
To register SmartPlant Foundation to retrieve instrumentation data sheets, click SmartPlant
> Process > IPDs > Register, and then follow steps 2-4 described in Register SmartPlant
Foundation (on page 238) .
2. Click SmartPlant > <Authoring Application Type> > Retrieve.
 To retrieve instrument process data sheets, click SmartPlant > Process > IPDs >
Retrieve.
 To retrieve instrumentation data sheets, click SmartPlant > Instrumentation >
Retrieve.
3. In the Document type box, specify the type of document to be retrieved.
4. In the Show section, select Documents to be retrieved only to include documents that
have been retrieved previously and have been published again since the last retrieval.

Select New documents only to retrieve documents that have not been retrieved yet.
Select All documents to include all revisions and types of documents.
5. In the Documents to retrieve list, select the option beside each document you want to
retrieve. To help identify the documents, review the details in the Type, Revision, Version,
Last Retrieved, and Source columns.
To quickly select the entire list, click Select All. To quickly cancel the selections, click
Clear All.
6. For each document you selected, use the Retrieve Option column to specify whether you
want to retrieve the document with the latest data or retrieve it as published.
By default, the retrieve process copies the XML file as it was published. Select the
Latest Data option to compare the information in the database with the published XML file
and update the objects that were originally published.
7. Click OK to retrieve the specified documents.
 Select the Batch retrieve option if you want the retrieve process to run in batch mode. If
you select this option, an e-mail message will alert you when the process is complete.
Otherwise, the retrieval process begins when you click OK.
 The Deleted and Unclaimed Objects document is retrieved automatically every time you
retrieve if there is a newer version of the document available since the last retrieval. The
document is not included in the list, but it is retrieved automatically, when necessary, to
ensure that the applicable information is updated.

 When the retrieval process is complete, the following dialog box appears. If the View Log
button on the dialog box is enabled, messages are available concerning the operation.
These messages may include errors, warnings, or informational messages. Click View Log
to see these messages.
 In the delivered SmartPlant Foundation configuration, the retrieve process only brings in the
design basis document. It does not load the data.
Partially mapped data sheets

Partially mapped data sheets, like standard data sheets, allow you to view information in the
SmartPlant Foundation database in the format you define using an Excel spreadsheet. Like
other data sheets, the template allows you to edit existing information or add new information for
the object displayed in the data sheet.
The primary difference between a standard data sheet and a partially mapped data sheet is that
partially mapped data sheets allow you to save information in the Excel template in cells that are
not mapped directly to the database. When using standard data sheets, the Excel template is
displayed to the user to format the displayed data and allow data entry. However, once you are
done viewing the object displayed in the data sheet, and the data is communicated back to the
database, the copy of the template you were using is discarded. To view that object in a data
sheet again, you must regenerate the data sheet for that object.
When you generate and save a partially mapped data sheet for an object, the system creates an
incremental copy of the data sheet template, attaches it to the object, and saves it in the
database. Each time you run the Generate Dev Datasheet (Online or Offline) command for
that object, the software opens the attached, saved copy of the data sheet for editing, instead of
generating another copy of the template from the database.
Update the data sheet template for partially mapped data

sheets
When your data sheet definition is configured to use partially mapped data sheet functionality,
an incremental copy of the template is saved for an object the first time a data sheet is
generated for that object. As a result, if changes are made to the associated data sheet template
after the copy is created, they are not propagated to the existing copies. In other words, you will
not see changes in the data sheet for the object if they are made to the template after the first
data sheet generation.
To incorporate the new templates changes, you need to save your unmapped data out of the
data sheet attached to the object, regenerate a new data sheet using the new templates, and
then merge the unmapped data into the new data sheet.
If you are using a version prior to SmartPlant Foundation 2009 Service Pack 1, you must
upgrade in order to set the Support partially mapped data sheet option for both data sheets
and data lists. After upgrading, find the SPFDatasheetDefinition or SPFDatalistDefinition class
definition, and click Generate Form on the shortcut menu. Once the form has been

regenerated, use the shortcut menu to find the data sheet definition that you want to use for
partial mapping and click Update on the shortcut menu. The Support partially mapped data
sheet option will be available on the form.
1. Query for the tag that has an existing partially mapped data sheet and uses the updated
template.
2. Right-click the tag, and click Show Saved Datasheet File.
If you do not see Show Saved Datasheet File on the shortcut menu, you may need to
refresh the menu (right-click the tag and click Refresh). The incremental data sheet
template for the tag appears.
3. Right-click on the saved data sheet, and click Save Target As to save a copy of the file to a
local directory on your computer. This version of the data sheet template file should contain
the original unmapped data.
4. In the Desktop Client, delete the data sheet template file associated with the tag.
5. Right-click the tag, and click Generate IPD Data sheet to create a data sheet using the
updated template. The data sheet should now use the new template (that does not contain
the original unmapped data), and all unmapped data and graphics previously entered are
missing.
6. Copy the unmapped data from the local copy of the saved data sheet and paste it into the
data sheet template generated by SmartPlant Foundation.
7. Save the data sheet template.
Document-Managed Data Sheets

When using data sheets in the standard mode, the software provides the user with a disposable
copy of the assigned Excel template to use for viewing, editing, or adding data for the object
managed by the data sheet. However, once the user is finished viewing the object displayed in
the data sheet, and the data is communicated back to the database, the copy of the template
being used is discarded.
In this mode, the data sheet is a temporary view of the data in the database for a specific object.
Changed data is stored in the database, but there is no revision control on the actual object in
the authoring environment. If the data sheet is published, the published document that contains
the data about the object is controlled through revisioning. However, that revisioning is managed
in the data warehouse and has no corresponding document in the authoring environment.
In order to provide similar revision control in the authoring environment, you must create a data
sheet document to represent the data in the database before it is published. The Create
Document for IPD command creates a document object attached to the instrument, and using
the snapshot feature, you can create electronic files (Excel and XML) that contain the data for
the instrument at that point in time. In the future, you can create additional versions or revisions
of the document with updated data.
Documents with snapshots can be published using the same workflow process as when
publishing standard IPDs.

 Create a data sheet document (on page 257)
 Create a snapshot of a data sheet document (on page 257)
 Find data sheet documents (on page 258)
 Query for data sheet documents (on page 259)
 Compare data sheet snapshots (on page 259)

 Publish a data sheet snapshot (on page 260)
Create a data sheet document

In order to manage different versions of the data in a data sheet, you must create a document
and associate it with the object managed by the data sheet. SmartPlant Foundation manages a
special kind of document, a data sheet document, for that purpose.
In order to create a data sheet document, the IPD portion of SmartPlant Foundation must
be registered for integration for the active plant. For more information, see Register SmartPlant
Foundation (on page 238).
1. Find the instrument for which you want to create a document to manage versions of the data
sheet.
2. Right-click on the tag, and click Create Document for IPD.
4. Click Next.
information.
 The name of the document is generated by the software and based on the name of the
tag. You cannot provide a name for the document.
 The document is automatically related to the tag named in the Parent Instrument field.
6. Click Finish.
The software creates the document named after the tag. For example, for an instrument with the
name CX-00507, the new document is named CX-00507-Datasheet Document.
While the document is associated with the tag, it initially does not store any data about
the tag. To associate tag data with the document for version control, you must create a snapshot
of the data sheet data. For more information, see Create a snapshot of a data sheet document
(on page 257).
Create a snapshot of a data sheet document


1. In the Desktop Client, find the document version that you want to snapshot.
2. Right-click the version and click Create Snapshot.
3. In the New Items window, right-click the version and select Show All Files to see the XML
and XLS files created as part of the snapshot.
 Once the snapshot is created, you can share the Excel file with other people or publish the
snapshot to the data warehouse environment; the snapshot contains the data as it existed in
the database when the snapshot was created.
 The snapshot remains attached to the document version so that you can see the data the
document contained at the time the snapshot was created.
Find data sheet documents

When you search for data sheet documents, SmartPlant Foundation displays search results for
data sheet documents that were created from Process Instruments and stored in the vault.
1. Click Find > Data sheet Documents.
2. On the Find dialog box, type the name of the data sheet document for which you want to
search.
3. Click OK to find objects with the criteria you specified.
You can enter the entire name, part of the name, a wildcard (%, *, or ?), or a combination
of the name and wildcard (for example, n%).
 If you want to create a more detailed search, use the options on the Query > Data sheet
Documents menu and use the form that appears to provide specific details for the search.
 If you want to find published data sheets, use the options on the Find > Published
Documents menu. For more information, see Find an object (on page 99).

Query for data sheet documents

When you query for data sheet documents, SmartPlant Foundation displays search results for
data sheet documents that were created from Process Instruments and stored in the vault.
1. In the Desktop Client, click Query > Data sheet Documents.
2. Under Document category, select the document type for which you want to query.
3. Type in the query information to find a specific data sheet document. Then, click Apply or
Finish to return all data sheet documents that match all the provided criteria.
If you want to query for published data sheets, use the options on the Query >
Published Documents menu. For more information, see Query for a published document (on
page 448).
Compare data sheet snapshots

You can compare two snapshots of data sheet versions in authoring mode, rather than waiting
until the snapshots are published to the data warehouse for comparison.
1. In the Desktop Client, find the data sheet for which you want to compare snapshots.
2. Right-click on the datasheet, and click Revision Relationships > Show all Versions.
You may need to use the Master Relationships > Show all Revisions command
from the shortcut menu if you want to compare versions from different revisions.
3. Hold down the CTRL key, and click two versions or revisions that have snapshots
associated with them.
4. Right-click the versions or revisions, and click Compare on the shortcut menu.
The software displays differences between the two data sheet revisions or versions in the
standard Document Version Comparison or Document Revision Comparison dialog
boxes.

Publish a data sheet snapshot

1. In the Desktop Client, find the data sheet document for which you want to publish a
snapshot.
2. Right-click the version, and click Publish.
The Publish command is only available on the shortcut menu if a snapshot file has
been generated and is attached to the document version. See Create a snapshot of a data
sheet document (on page 257) for more information.
(on page 440).
Documents.
Foundation.

Enhanced Mechanical Equipment Data Sheets

The Enhanced Mechanical Equipment Data Sheets are documents that contain various
enhancements to the original API Data Sheets presented in the API Standard publications.
Enhanced for Excel Data Sheets are defined and controlled by an underlying schema definition.
For more information about the schema, please refer to SmartPlant Schema Editor User's
Guide.
In the SmartPlant schema, a view definition (also called a ViewDef) is a way of filtering lists of
properties that will be available for mapping into the data sheet to take in or display property
information to the user.
A data sheet definition (SPFDatasheetDefinition class) is based on one or more view definitions
(ViewDef classes) and has a predefined template that maps data from the view definitions onto
the named fields of the Excel worksheet in the format of ViewDefName.PropertyDefName. VBA
Macros are embedded in the Excel file to provide the functionality that helps users edit the data
in a managed way. These macros also allow users to save the data into an XML file in the file
system for external data exchange.

 Learn more about mechanical equipment data sheet options and functionality (on page 262)
 Purchase and install enhanced mechanical equipment data sheets for SmartPlant
Foundation (on page 262)
 Publish data sheets (on page 263)

 Register SmartPlant Foundation (EQD) (on page 263)

 Edit Microsoft Excel security settings for data sheets and data lists (on page 241)
 Map file for equipment data sheets (on page 264)
Learn more about mechanical equipment data sheet options

and functionality
After you incorporate the data sheet schema into your site, you can use data sheets to enter and
view equipment data, as well as publish and retrieve equipment data. The following new
functionality and commands have been installed on the system:
 Equipment tags, assets, and models, including the 16 equipment tags with data sheets
configured for them. See Data Sheets (on page 242) for the list of delivered data sheets.
 New SmartPlant menu options (click SmartPlant > Mechanical)
 Publish
 Retrieve
 Register
 Compare Latest Retrieved Data for EQD
 Mechanical Design Basis Items
 New data sheet commands available when you right-click a tag
 Generate Mechanical Data Sheet (Offline)
 Generate Mechanical Data Sheet
 Publish Datasheet (EQD)
The user name must be assigned the Mechanical Engineer role to access these features.
For information about how to configure roles, see the How to Configure the Security Model from
Intergraph Corporation guide.
Purchase and install enhanced mechanical equipment data

sheets for SmartPlant Foundation
The following Enhanced Mechanical Equipment Data Sheets for SmartPlant Foundation are
available for separate purchase from Intergraph. Refer to the SmartPlant Foundation Installation
and Setup Guide for details about installing the Enhanced Mechanical Equipment Data Sheets
for SmartPlant Foundation.
 API 560 - Fired Heater
 API 560 - Fan
 API 560 - Soot Blower
 API 560 - Air Preheater
 API 610 - Centrifugal Pumps
 API 611 - General Purpose Steam Turbine
 API 616 - Combustion Gas Turbine
 API 617 - Centrifugal Compressor
 API 618 - Reciprocating Compressor
 API 619 - Rotary Type Positive Displacement Compressor

 API 660 - Shell And Tube Heat Exchanger

 API 672 - PIG Centrifugal Air Compressor
 API 673 - Centrifugal Fan
 API 673 - Electric Motor
 API 674 - Reciprocating Pump
 API 675 - Controlled Volume Pump
 API 676 - Rotary Pump
 API 685 - SL Centrifugal Pump
In addition to purchasing Intergraph licensing for Enhanced Mechanical Equipment Data Sheets,
customers must acquire a separate license from the American Petroleum Institute (API).
Intergraph periodically updates API with the names of customers who have purchased API data
sheets.
By default, Intergraph provides basic mapping for Enhanced Mechanical Equipment Data
Sheets for integration. Customers can extend this mapping as necessary.
These Enhanced Mechanical Equipment Data Sheets are integrated with
SmartPlant Foundation and are distinct from the offline Enhanced Mechanical Equipment Data
Sheets for Excel, which are available for separate purchase. The Enhanced Mechanical
Equipment Data Sheets for Excel are not integrated with SmartPlant Foundation. If you receive
an Enhanced Mechanical Equipment Data Sheet for Excel from a supplier, you are responsible
for mapping and loading the data into SmartPlant Foundation. Intergraph cannot guarantee that
the content and its structure have not been edited by the supplier.
Publish data sheets

Intergraph SmartPlant Foundation can be configured to publish equipment data sheets. Other
Intergraph SmartPlant applications can be configured to retrieve equipment data sheets.
Register SmartPlant Foundation (EQD)

You must register SmartPlant Foundation as an authoring tool before you can publish data
sheets. The Enhanced Mechanical Equipment Data Sheets are supported in standalone
authoring only, so the publish must be to a separate data warehouse site.
1. In the Desktop Client, click SmartPlant > Mechanical > Register.
2. 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>.
3. In the Plant name list, select the appropriate plant. Be sure that you know the SmartPlant
Foundation plant to which you need to register.
4. Click Finish. If the registration completes successfully, the Register With SmartPlant
Software message box appears.

Map file for equipment data sheets

A map file for publishing the enhanced mechanical equipment data sheets is delivered when you
install the data sheets in that module. The delivered EQD map file can be used as a starting
point for publishing your data sheets, or you may customize it to reflect what your data sheets
should publish.
To edit the map file for the enhanced mechanical equipment data sheets, use the following
procedure:
1. In the Desktop Client, click Find > Adapter Documents.
2. Type EQD Map Schema, and click OK.
3. Use Shortcut menu to the EQD Map Schema document, and click Edit > Check Out.
4. Edit the file as necessary.
5. Right-click the checked out document in the Desktop Client, and click Edit > Check In.
Data Lists
In SmartPlant Foundation, you can generate data lists to view and edit object data and to create
new objects. Data lists are edited directly in Microsoft Excel, and changes can then be saved
within SmartPlant Foundation. You can also save the data list offline for editing by users who do
not have access to SmartPlant Foundation.
Access to project data depends on your role assignment and user permissions within a
project.
SmartPlant Foundation Desktop Client provides a Datalists menu from which you can choose to
generate online or offline data lists for a particular instrument object class in the active scope.
The data list displays all of the objects of that class and displays the common properties.
The example data list below shows a data list generated for temperature instruments.

 Learn about data list templates (on page 265)
 Generate and edit an instrument data list online (on page 265)
 Generate and edit an instrument data list offline (on page 267)

 Generate a data list from a related object (on page 268)

 Create and manage objects in a data list (on page 270)
Learn about data list templates

Administrators can create and edit data list definitions in the SmartPlant Foundation Desktop
Client. For more information about defining data lists and about configuring the data sheet
model, refer to the How to Configure the Data Sheet Model guide.
The following instrument process data list definitions are delivered with SmartPlant Foundation.
Each is related to a delivered data list template for creating, viewing, and editing information.
 Document List
 Instrument List (Analyzer Instrument)
 Instrument List (Control Valve)
 Instrument List (Existing)
 Instrument List (Flow Instruments)
 Instrument List (Level Instruments)
 Instrument List (New)
 Instrument List (Pressure Instruments)
 Instrument List (Relief Devices)
 Instrument List (Temperature Instruments)
 Instrument List (General Instruments)
Generate and edit an instrument data list online

1. From the SmartPlant Foundation Desktop Client Datalists menu, select Instrument Lists
Online, and then select the type of instrument list that you want to generate.
241).
3. Complete the information in the data list as necessary.
choose.
 Option buttons are supported in the spreadsheet. The data list can be configured to use
a group of option buttons for enumerated properties rather than a list.
 For options that require text, click the box, type the appropriate text, and press ENTER.
 For options containing a list, click the box, and then select the correct list entry.
The task pane allows you to perform editing operations and to create new objects in a data
list.

Some functionality, such as saving changes into SmartPlant Foundation, depends upon
whether you are editing online or offline.
made in this edit session. Changes are indicated by a red triangle in the upper-right
corner of a cell. Rest the cursor over the triangle to view changes.
position.
4. To create new objects from within the data list, refer to Create and manage objects in a data
list (on page 270).
5. After you complete the data list, save the changes to the SmartPlant Foundation database
by clicking Save on the task pane.

Until you click Save, no changes are made to the data in SmartPlant Foundation.
6. To close the data list, click File > Exit on the Excel menu bar.

Generate and edit an instrument data list offline

1. In SmartPlant Foundation Desktop Client, click Datalists > Instrument Lists Offline, and
then select the type of instrument list that you want to generate.
2. Select a download directory for the offline data list.
The offline data list can now be accessed, reviewed, and edited by other users,
without SmartPlant Foundation. The file may be moved or distributed as necessary.
3. Browse to the new data list, and open it in Excel.
241).
choose.

position.
6. To create new objects from within the data list, refer to Create and manage objects in a data
list (on page 270).
7. When you have completed the data sheet changes, save the spreadsheet using File > Save
in Excel.
8. Load the changes back into the SmartPlant Foundation using the Loader command in the
Desktop Client. Refer to Load offline data sheets and data lists (on page 250) for more
information.
Generate a data list from a related object

You can create a data list that displays all of the instrument or equipment objects related to an
object from a unit, system, folder, or other related object. Types of data lists delivered with
SmartPlant Foundation include Document List, Instrument List (Existing), and Instrument List
(New), but other data list definitions can be configured.
1. Right-click the related object, and click Generate Datalist > <object>.
241).

choose.
position.
 To create new objects from within the data list, refer to Create and manage objects in a
data list (on page 270).
4. After you complete the data list, save the changes to the SmartPlant Foundation database
by clicking Save on the task pane.

Until you click Save, no changes are made to the data in SmartPlant Foundation.

5. To close the data list, click File > Exit on the Excel menu bar.
 You must be in a SmartPlant Foundation authoring environment to create a data list from a
unit or other related object.
 Your system administrator must configure your unit or other related object to support data
list generation. To do this in the model delivered with SmartPlant Foundation, your system
administrator must be logged on as superuser.
Create and manage objects in a data list

You can use the data list task pane to create instrument objects and to create and delete
relationships between instrument objects in SmartPlant Foundation.
The available functionality depends upon whether you are working in an online or offline
data list. For example, if you are working in an offline data list, you can create new objects, but
you cannot save them directly into SmartPlant Foundation or relate them to other objects. These
changes need to be made as a separate operation using the Loader. Refer to Load offline data
sheets and data lists (on page 250) for information about loading offline data into SmartPlant
Foundation.
Create a new object

1. Select the first cell in the next available row, and click New on the task pane.
2. Complete the row with the required information for the new object.
If the data list has a primary object, then new objects are automatically related to the
primary object. If the data list does not have a primary object, new objects are created
without any relationships.
Delete an object and relationship from the data list

1. Select the object, and click Delete on the task pane.
The Delete command is available only if:

 You have selected a cell representing a secondary object on the sheet.
 The secondary object is related to the primary object through a relationship that has
permissions set to allow deletion.

2. In the confirmation dialog box, click Yes to delete the relationship and remove the object
from the data list.
 The object is removed from the data list display, and its relationship to the primary
object is deleted. However, the new object is not deleted from the SmartPlant
 You can add the object back to the data list and restore the relationship by using the
Relate option as described below.
Relate an object to another object

The Relate command allows you to search for similar objects, add them to the data list, and
relate them to the parent object.
The Relate command is available only if:

 You have selected a cell representing a secondary object on the sheet.
 You have permission to relate objects across this relationship.
Save changes
1. To save new objects and relationships in the database, click Save on the task pane.
The Save command is disabled when you are working in an offline data list. To import the
new object into SmartPlant Foundation, you must save the spreadsheet and then use the
Loader in Desktop Client to load the data list. Refer to Load offline data sheets and data lists
(see "Load offline datasheets and data lists" on page 491) for more information.


SECTION 11
Line Lists
A "line list" is a key coordination document that includes a short record of important information
about those lines, or pipelines. Piping engineers, project engineers, and managers typically
manage key information associated with piping systems using a report or document known as a
line list.
The SmartPlant Foundation line lists functionality can be used in a number of ways within
SmartPlant Enterprise, both stand-alone and integrated. When integrated, the line list
functionality retrieves the piping data (typically from SmartPlant P&ID), including the connected
equipment and instrumentation, and generates the line list structure that reflects the rollup of the
more granular line list segments (pipe runs). In integrated mode, a document containing updated
line information can be issued and published back to the data warehouse for use in the
enterprise.
When working in stand-alone mode, you can create line list records without the more granular
line list segments. The line list can be managed as a document showing the line list records.
This document can be issued and published back to the data warehouse for use in the
enterprise as a project deliverable.
Components of the Line List application

The Line List application is composed of a set of editable design objects and a set of
non-editable design basis objects. The types of editable objects that constitute the Line List
application's design are:
 Line lists
 Line list records
 Line list documents
The corresponding set of read-only objects that form the Line List application's design basis is
listed below:
 Line segments
 Equipment and nozzles
 In-line and off-line instruments
 Off-page connectors

 Line segment (on page 274)
 Line list record (on page 274)
 Line list (on page 274)
 Line list document (on page 274)
 List list icons (on page 275)

Line Lists
Line segment
A line segment, referred to as "Pipe Run" in the software, is a section of the pipeline that has a
"from" and "to relationship to other objects in the design basis. These objects include nozzles,
off-page connectors, other line segments, and so on. Each line segment also has relationships
to the in-line instruments within that line segment and to the off-line instruments connected to
that line segment. A line segment is equivalent to a PIDPipingConnector in SmartPlant P&ID.
Since line segments are part of the design basis for the Line List application, they are not
editable. Line segments can only be created, deleted or modified by retrieval from another
application, typically a P&ID application.
Although line segments are not editable, the relationship between a line segment and the
corresponding line list record is created and deleted from within the Line List application.
Line list record

A line list record is one of the rows in the line list document. A line list record is created by rolling
up line segments, such as By Fluid Code and Pipe Sequence Number. When created from the
design basis, a line list record is a roll up of one or more line segments based on the roll-up
criteria.
Line list
A line list is a collection of line list records that are linked together for editing and reporting
purposes.
Line list document

A line list document is a viewable, issuable, publishable, lifecycle-controlled document that
contains information about each of the line list records in the line list. When a line list document
is created for a line list, a viewable snapshot of the line list data is generated along with the
publishable XML representation of the data in the list.
By default, line list documents are configured for an integrated environment. Registering the
authoring domain is required before you can create a line list document. If you want to create
these documents in a stand-alone authoring system, the
ISPFAuthPublishableDocumentRevision and ISPFAuthPublishableDocVersion interfaces need
to be removed from the class definitions for line lists. To remove these interfaces, load
SCHEMA_RemovePublishableDocRealizeRels.xml in the <Product
Directory>\Models\AuthExample folder.

Line Lists
List list icons

The following icons represent components of the line list.
Icon Line list component

Line list
Line list record
Line segment
Equipment
Nozzle
Offline instrument
Inline instrument
Integrated line lists

You can use line lists to share data in an integrated environment. The following graphic displays
the default integration for line lists in SmartPlant Foundation. For more information, see the data
exchange diagrams and mapping spreadsheets accessible from the Help > Printable Guides
command in the Desktop Client.
The topics that follow describe how line lists are integrated with SmartPlant P&ID and
SmartPlant Materials out-of-the-box.

 Creating line lists from SmartPlant P&ID data (on page 276)
 Using SmartPlant Materials to modify data (on page 277)

Line Lists
Creating line lists from SmartPlant P&ID data

Retrieve Line Segments from SmartPlant P&ID
SmartPlant Foundation retrieves SmartPlant P&ID data from the data warehouse and gets line
segments, end objects for the line segments (such as equipment, nozzles, and off-page
connectors), and connected instrumentation. This data forms the read-only design basis for the
Line List application.
Roll Up Segment Properties to Records

After the line segments are retrieved from SmartPlant P&ID, users can roll up the line segments
to form line list records.
To roll up segments, right-click unrelated line segments, and click the Rollup command. The
software groups these line segments together using a set of configured properties and relates
them to the matching line list records. If no matching line list record is found, a new line list
record is created and populated with the property values from the line segment for the set of
configured properties. The line list record is named using a subset of these properties.
Consolidating Properties
The roll-up criteria defines the set of properties that determine how to relate line segments to
line list records. Following a rollup command, the values for these properties should be the
same between the line list record and the related line segments. This leaves two other types of
properties within the line list record: single-valued properties that are not used for rollup, and
multi-valued properties that can be used for consolidation. The "from" and "to" connectivity
properties and the document (P&ID) property are in the multi-valued property category and are
typically defined in a consolidation process.
Updating or creating a line list record starts the consolidation process. In the delivered system,
the three properties previously described are configured for consolidation.
After a record is created, the rollup of new segments to that record only reconsolidate all the
segment data if the Delay consolidate option is selected. By default, the Delay consolidate
option is not selected.
 If the Delay consolidate option is not selected, line list records are created with delay
consolidation in order to prevent rollup of additional segments, potentially overwriting
manually-entered data on the record.
 If the user clears the Delay consolidate option, the rollup of new segments reconsolidates
all the properties on the line list record based on all of the related line segments.
Creating a Line List

Users can relate line list records to a line list by dragging and dropping records onto the line list.
Line list documents are created from the line list.

Line Lists
Using SmartPlant Materials to modify data

SmartPlant Foundation can publish the line list to the data warehouse through the line list
document and a snapshot of the records contained in the line list. By default, SmartPlant
Foundation publishes the following:
 The Line List Document.
 The Line List Records contained in the line list.
 Dynamic relationships of type NonDrawingItemCollection that are generated between the
records and the document.
 On a republish, if a line list record is found to be terminated, a delete instruction for the
record is published in the Tombstone file.
 On a republish, if a line list record has been flagged to be excluded from the line list or if a
line list record is found to be no longer related to the line list, a delete instruction for the
relationship between the record and the document is generated and published.
In SmartPlant Materials, you can import line list data or manually create the line list data. The
lines are related to the functional units based on the plant breakdown structure (PBS) that is
retrieved by SmartPlant Materials. SmartPlant Materials updates data and publishes the line list
document to SmartPlant Foundation.
For line lists, SmartPlant Materials is primarily used for:
 Checking that the specification on each line is the same in the Bill of Materials (BOM) as in
the line list.
 Setting the wall thickness.
 Checking the nominal sizes.
 In SmartPlant Materials, the properties Nominal Diameter and Wall Thickness are mapped
by default. You must create and map custom properties for all other data.
 SmartPlant Materials can be customized to perform wall thickness calculations.
Using line lists

The following topics describe how to create, manage, and use line lists in the SmartPlant
Foundation Desktop Client.

 Roll up and consolidate line lists (on page 278)
 Retrieve data into the line list application (on page 278)
 Roll up a line segment (on page 280)
 Create line lists interactively (on page 281)
 Modify line list records (on page 282)
 Create a line list record document (on page 282)
 Create a line list document snapshot (on page 283)
 Publish a line list document snapshot to the data warehouse (on page 283)

Line Lists
Roll up and consolidate line lists

Rollup is the grouping together of a set of line segments into a single line list record based on a
set of common property values as configured on the ENS definition of the line list options object.
Use the Rollup command to group the line segments into line list records, or you can manually
associate line segments to line list records using drag and drop.
Consolidation is the process of combining properties from individual line segments to form
comma-separated string values for properties of the line list record. The consolidation process
uses the set of properties that are configured for consolidation between line segments and line
list records.
Consolidation is compatible with records that have the Delay consolidation? option selected. If
you delay consolidation for a record using the Delay consolidation? option, the rollup is not
affected, but the segment is still related to the line list record. However, any changes to the
properties of the segment that have been configured for consolidation are not written to the line
list record.
In the delivered system, three properties are configured for consolidation: P&ID Name, From,
and To. See How to Configure Line Lists for more information about configuring rollup and
consolidation.
Retrieve data into the line list application

You can retrieve data from SmartPlant P&ID and SmartPlant Materials into the SmartPlant
Foundation line list application. When you retrieve from SmartPlant P&ID, line segments are
automatically created. When you retrieve from SmartPlant Materials, properties that have been
mapped are updated in SmartPlant Foundation; retrieving additional properties allows you to
see if the design basis has changes that require you to modify or update the data. Topology
information is also retrieved from SmartPlant P&ID.
 Unlike other retrievals in SmartPlant Foundation, retrieval of data from SmartPlant P&ID into
the line list application bypasses the compare and automatically loads the data into the
authoring database. This is configurable through the line list application adapter document.
For more information, see How to Configure the Line List Model.
 When you retrieve from SmartPlant Materials, SmartPlant Foundation retrieves all properties
that are published by SmartPlant Materials and uses the ToDo List dialog box to display the
differences between what is in the database and what was retrieved. This will show any
differences that were made after SmartPlant Foundation published the line list record data
so that you can decide if the data published by SmartPlant Materials is valid or if it must be
recalculated based on the new data instead of being loaded into the data warehouse.
1. To register the SmartPlant Foundation line list application with the data warehouse, click
SmartPlant > Process > LLA > Register. For more information, see Register SmartPlant
Foundation (on page 238) .
SmartPlant Foundation only requires registration once for each authoring application,
such as line lists, instrumentation, mechanical, and so on.

Line Lists
Clear All.

Line Lists
 If a line list record already exists that matches properties (using the ENS definition) on the
line segments being rolled up, the software adds those segments to the appropriate line list
record when you use the Rollup command.
 ENS is also used to roll up line segments into a line list record based on the common
properties of the segments.
Roll up a line segment

You can group together the properties of a line segment or multiple line segments into a line list
record. This command is only available on line segments that are not already associated with a
line list record.
After line segments are retrieved from SmartPlant P&ID, you can use the Rollup command to
create a line list record. Rollup is the grouping together of a set of line segments into a single
line list record based on a set of common property values as configured on the ENS definition of
the line list options object. You can only roll up segments that are not already associated with a
line list record.
1. Find the line segment or segments you want to roll up. To find a line segment, click Query >
Line List > Line Segments.
Click the Line list record column in the list view to group line segments by the line list
record they belong to. Line segments that have not been rolled up appear blank in this
column.
2. Right-click the line segment or line segments and click Rollup on the shortcut menu.
If the segment rollup properties match an existing line list record, the segment or segments
are related to the existing record. Otherwise, a new line list record is created.
If the software finds multiple existing line list records that match the rollup
properties for a line segment, the rollup process stops.
To fix this problem and continue rolling up the line segments, terminate the duplicate line list
record and use the Rollup command to roll up the segments again. If this problem persists,
contact your administrator to ensure that there is only one target line list record for this
segment's rollup ENS definition. See Configuring Rollup of Segments in How to Configure
Line Lists for more information about the rollup ENS definition.
 Any segment properties configured for consolidation are consolidated into the line list
record.

Line Lists
 When you roll up line segments to create a line list record, you must manually relate the
record to the line list or other top-level item you are using to create publishable documents.
Drag and drop the line list record onto the line list to create a relationship.
Create line lists interactively

A line list record is one of the rows in the line list document. A line list record is created by rolling
up line segments, such as By Fluid Code and Pipe Sequence Number. After you create a line
list object in SmartPlant Foundation (or retrieve one from SmartPlant P&ID), you can add line list
records to the line list in the Line List Edit - Records window.
1. Find the line list that you want to add records to. To find the line list, click Find > Line List >
Line Lists.
2. Right-click the line list, and click Line List Edit – Records on the shortcut menu.
3. To add a new line list record, click the blank line at the bottom of the table, and type the
name of the line list record.
Create a new object in the List Edit window (on page 68)
When you create line list records, names for line list records can be automatically
created using the Engineering Numbering System (ENS). If your administrator has
configured ENS to use properties to name the line list record, the name is created
automatically in the appropriate format when the properties are defined. For more
information, see Configuring ENS Definitions for Line List Naming and Rollup in How to
Configure the Line List Model.
4. Define other settings for the line list record in the Line List Edit - Records window.
Edit the properties of an object in the List Edit window (on page 66)
Copy and paste in the List Edit window (on page 69)
 When you create new line list records, you can enter values for properties that are
designated as read-only. Read-only properties cannot be edited after they have been
saved to the database.
 Select the option in the Delay consolidation? cell for a line list record to exclude the
record from any consolidation for the line list. The record is not consolidated until you
clear this option.
Using this flag, you can manually enter properties on the line list record and prevent
consolidation from the segments that are retrieved from a P&ID and related to the line
list record. When you have checked that the data on the segments matches the data
you have assigned to the line list record, turn off the Delay consolidation? property
option. The next time you roll up the line segments, the line list record properties that
are configured for consolidation are overwritten by the properties rolled up from the
attached line segments.
 Select the option in the Exclude from line list cell to exclude the record from the
publishable line list document snapshot. You can also exclude retrieved records from
the line list by selecting this option.
5. Repeat steps 3-4 to add new line list records to the line list.

Line Lists
Modify line list records

Allows you to modify all records for the line list, including those retrieved from P&IDs. You can
also create and delete line list records.
1. Find the line list for which you want to modify records. To find the line list, click Find > Line
List > Line Lists.
2. Right-click the line list, and click Line List Edit – Records on the shortcut menu.
3. Modify line list records in the table.
 The properties that you can modify depend on your user access, the column set, and
the command you used to open the Line List Edit – Records window.
 The delivered line list record properties displayed in the List Edit window have several
default settings. A default, imperial unit of measure defines each property. In addition,
each column has a default width to accommodate the expected property values. As a
result, many properties have abbreviated display names.
To change these default settings, your administrator must change the column items in
the column set used in the List Edit window. See Manage Column Items for Edit in How
to Configure the GUI Model for more information.
Create a line list record document

Documents can be created to manage line list records. The line list record document contains a
grouping of the line list records and can be used to edit a group of line list records.
1. Find the line list for which you want to create a line list record document. To find the line list,
click Find > Line List > Line Lists.
2. Right-click the line list, and click Create Line List Record Document.
 After the document is created, you can create a snapshot. Snapshots provide a view of the
document data at the time the snapshot was created. For more information about creating a
snapshot of a list document, see Create a line list document snapshot (on page 283).
 You can edit the list document in the List Edit window. For more information, see List Edit
window (on page 45) and .Edit a list associated with a list document (on page 227).
 After a line list record document has been signed off, you can revise it. See Revise a
document (on page 196) for more information about revising documents.

Line Lists
Create a line list document snapshot

1. Find the line list for which you want to create a snapshot. To find the line list, click Find >
Creating a snapshot allows you to control what information you publish to the data
warehouse when you publish a particular revision of the line list record snapshot.
2. Right-click the line list, and click Show Line List Record Document.
If the line list record document does not already exist, you can create one by
right-clicking the line list and clicking Create Line List Record Document.
3. Right-click the line list record document, and click Create Snapshot.
 When you create a snapshot of a line list document from the line list, the software uses the
column widths defined by your administrator in the SPFLLASnapshotTemplate Excel
template, not the size of the columns in the List Edit window for the line list record. For
more information, see How to Configure Document Management.
 When you create a snapshot, the software creates a new version of the line list document
snapshot and attaches it to the line list document.
Publish a line list document snapshot to the data warehouse

1. Create a line list document for the line list that you want to publish, if you have not created
one already.
2. Find the line list document and create a snapshot of it, if you have not already created a
snapshot.
3. Find the line list for which you want to publish a snapshot. To find the line list, click Find >
4. Right-click the line list and click Show Line List Record Document to find the line list
record for the line list.
5. Right-click the line list record document, and click Publish on the shortcut menu.
The software publishes the XML data file generated by the snapshot and the Excel
view file that are attached to the line list record document.
(on page 440).

Line Lists
Documents.
Foundation.

SECTION 12
Reports
The SmartPlant Foundation reporting functionality allows you to create and run custom reports
to retrieve information from the database. SmartPlant Foundation is delivered with a number of
basic, standard reports, which can be modified to include additional information. You can also
create reports of your own.
The following types of reporting are available in SmartPlant Foundation.
Ad-hoc Reports - Provide a fast way to view plant information. The format, or layout, of a report
is fully configurable. You can save these layout definitions as custom reports that you can reuse.
For more information, see Ad-hoc reports (on page 285).
Graphic Reports - Provide a quick way to view only those items that you want to see in a
drawing. For more information, see Graphic reports (on page 298).
Ad-hoc reports
Ad-hoc reports provide a fast way to view plant information. The format, or layout, of a report is
fully configurable. You can save these layout definitions as custom reports that you can reuse.
As part of creating and running a report, you select an existing report template. The items
displayed are based on the report template that you selected. The report template, which is
defined by an administrator in SmartPlant Foundation Desktop Client, includes a view definition
and a Microsoft Excel file. The view definition determines what objects, relationships, and
properties are to be included in the report. The Microsoft Excel file specifies the layout of the
report. For more information about creating report definitions, see the How to Configure Reports
guide.
New Report dialog box

Allows you to select the item type for which you want to generate a report.
Description - Displays the descriptions of the available item types.
Save Report dialog box

Allows you to save your query criteria for the report.
Name - Displays the name of the report that you want to save.
Description - Displays the description of the report that you want to save.
Owner - Displays the user name of the user who created the report.
Edit Report Definition dialog box

Allows you to define the query criteria for a new report.
Report output style - Allows you to specify the report style. You can send the report output to a
list view or to a file in Excel, Word, or HTML format. If you specify Excel as the destination file
type, you can use an existing Excel file as a template to format the report. The Custom Report

Reports
option allows you to send report data to a custom reporting application, if your system
administrator has set up such a configuration.
Related Item - Specifies the category of the property that you want to read from the database
and put into the report.
Caption - Displays the names of the properties that can be selected for your output report. You
can type a new name.
Sort - Allows you to select a sort type of either ascending or descending.
Sort Order - Allows you to sort the order of the properties selected for the report.
You can assign a sort order value to a property by right-clicking or left-clicking the
Sort Order column for that property:
 By right-clicking the column, the greatest value incremented by one is assigned to the
property.
 By left-clicking the column, the greatest value incremented by one is assigned to the
property; meanwhile a spin box is shown, allowing you to change the value.
Criteria - Allows you to define a value for your query criteria.
Prompt - Allows you to prompt the user for query criteria.
Select All - Allows you to select all of the properties listed.
Clear All - Allows you to clear all of the selected properties.
Display latest values only - For reports run on published data, displays the latest published
values shown in DWShared domain for shared objects.
This option only applies to reports that display published data. The report also highlights
inconsistent property values.
Move Up - Moves the selected row up one position in the report definition.
Move Down - Moves the selected row down one position in the report definition.
Apply - Displays the report using its current format.
Save - Saves the report in its current format.
Criteria Definition dialog box

Allows you to specify the criteria to use to filter the contents of the selected report column.
Clear criteria for this property - Allows any value for the property in the report.
Define criteria for this property - Allows you to specify criteria for the property in the report.
Currently defined criteria for <property name> - Lists the criteria defined for the property.
You can define multiple criteria statements for a single column.
Operator - Allows you to specify search operators to narrow your search. Two sets of operators
(equals and like) are available depending on the property type for which you are defining the
criteria. Operators for strings, doubles, integers, small integers, and select lists are:
equals - Include items with a property that exactly matches what you typed in the Value box.
 not equal to - Include items with a property that does not match what you typed in the
Value box.
 less than - Include items with properties that are less than what you typed in the Value box.
 greater than - Include items with properties that are greater than what you typed in the
Value box.
 less than or equal to - Include items with properties that are equal to or less than what you
typed in the Value box.

Reports
 greater than or equal to - Include items with properties that are equal to or greater than
what you typed in the Value box.
like - Include items with a property that matches what you typed including wildcards in the Value
box.
 Only the equals operator is available if the property is a code-listed item (you select a value
from a list) or if you use the words Null or Blank as the value. The operator automatically
changes to equals when you type Null or Blank.
 If you are defining search criteria for a string property, you can use wildcards to match one
or more characters in the string. You must use the like operator to use wildcards. An
asterisk (*) matches zero or more characters in your search. For example, if you specify pa*,
the software finds pan, park, part, panel, and other words that start with the characters pa.
 An underscore (_) matches a single character. For example, if you specify pi_, the software
finds pid, pit, pip, but not pipe. To search for the underscore or asterisk character in the
database, enclose the underscore or asterisk character in square brackets. For example,
specify 100[*] to find 100* but not 100abc.
 You also can use square brackets to search for a single character in a range of characters
(for example, [a-f] matches to a, b, c, d, e, or f) or in a set of characters (for example,
[abcdef]). For example, if you specify pi[a-p], the software finds pid and pip, but not pit.
 To search for a character not in a range or set, use a caret (^) character (for example, [â-f]
or [âbcdef]). For example, if you specify pi[â-p], the software finds pit, but not pid or pip.
Value - Allows you to type a value for the property upon which you are basing your query
criteria.
Join criterion - Specifies whether to join multiple criteria using AND or OR for this single report
column. You cannot mix AND and OR when defining multiple criteria for a single column.
 Use AND if you want all the criteria to match before including the item in the report. This
option is more restrictive than OR.
 Use OR if you want only a single criterion to match before including the item in the report.
Add Criterion - Adds the specified operator and value to the list of defined criteria.
Update Criterion - Updates a selected criterion when you change the operator, the value, or
both.
Delete All Criteria - Deletes all criteria from the list.
Delete Selected Criterion - Deletes the selected criterion from the list.

 Create a new report (on page 288)
 View an existing report (on page 291)
 Run an existing report (on page 292)
 Define filter criteria for an ad hoc report (on page 292)
 Run a report as a scheduled task (on page 295)
 Terminate a report (on page 296)
 Learn more about reporting output styles (on page 296)

Reports
Create a new report

The File > New > Report command allows you to create a new report.
1. Click File > New > Report.
2. Select a report type from the list, and click OK.
3. Select the check boxes for the properties that you want to include in the report.

Reports
 You can send the report output to a list view, to a file in Excel, Word, and other formats,
or to a custom reporting application if your system administrator has set up such a
configuration.
 If you specify Excel as the destination file type, you can use an existing Excel file as a
template to format the report.
For more information about the report output styles, see Learn more about reporting
output styles (on page 296).
 If you are running this report on a shared object, select Display latest values only to
display only the most recently published values for the shared object. The report
highlights values that are inconsistent with values published from other tools. If you do
not select this option, the report shows all the different published values as a
comma-separ

Reports
4.
Set the sort and search options for each property, as necessary.
 You can set the report to sort properties in ascending or descending order. You can also
set a value for each property by right-clicking or left-clicking the Sort Order column so
that properties are sorted in the order you have defined:
 By right-clicking the column, the greatest value incremented by one is assigned to
the property.
 By left-clicking the column, the greatest value incremented by one is assigned to the
property, meanwhile a spin box is shown, allowing you to change the value.
 You can define search criteria for each property by selecting Criteria. For more
information about setting criteria to filter report results, see Define filter criteria for an ad
hoc report (on page 292).
 You can allow users to specify search criteria for a row each time the report is run by
setting the Prompt option to True. You cannot define a criteria for a report and set the
report to prompt the user for a value. These two features are mutually exclusive.
5. For a quick view of the report, click Apply. You can view the report and return to the dialog
box to make changes.
6. To save the report definition, click Save.
7. Specify details for the saved report and click OK.
8. To run the report and exit the report definition, click OK on the Edit Report Definition
dialog box.
To run the report as a scheduled task, see Run a report as a scheduled task (on
page 295).

Reports
View an existing report

1. Click Query > Reports.
You can also click Find > Reports.
2. Right-click the report you want to view and click Edit Report Definition.
3. Click Apply to view the report.
 The items displayed are based on the report template that you selected. The report
template, which is defined by an administrator in SmartPlant Foundation Desktop Client,
includes a view definition and a Microsoft Excel file. The view definition determines what
objects, relationships, and properties are to be included in the report. The Microsoft Excel
file specifies the layout of the report. For more information about creating report definitions,
see the How to Configure Reports guide.
 If the system administrator modifies the view definition used as the basis for your report, the
changes appear as follows:
 New properties are immediately available for use in the report.
 Modified properties appear as a delete of the old property and a create of the new
property.
 Deleted properties are removed from the report cache. If the property was used in the
report, you receive a message stating which property has been removed.

Reports
Run an existing report

The Run Report command allows you to run an existing report and view the results. This
command is available when you right-click a report.
1. Click Find > Reports.
2. Right-click the report to view.
3. On the shortcut menu, click Run Report.
4. Click Open or Save on the File Download dialog box. Depending on the type of report and
how the report was configured, the File Download dialog box may appear.
 The items displayed are based on the report template that you selected. The report
template, which is defined by an administrator in SmartPlant Foundation Desktop Client,
includes a view definition and a Microsoft Excel file. The view definition determines what
objects, relationships, and properties are to be included in the report. The Microsoft Excel
file specifies the layout of the report. For more information about creating report definitions,
see the How to Configure Reports guide.
 If the system administrator modifies the view definition used as the basis for your report, the
changes appear as follows:
 New properties are immediately available for use in the report.
 Modified properties appear as a delete of the old property and a create of the new
property.
 Deleted properties are removed from the report cache. If the property was used in the
report, you receive a message stating which property has been removed.
Define filter criteria for an ad hoc report

When creating or editing an ad hoc report, you can filter the results to only objects with property
values that match defined criteria. You can specify criteria on any number of properties.
1. In the Edit Report Definition dialog box, find a property for which you want to define the
criteria to be used to filter the report results.

Reports
2. In the Criteria column, select Click Me in the row that corresponds with the property to
open the Criteria Definition dialog box.

Reports
3. In the Criteria Definition dialog box, use the Operator and Value boxes to define the
criteria that must be met by an object before it can be returned by the report.
4. Click Add Criterion to list the criterion in the Currently defined criteria box.
5. If necessary, click either And or Or, and define additional criterion that must be met.
You can remove or modify added criteria by selecting them in the Currently defined
criteria window and clicking Update Criterion, Delete All Criterion, or Update Selected
Criterion.
6. Click OK to return to the Edit Report Definition dialog box where you can further configure
the results of the report. The Criteria column displays the criteria you defined in the
appropriate row.
 You can define filter criteria for multiple properties on the same report.
 You can define filter criteria for a property when defining the report, or you can use the
Prompt option to allow the user to provide a criteria when they run the report.

Reports
Run a report as a scheduled task

To run a report as a scheduled task, do the following:
 Optional: Configure SmartPlant Foundation to run on a separate server or process. See
Configure the Scheduler on an Alternate Server in How to Configure the Infrastructure
Model.
 Create a report.
 Define your report criteria, including the output type and templates to use.
 Schedule the report to run.
 Check the List of Notifications for completion of the report.
1. Create a report and define your report criteria. See Create a new report (on page 288) for
more information.
2. Check the Run in background check box in the Schedule Ad Hoc Report group of the
Edit Report Definition dialog box.
3. Select the date for the report to run from the Start date calendar.
4. Edit the time you want the report to start processing.

5. Click OK to send the report to the Scheduler. A message appears stating the report is
running in background mode.
6. To monitor the scheduled task, click Query > Schedule Tasks, or click Query for
Scheduled Tasks on the toolbar.
7. Click List of Notifications on the toolbar to see that the report is processed.
8. Right-click the report, and then select View Report to display the report.

Reports
Terminate a report
Terminating an object changes 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.
You can view the history of a terminated object by changing the effective date of the database to
a time before the object was terminated.
1. Click Query > Reports.
You can also click Find > Reports.
2. Right-click the report that you want to terminate and select Terminate.
3. Confirm that you want to terminate the report.
Learn more about reporting output styles

List View
The list view style, or new window format, is the normal output format for a query, and is most
useful where the results of the query are more of an emphasis than the format. The Configure
Report dialog box can still be used to order the columns in the list view, set criteria on the data
to be returned, and define the order of the result set. The list view window appears as another
window within the SmartPlant Foundation Desktop Client.
Excel Report Styles

Excel
The report results are displayed as a Microsoft Excel spreadsheet, and can be saved out as
such.
The following example shows the results of the output from running a Method Access report.
Excel Extended
The Excel Extended style provides a more detailed report format than the Excel style. In this
reporting output style, the relationships to the first object are all listed on separate rows.
The output from running a Method Access report is shown below. Displaying the two Access
Groups in different rows makes the separate relationships between Method and Access Group
much clearer.

Reports
Excel Repeated
The Excel Repeated style displays the output in a more condensed format than the other Excel
output modes. In the Excel Repeated mode, if an object has a one-to-one relationship to a
second object, the two objects will be displayed in the same row in the spreadsheet. The second
object will be displayed as a property of the first object. If the relationship between the two
objects is one-to-many, the relationship will be on a separate row. Properties on relationships
are also listed on the same row.
In the example below, the method name, the Client API, and the Access Group are all listed on
the same row. The relationship between the method and the Client API is one-to-one, so they
are on the same row. The relationships between the method and the Access Group are
one-to-many, so they are on separate rows.
Depending on the quantity of one-to-one relationships, this report output mode can result in a
much smaller Microsoft Excel spreadsheet than the other Excel report output modes.
Word
Results are displayed in Microsoft Word format and can be saved out as a Microsoft Word
document.
HTML
The results are displayed in a new Internet explorer browser window.
The layout for the report is hard-coded into the server reporting code. Users wishing to
customize the layout for web-style reporting should consider using the XHTML output type.
XHTML
The XHTML output type is the result of an XSL transformation of an XML Document, and is a
means of converting XML data into a more usable format.
The XSL Transformation is achieved by the combining of two XML-style documents to produce
an HTML page.
XSL can host scripting languages such as JavaScript and VBScript, and also has its own built-in
query language called Xpath.

Reports
XHTML (Word)
Results are displayed in XHTML format and output into a Microsoft Word document.
XHTML (Excel)
Results are displayed in XHTML format and output into a Microsoft Excel spreadsheet.
Custom Report
You can send the report results to a custom reporting application if your system administrator
has set up such a configuration.
Graphic Reports
Graphic reports provide a quick way to view only those items in a drawing that you want to see.
You can save the definitions to create custom graphic reports that you can reuse. Because you
can run graphic reports only on a specific drawing or design file, you must select the drawing or
design file before you run the report.
You can run a graphic report in several ways:
 You can right-click a document, click Files > Run Graphic Report, and select the graphic
report you want to run.
 You can right-click a graphic report definition, click Run Graphic Report, and then select
the document revision on which you want to run the report.
 You can run a graphic report by viewing a drawing or model with the View and Markup
command, right-clicking a blank area of the drawing, and clicking Files > Run Graphic
Report.
New Graphic Report dialog box

Allows you to select the item type for a new graphic report in SmartPlant Foundation.
Description - Displays the descriptions of the available item types.
Save Graphic Report dialog box

Allows you to save your query criteria for the graphic report.
Name - Displays the name of the graphic report that you want to save.
Description - Displays the description of the graphic report that you want to save.
Owner - Displays the user name of the user who created the graphic report definition.
Edit Graphic Report Definition dialog box

Allows you to define the query criteria for a graphic report.
Related Item - Specifies the category of the property that you want to read from the database
and put into the graphic report.
Caption - Displays the names of the properties that can be selected for your graphic report.
Criteria - Allows you to type a value for your query criteria. Click in this area to open the Criteria
Definition dialog box, where you may define the criteria to be used in the display of the drawing.

Reports
Prompt - Indicates whether the user is prompted for a value to be used as a criteria when the
graphic report is executed. When this value is set to True, the user is prompted. Click the value
in this box to switch between True and False.
Symbology - Opens the Define Symbology dialog box, where you can choose the way items
are displayed in the graphic report.
Save - Saves the report in its current format.
Save As - Opens the Save Graphic Report dialog box, where you can provide a name and
description for the report definition. When you click this button, you create an entirely new
graphic report based on the current graphic report definition.
Define Symbology dialog box

Allows you to specify how items are displayed in the graphic report. This dialog box consists of
separate tabs for defining symbology for two-dimensional drawings and three-dimensional
models.
2D tab of the Define Symbology dialog box

Allows you to specify how items are displayed in the graphic report.
Matching items - Specifies how items that meet the defined criteria are displayed in the graphic
report.
Color - Defines the color in which the items matching the specified criteria are displayed. From
this list box, you can select to use the native color, as defined in the drawing, or Custom, and
click the corresponding box to choose the color you want to use for matching items.
Line weight - Choose the line weight you want to use to display items that match the specified
report criteria.
Non-matching items - Specifies how items that do not meet the defined criteria are displayed in
the graphic report.
Display - Indicates whether non-matching items are displayed in the graphic report display at
all. If this check box is not selected, only items that match the specified criteria will appear in the
display.
Color - Select the color in which the non-matching items are displayed. From this list box, you
can select to use the native color, as defined in the drawing, or select Custom, and click the
corresponding box to choose the color you want to use for non-matching items.
Line weight - Select the line weight you want to use to display non-matching items.
Fit - Select from a list of zoom options to determine the focus in the graphic report. None
indicates that the zoom level and displayed portion of the drawing will not be changed based on
the report results. Matching items indicates that the focus will be zoomed at as tightly as
possible while still displaying all matching items, and Full drawing indicates that the whole
drawing will be displayed.
Reset to default values - Click this button to return all the options on this tab to their default
settings.
3D tab of the Define Symbology dialog box

Allows you to specify how items are displayed in the graphic report.
Matching items - Specifies how items that meet the defined criteria are displayed in the graphic
report.

Reports
Color - Select the color in which the items matching the specified criteria are displayed. From
this list box, you can select to use the native color, as defined in the drawing, or Custom, and
click the corresponding box to choose the color you want to use for matching items.
Line weight - Choose the line weight you want to use to display items that match the specified
report criteria. This value is used only when the render mode is set to Outline.
Line style - Select a line style to be used to display matching items in the graphical report. You
can choose to use the native style from the drawing or select from a number of other line styles.
This value is used only when the render mode is set to Outline.
Render mode - Specifies how you would like to have matching items displayed in the graphic
report. You can have items displayed with the render defined in the original drawing, or you may
choose to have them displayed as outlines or as solid objects with shading. This setting is used
only when the 3D model is displayed in smooth shaded mode.
Non-matching items - Specifies how items that do not meet the defined criteria are displayed in
the graphic report.
Display - Indicates whether non-matching items are displayed in the graphic report display at
all. If this check box is not selected, only items that match the specified criteria will appear in the
display.
Color - Choose the color in which the non-matching items are displayed. From this list box, you
can choose to use the native color, as defined in the drawing, or choose Custom, and click the
corresponding box to choose the color you want to use for non-matching items.
Line weight - Choose the line weight you want to use to display non-matching items. This value
is used only when the render mode is set to Outline.
Line style - Select a line style to be used to display non-matching items in the graphical report.
You can choose to use the native style from the drawing or select from a number of other line
styles. This value is used only when the render mode is set to Outline.
Render mode - Choose how you would like to have non-matching items displayed in the
graphic report. You can have items displayed with the render defined in the original drawing, or
you can choose to have them displayed as outlines or as solid objects with shading. This setting
is used only when the 3D model is displayed in smooth shaded mode.
Fit - Select from a list of zoom options to determine the focus in the graphic report. None
indicates that the zoom level and displayed portion of the drawing will not be changed based on
the report results. Matching items indicates that the focus will be zoomed at as tightly as
possible while still displaying all matching items, and Full drawing indicates that the whole
drawing will be displayed.
Reset to default values - Click this button to return all the options on this tab to their default
settings.
Run Graphic Report dialog box

If you selected a graphic report before clicking the Run Graphic Report command, this dialog
box allows you to choose a drawing or model on which to run the selected graphic report
definition. If you selected a drawing or model before clicking the Run Graphic Report
command, this dialog box allows you to choose one or more graphic report definitions to apply
to that model or drawing.
Criteria that appear in this table are determined by the selection you made before running the
Run Graphic Report command.
Selecting a drawing or model on which to run the selected graphic report

Name of Item - Displays the name of the drawing or model.

Reports
Description - Displays the description of the drawing or model.

Class - Specifies the class of each drawing or model.
Creation Date - Indicates the date on which the drawing or model was created.
Created By - Indicates who created the model or drawing.
Last Updated Date - Indicates the date on which the drawing or model was last updated.
Selecting one or more graphic reports to run against the selected model or drawing
Name of Item - Provides the name of defined graphic reports that are available to use. You may
choose one or more of these reports by selecting them from this table.
If only one report is defined and available, this dialog box does not appear; the report is
used automatically.
Classification - Specifies the classification of each defined graphic report.
Descriptions - Provides a brief description of each graphic report as provided when it was
created.
Graphic Results window

The Graphic Results window is available when you view graphic reports. This window lists all
the graphic report definitions as well as their resulting items that are applied to a view.
You can apply multiple graphic report definitions to a drawing or a model at one time, once the
drawing or model is displayed. When you do so, those definitions are listed in this window in the
order in which they were applied. If an item in the view matches more than one definition, the
symbology of the last matching definition is used in the display.
Selected definitions are applied to the display. If you clear the selection, the results of that
definition are removed from the display.
Beneath each definition is a list of each item in the drawing that matches the criteria in that
definition. When the the name of the item is selected, the item is selected in the display and the
symbology of the item is changed accordingly. When selection is cleared, the symbology of the
item reverts to the symbology of the drawing or to the last report that included the item.
If the Properties window is displayed, selecting an item in this window displays the properties of
that item there. Right-clicking on a report definition item displays a menu with two commands --
Update Symbology and Remove. The Remove command removes the report from the
window. Clearing the report selection has the same effect on the display as using the Remove
command.
The Update symbology command allows you to modify the symbology definition for a report
on-the-fly for the currently displayed report only. It does not apply the changes back to the report
definition. You may want to use this command if you find that the defined symbology is not
different enough from the drawing items to allow you to differentiate easily between matching
and non-matching items or if you want to differentiate between multiple reports applied to the
drawing.
You can perform tasks in this window using the toolbar along the top of this window. These
command are described below.
Collapse All - Closes all the hierarchical items in the tree.
Expand All - Opens all the hierarchical items in the tree.
Check All - Selects the all of the graphic report definitions and matching items in the tree.

Reports
Uncheck All - Clears all of the selected items in the tree.
Current Definitions window

The Current Definitions window is available when you view graphic reports. This window lists
all the graphic report definitions that are applied to a view and lists details about the criteria for
each.
You can apply multiple graphic report definitions to a drawing at one time. When you do so,
those definitions are listed in this window in the order in which they were applied. Under each
definition, a table lists all the properties and values that are criteria for the definition.

 Create a new graphic report (on page 302)
 Edit a graphic report definition (on page 304)
 Modify the symbology of a graphic report (on page 305)
 View an existing graphic report (on page 307)
 Select a graphic report to run (on page 308)
 Apply a graphic report to a model (on page 309)
Create a new graphic report

The File > New > Graphic Reports command opens the New Graphic Report dialog box,
where you can create a new graphic report definition to be used to display drawings.
1. Click File > New > Graphic Report.

Reports
2. Select a report type from the list, and click OK. Below is an example of a report type list. The
options available in this list vary.
3. Select the properties on which you want to report.
 You can define search criteria for each property by selecting Criteria and using the
Criteria Definition dialog box.
 You can allow users to specify search criteria for a row each time the report is run by
setting the Prompt option to True.
 You can specify how the items in the drawing are displayed by clicking Symbology and
choosing options on appropriate tab of the Define Symbology dialog box.
 Since properties are not displayed when you run a graphic report, select only those
properties for which you define criteria. Every property defined in the report must have
either a predefined value for the criteria or be set to prompt you for the value when you

Reports
run the report. If this is not the case, an error message appears when you attempt to
save the report.
4. Click OK.
5. A system prompt appears asking if you want to save the changes you made to the graphic
report definition. Click Yes.
6. Specify details for the graphic report, and click OK.
Edit a graphic report definition

The Edit Graphic Reports command opens the Edit Graphic Report Definition dialog box to
modify the characteristics of an existing graphic report. This command is available when you
right-click a graphic report definition.
1. Click Find > Graphic Reports.
You can also find the available graphic report by clicking Find > Query> Graphic
Reports.
2. Search for the report definition you want to edit by providing a name or using wildcards to
return a list of available graphic report definitions.
3. Right-click the graphic report that you want to edit and click Edit Graphic Report.
4. Change the report options as needed.

5. Click Save to save the changes you made to the graphic report definition.

Reports
6. Type a name for the saved report, and click OK.
Modify the symbology of a graphic report

To change the symbology used in a graphic report while editing a graphic report definition, do
the following. For more information about finding and editing a graphic report definition, see Edit
a graphic report definition (on page 304).
 On the Edit Graphic Report Definition dialog box, click the Symbology button to open the
Define Symbology dialog box.
This dialog box has two tabs, one for two-dimensional drawings and one for three-
dimensional models. Procedures for using each tab follow:
2D Drawings

Reports
1. On the Edit Graphic Report Definition dialog box, click the Symbology button to open the
2. Select the 2D Drawings tab on the Define Symbology dialog box.
3. For items that match the defined criteria, select a color. You can choose to use the native
color in the drawing or you can specify a custom color choice.
4. Select a line weight for items that match the defined criteria. You can use the line weight
defined in the drawing or define your own.
5. Using the options in the Non-matching items section of the dialog box, select a color and
line weight to be used for items that do not match the defined criteria.
If you would rather not display any items that do not match the criteria, clear the
Display check box. When this check box is cleared, non-matching items are not displayed
in the graphic report at all.
6. Select a focus for the graphic report from the Fit list. You can display the entire drawing, use
the focus as currently defined in the drawing, or zoom in as tightly as possible while still
showing all items that match the specified criteria.
If you change your mind after selecting options on this tab, click the Reset to Default
Values button to return all the options to their default settings.
3D Models
1. On the Edit Graphic Report Definition dialog box, click the Symbology button to open the
2. Select the 3D Models tab on the Define Symbology dialog box.
3. For items that match the defined criteria, choose a color. You can choose to use the native
color in the model or you can specify a custom color choice.

Reports
4. Select a line weight for items that match the defined criteria. You can use the line weight
defined in the model or define your own. This value is used only when the render mode is
set to Outline.
5. Select a line style to be used when displaying matching items. You can choose from the line
style used in the model and a number of additional styles in the Line style list. This value is
used only when the render mode is set to Outline.
6. Indicate how matching items should be rendered in the display. Items may be displayed as
solid, shaded objects, in outline, or as defined in the model. This setting is used only when
the 3D model is displayed in smooth shaded mode.
7. Using the lists in the Non-matching items section of the dialog box, select a color, line
weight, line style, and rendering mode to be used for items that do not match the defined
criteria.
If you would rather not display any items that do not match the criteria, clear the
Display check box. When this check box is cleared, non-matching items are not displayed
in the graphic report at all.
8. Select a focus for the graphic report from the Fit list. You can display the entire drawing, use
the focus as defined in the drawing, or zoom in as tightly as possible while still showing all
items that match the specified criteria.
If you change your mind after selecting options on this tab, click the Reset to Default
Values button to return all the options to their default settings.
View an existing graphic report

1. Click Find > Published Documents.
2. Right-click the drawing or model and select Files > Run Graphic Report.
3. From the Run Graphic Report dialog box, click one or more graphic report definitions you
want to apply to the drawing or model.

Reports
4. Click OK.
 You must have SmartPlant Markup Plus installed on your computer to view the graphic
report.
 Alternately, you can open a graphic report by using a right click in the tree view, click Run
Graphic Report, and then select the document revision on which you want to run the report.
 If you want to run a graphic report on a document revision that you are already viewing with
the View and Markup command, right-click in a blank area of the drawing, click Files > Run
Graphic Report, and choose a graphic report from the list of definitions in the Graphic
Results window.
Select a graphic report to run

The Run Graphic Report command opens the Run Graphic Report dialog box to choose a
drawing to open with the selected graphic report definition. This command is available from the
Files menu when you right-click a graphic report definition.
If you run this command against a list of drawings, a dialog box appears, displaying a list of
graphic reports. You can select one or more graphic reports to apply to the drawing. If you run
the command against an item selected from a list of graphic reports, a dialog box appears,
displaying a list of the drawings and models. You can select one from that list.
You can also select the Run Graphic Report command from a displayed drawing or model by
clicking in a blank area of the display to open the interface from which to run graphic reports by
selecting them from a list.
1. Click Find > Graphic Reports.
2. Define the graphic report name criteria in the Enter name field.
3. Click OK.
4. Select a graphic report and right-click Run Graphic Report.
5. Enter the document name in the Enter name field.
6. Click OK.

Reports
7. Select the drawing or model on which to run the report.
8. Click OK.
Apply a graphic report to a model

The following steps allow you to drag and drop an existing graphic report into a 3D model. The
content of the graphic report displays in the 3D model and also populates the Graphic Results
window.
This option is only available for use with 3D models.
The Graphics Results window background color automatically matches the background
window color of the 3D model. Also, the displayed tree view text color of a listed item matches
the color specified in the graphic report that was placed in the 3D model. For example, if the
items matching the graphic report are displayed as orange in the 3D model, the text in the tree
view of the Graphics Results window displays as orange.
1. Select an existing graphic report.
2. Drag the graphic report in a model.

Reports

SECTION 13
Change Notifications
In the Desktop Client, you can register your interest in specific events for objects or object
classes to receive e-mail notification when that event is performed for that object or class. For
example, if you want to be notified every time a particular document is checked out, you can
subscribe to the check out event for that document object. You can also be notified through the
SmartPlant Foundation inbox, or the notification can be logged to a file.
Although change notification is important for document management, you can subscribe to
changes for other objects throughout the Desktop Client, provided that those objects are
subscribable.
Subscriptions support multiple query configurations.
Manage Subscription dialog box

Allows you to manage the list of specific events to which you have registered to receive e-mail
notification when that event occurs to that object.
Subscription Settings
<Object> - Displays the object for which a subscription exists.
Event - Lists the available events for the selected object.
Condition - Lists the conditions that are available to filter the subscription based on specific
criteria.
Add - Adds the event and/or condition to the user's subscription list.
Update - Allows the user to change the event and/or condition for an existing object
subscription.
Remove - Removes the subscription.
Remove All - Removes all subscriptions.
Subscription Table
<Object> - Displays the object for which a subscription exists.
Event Name - Displays the name of the event to which the user is subscribed
Condition Name - Displays the name of the condition to which the event is related.
Creation Date - Displays the date on which the subscription was created.
Item Create Config - Displays the configuration in which the item was created.
 If you want to select multiple events for the object, hold down the CTRL key and click the
events you want to subscribe to in the list.
 If you have subscribed to events previously, those events appear selected in the list.
If you have subscribed to other events for this object and want to modify your
subscription, you must hold down the CTRL key while you select new events and clear existing
events in the list. If you do not hold down the CTRL key, all selected events are cleared.


 Manage object subscriptions (on page 312)
 Add an object subscription (on page 312)
 Update an object subscription (on page 314)
 Remove an object subscription (on page 314)
 Manage class subscriptions
 Add a class subscription
 Update a class subscription
 Remove a class subscription
Manage object subscriptions

The Subscription > Manage My Subscription command allows you to specify if you want to
receive notification when particular events occur to the selected object. The Subscription menu
with this command is available when you right-click an object.
1. Right-click the object for which you want to subscribe in the tree or list view.
You can also select multiple objects.
2. On the shortcut menu, click Subscription > Manage My Object Subscriptions. The
Manage My Object Subscriptions dialog box displays the events available for the selected
object or objects.
If you selected multiple objects, the Manage Subscriptions for Multiple Objects
dialog box appears. This dialog box includes columns for the object name and class
definition in the lower pane. Other differences between the two dialog boxes are described
as necessary in the following procedures.
Add an object subscription

1. In the Event list, select a new event to which you want to subscribe for the object(s).
For document objects, the Event list includes events for each part of a document
object (for example: document master, revision, and version).
2. To set a condition, click beside Condition and select a condition from the list. This step
is optional.
You can also type a condition in the Condition box.
3. Click Add. The subscription is added to the list in the lower pane.

If you selected multiple objects, the event, with or without a condition,is added for all
selected objects.
The software sends you e-mail or notification or both, depending upon your user
preferences, when the event to which you have subscribed occurs. For example, if you
subscribe to the check out event for a document revision, you receive e-mail notification when
any user checks out the revision or when any condition of the subscription is satisfied.

Update an object subscription

1. To change the event or condition or both for an existing object subscription, select the
subscription in the lower pane.
You can update only one subscription at a time.
2. Select a different Event or Condition or both.
You can also type a condition in the Condition box.
3. Click Update.
4. Click Yes to continue with the update.
Remove an object subscription

1. To unsubscribe from an event for an object, select the subscription from the lower pane, and
click Remove.
 If you are managing subscriptions for multiple objects, you can use the Select All button
below the object list to select all of the existing object subscriptions.
 To remove all subscriptions, click Remove All.
2. Click OK.

Manage class subscriptions

1. Right-click the class definition and click Subscription > Manage My Subscriptions.
2. Select an Event (mandatory).

3. Select a Condition (optional).

4. Click Add. The Subscription is added to the Class Definition and also displayed in the list at
the bottom of the dialog box.
Option Description
Class definition Displays the Class definition selected as read-only.
Event Lists all the events for the selected Class Definition.
Condition Lists the conditions that can be set.
Add Adds the subscription to the Class Definition.
Update Updates the subscription selected in the list.
Remove Removes the selected subscription from the Class Definition.
Remove All Removes all the subscriptions from the Class Definition.
5. Repeat steps 2 to 4 to add further subscriptions to the Class Definition based on different
events or conditions.
6. Use the Update and Remove buttons to manage the subscriptions.

SECTION 14
Transmittals
A transmittal is a controlled package of documents with an accompanying report used to
perform, record, and track the distribution of project documentation between the different design
teams, subcontractors, vendors, and construction sites involved in a project. The term
transmittal usually refers to the top sheet or report that lists how many copies of each document
are sent to whom, and for what reason. In a paper-based system, the transmittal is used by the
print room to prepare physical prints. In an electronic system, such as SmartPlant Foundation,
the transmittal becomes a collection object that links a set of documents to a set of recipients
with reasons for receipt. The transmittal report is attached to the collection object and is
e-mailed to the recipients upon issue of the transmittal. In many cases, transmittals are used to
distribute documents between different companies, which would need to be recorded on the
transmittal.
Learn more about Transmittals

Transmittals play an important part in tracking the progress of a project. Milestone payments
from the client are often linked to the distribution of particular documentation on transmittals, the
most notable of which is the site construction transmittal when documents are released to the
site for construction.
Transmittals are also useful for internal document management, such as the distribution of
control documentation, safety procedures, and other documents between departments. This is
typical of the owner operator (OO) as well as the EPC.
Distribution matrices are used to set up lists of recipients for transmittals. Their structure varies
somewhat, depending on whether they define recipients for internal or external transmittals.
However, both types of matrices include a transmittal Reason For Issue (RFI) (for example, For
Information or For Construction), and each recipient on the matrix has a Reason For Receipt
(RFR) that indicates why he or she is included (for example, For Comment). External matrices
allow you to define recipients based on the external organization to which the transmittal will be
sent. Internal matrices allow you to define recipients based on the contract to which the
document belongs and the specific type of documents included (such as PIDs or 3D
documents).
Transmittals often have a controlling recipient, so that the responses from all the recipients are
fed back through the controlling recipient rather than individually.
The transmittal is issued and the attached documents are distributed to the list of recipients. In a
paper-based world, a transmittal report is printed and sent to the Print Room, where all the
relevant documents are printed and packaged for distribution. In a fully integrated transmittal
and document management system, the transmittal report is mailed electronically to the
recipients, who log in to retrieve the relevant documents and perform whatever actions are
necessary, such as comments or changes. If recipients do not have access to the document
management system, the documents must be made available through some other mechanism,
such as shared folders, FTP sites, or distribution on CD-ROM.
Transmittals that are issued for information are closed out after issue. Transmittals that are
issued for comment remain active until all comments are received, at which point the transmittal
can be closed, usually by the Document Controller.

Transmittals
Transmittals that are issued in error can be canceled. In this case a transmittal report is
redistributed marked clearly as canceled as a form of recall notice.

 Transmittal icons (on page 318)
 Transmittal project roles (on page 319)
 Transmittal life cycle (on page 320)
 Transmittal structure (on page 321)
 Distribution matrices (on page 321)
Transmittal icons
Transmittal icons reflect the life-cycle transmittal state and the transmittal class. They are also
important in identifying an issued transmittal that is overdue (that is, its Planned Completion
Date has been reached).
Internal Transmittal Icons

RESERVED - The issue state is RESERVED after you
enter transmittal details (such as planned completion
date), create additional transmittal sections as required,
and select the transmittal workflow.
ISSUED - The issue state is ISSUED after you run and
attach the transmittal report, notify recipients (e-mail and
SmartPlant Foundation To Do List), and set the transmittal
Issue Date. Once the status is changed to ISSUED, the
transmittal structure is frozen.
ISSUED and Overdue - The planned completion date has
been reached; however, the transmittal is not completed.
COMPLETED - When all responses have been received
and all issue steps are completed, the issue state is
COMPLETED. You cannot make any further updates or
comments to the transmittal or its report.
CANCELED - The issue state is CANCELED after you
set the transmittal Cancel Date, User, and Reason. In
addition, if a transmittal is issued in error, the transmittal is
reissued as CANCELED and is redistributed as a form of
recall notice. The transmittal structure is frozen.
TEMPLATE - A special state indicating that the transmittal
can be used as a basis for new transmittals.
External Transmittal Icons

RESERVED - The issue state is RESERVED after you
enter transmittal details (such as planned completion

Transmittals
date), create additional transmittal sections as required,

and select the transmittal workflow.
ISSUED - The issue state is ISSUED after you run and
attach the transmittal report, notify recipients (e-mail and
SmartPlant Foundation To Do List), and set the
transmittal Issue Date. Once the status is changed to
ISSUED, the transmittal structure is frozen.
COMPLETED - When all responses have been received
and all issue steps are completed, the issue state is
COMPLETED. You cannot make any further updates or
comments to the transmittal or its report.
CANCELED - The issue state is CANCELED after you
set the transmittal Cancel Date, User, and Reason. In
addition, if a transmittal is issued in error, the transmittal
is reissued as CANCELED and is redistributed as a form
of recall notice. The transmittal structure is frozen.
TEMPLATE - A special state indicating that the
transmittal can be used as a basis for new transmittals.
Transmittal project roles

This section lists typical user roles associated with transmittals. These roles may vary from
organization to organization.
Document Controller
These personnel are responsible for the integrity of all project documentation and the
distribution of that documentation to the relevant project groups at the appropriate time. The
following tasks are examples of responsibilities of the document controller:
 Project document index management
 Transmittal distribution management
 Transmittal preparation and distribution
 Transmittal response tracking and follow up
Design Engineer
These users are responsible for the generation of the project documentation. Although they do
not manage transmittals themselves, they are typically responsible for the following kinds of
tasks:
 Review transmittal histories of documents
 Prepare outline transmittals
 Prepare transmittal issue requests
 Receive and respond to transmittals
Client
Client recipients have to be clearly marked and distinguished from the main project recipients on
most transmittals. They typically do not have access to the SmartPlant software directly. They
have the following types of responsibilities:

Transmittals

Vendors and Sub-Contractors

These personnel are usually not connected to the project management system, but still
exchange documentation with the project team, and often in large batches. Transmittals are the
mechanism for the exchange, but this process requires packaging the documentation for
distribution and access from a separate environment, often outside the firewall. These users
typically participate in the following types of tasks:
 Return project documentation on transmittals
Transmittal life cycle

The transmittal life cycle is summarized as follows:
Creation  Enter transmittal details, such as planned completion date.
 Create any additional transmittal sections, as required.
 Select the transmittal workflow.
 Create as a RESERVED transmittal.
Attach Documents  Add the required documents.
Manage Recipients  Add recipients manually or from a matrix.
 Set recipient reasons for receipt, acknowledgement, and so
forth.
Issue  Run and attach the transmittal report.
 Send notification to recipients (e-mail and/or SmartPlant
Foundation Inbox).
 Set the transmittal IssueDate.
 Set transmittal state to ISSUED.
 Freeze the transmittal structure.
Track Responses  Reporting on outstanding action, overdue actions, and so forth.
Complete  Set the transmittal Completion Date.

 Set the transmittal state to COMPLETED.
In addition to these standard lifecycle events, a transmittal may also exist in the following states.
Template  This is a special state indicating that the transmittal can be used
as a basis for new transmittals.
Cancel  Set the transmittal Cancel Date, User and Reason
 Set the transmittal state to CANCELED
 Freeze the transmittal structure
 If Cancelled from the ISSUED state, Re-issue to recipients as
CANCELLED.

Transmittals
Transmittal structure
Transmittals can be set up to have documents attached directly to the transmittal object, or they
can be broken down into sections to group documents together, such as those that need editing
or comments, or those that are just for reference. In the delivered SmartPlant Foundation model,
internal transmittals are set up to have documents organized into transmittal sections, while
external transmittals have documents attached to the transmittal itself.
Here is an example of an issued internal transmittal with sections:
When you create a transmittal, it is attached to a workflow that manages transmittal approval,
issue, distribution, recipient responses, and completion.
You can use template transmittals to create transmittals that already have relevant sections
defined, a workflow attached, and optionally some key recipients already identified by their
project roles.
Distribution matrices
Distribution matrices for transmittals determine who receives documentation via transmittal and
what is required of those people. Transmittal matrices are created separately for internal and
external transmittals.
A distribution matrix is a table with recipients along the top and transmittal categories down the
side. The transmittal categories can be based on document type, project, contract, and so on.
Each cell in the table is marked with the reason for receipt for each recipient.
In SmartPlant Foundation, there is usually more than one distribution matrix for each type of
transmittal, either internal or external. Each distribution matrix is created for a specific transmittal
reason for issue; therefore, the reason for issue for each matrix is unique for the transmittal type.
When a transmittal is created, the reason for issue that the user selects determines which
distribution matrix is used.
Administrators should refer to Distribution Matrix Configuration and Matrix Management in the
How to Configure the Workflow Model guide for instructions for creating matrices and assigning
matrix recipients.

Transmittals
Set up transmittals
Before you can create internal and external transmittals, a system administrator must create
objects in SmartPlant Foundation that will be used in those transmittals.
 Departments and offices - If you want to use internal transmittals to distribute documents
among internal departments or site and affiliate offices, these objects must exist in the
 Companies - If you plan to distribute documents to external companies or clients using
external transmittals, you must create external companies in the Desktop Client first.
 Suppliers - External transmittals can be used to distribute documents to external suppliers,
if suppliers have been defined in SmartPlant Foundation.
 Contracts - Within a project, there may be multiple contracts in use. Contracts can be used
in transmittals for tracking purposes.
 Distribution matrices - Distribution matrices can be used to determine which internal or
external users receive the transmittals and what tasks are required of those recipients.
Assign Recipients dialog box

Allows you to create the matrix of users that will be assigned as recipients to a workflow step,
based on the defined conditions.
User List - Displays the list of users or roles available for assignment.
Add - Allows you to assign the selected users or roles to the distribution matrix.
Remove - Allows you to remove the current users or roles assigned to the distribution matrix.
Property columns - Displays the properties assigned to the distribution matrix. These
properties are set by the system administrator according to project requirements. Typical
properties include document type, contract, project, or area.
User or Role columns - Displays the users or roles assigned to the transmittal matrix. The cells
in these columns determine the actions required from the users or roles that receive transmittals
for documents as determined by the property columns. For users who receive paper documents,
the cells in these columns also determine the paper format used to print the documents attached
to the transmittals. The default reasons for receipt in the delivered SmartPlant Foundation model
are I (information), C (comment), and W (work). These cells are color coded according to the
color palettes on the dialog box.
Context menus - Right-click items in the matrix view to display a context menu that allows you
to manipulate the items in the view. Some commands are available on more than one context
menu.
Column Headings
The following commands are available from the context menu when you right-click on a column
header in the matrix.
 Move Column - Opens the Move Column dialog box where you can adjust the placement
of the selected user columns.
 Add Column - Opens the Add Column dialog box, which allows you to add a user or role
column. You must type a valid user or role name to add the new column.
 Duplicate Column - Opens the Duplicate Column dialog box where you can add a new
user or role column with the same reasons for receipt as the column being duplicated. You
must type a valid user or role name to add the new column.
 Clear Column - Removes all reasons for receipt from the column.

Transmittals
 Delete Column - Removes the user or role from the display.

Change Recipient Name – Opens the Change Recipient Name dialog box, where you can
provide the name of a user or role that for which you want associate the selected column, in
place of the current user or role.
Row Headings
The following commands are available from the context menu when you right-click on a row
header in the matrix.
 Duplicate Row - Adds a new row with the same properties and reasons for receipt as the
selected row.
 Delete Row - Removes the row from the matrix.
Individual Cells
The following commands are available from the context menu when you right-click on an
individual cell in the matrix in a column under a user name or role.
 Reason for Receipt and Format - Opens the Reason for Receipt and Format dialog box,
where you can select the reason for receipt and paper format for the user or role. Reasons
for receipt are defined in the SmartPlant Foundation Desktop Client by the system
administrator.
 Cut - Removes the information from the cell and places it on the clipboard.
 Copy - Places a copy of the contents of the cell on the clipboard.
 Paste - Writes information from the clipboard into the cell.
 Delete - Removes the contents of the cell without writing the information to the clipboard.
 Duplicate Row - Adds a new row with the same properties and reasons for receipt as the
selected row.
 Delete Row - Removes the row from the matrix.
 Move Column - Opens the Move Column dialog box where you can adjusts the placement
of the selected user columns .
 Add Column - Opens the Add Column dialog box, which allows you to add a user or role
 Duplicate Column - Opens the Duplicate Column dialog box where you can add a new
user or role column with the same reasons for receipt as the column being duplicated. You
must type a valid user or role name to add the new column.
 Clear Column - Removes all reasons for receipt from the column.
 Delete Column - Removes the user or role column from the matrix.
 Change Recipient Name - Opens the Change Recipient Name dialog box, where you can
provide the name of a user or role that for which you want associate the selected column, in
place of the current user or role.
 Export to Clipboard - Places a copy of the matrix on the Clipboard, which allows you to
paste the data into Microsoft Excel or other programs.
 Import from Clipboard - Imports Clipboard data that was placed there from Microsoft
Excel.
Matrix View Outside Matrix Cells

The following commands appear on the context menu when you right-click in any unused
portion of the matrix window.
 Add Column -Opens the Add Column dialog box, which allows you to add a user or role

Transmittals
 Export to Clipboard - Places a copy of the matrix on the clipboard, which allows you to
paste the data into Microsoft Excel.
 Import from Clipboard - Imports clipboard data that was placed there from Microsoft Excel.
Color palettes - Allows you to customize the color codes for the various cell types in the matrix
view.
Default format - Specifies the paper format automatically assigned to newly added paper users.
While this value appears in the new cell by default, it can be changed by right-clicking in the cell
and using the Reason for Receipt and Format command.
Default reason for receipt - Specifies the reason for receipt automatically assigned to newly
added users or roles. Reasons for receipt are defined in the SmartPlant Foundation Desktop
Client by the system administrator. While this value appears in the new cell by default, it can be
changed by right-clicking in the cell and using the Reason for Receipt and Format command.
Size columns for best fit - Resizes the columns in the matrix view.
User - Allows you to search for users to assign to the distribution matrix.
Role - Allows you to search for roles to assign to the distribution matrix.

 Create an internal department or office (on page 324)
 Create an external company (on page 325)
 Create an external department or office for transmittals (on page 325)
 Create a supplier for transmittals (on page 325)
 Create a contract (on page 326)
Create an internal department or office

To create an internal department or office, do the following:
1. Click File > New > Organization / Support Items > Department / Office in the Desktop
Client.
You must have document controller or administrator role privileges to access the
Organization / Support Items submenu.
2. Type a Name and Description for the department or office.
3. Provide any other details of the department or office, as necessary.

 To make this organization available for internal transmittals, select the Internal
organization option in the Department optional interfaces section.
4. Click Finish to create the department or office.
To use internal transmittals to distribute documents among internal departments or site
and affiliate offices, these objects must exist in the SmartPlant Foundation database.

Transmittals
Create an external company

1. Click File > New > Organization / Support Items > External Company in the Desktop
Client.
2. Type a Name and Description for the company.

 To make this organization available for external transmittals, select the External
organization option in the Company optional interfaces section.
3. Click Finish to create the company.
Create an external department or office for transmittals

1. Click File > New > Organization / Support Items > Department / Office in the Desktop
Client.
2. Type a Name and Description for the department or office.
3. Provide any other details of the department or office, as necessary.
4. In the Department optional interfaces section, select the External Organization option.
5. Click Finish to create the external department.
Create a supplier for transmittals

A supplier organization is defined to help with the setup of transmittals that are used to return
documents to suppliers.
1. Click File > New > Organization / Support Items > Supplier.
2. Type a Name and Description for the supplier.
3. Provide other details of the supplier, as necessary.
4. Click Finish to create the supplier.

Transmittals
Create a contract
1. Click File > New > Organization / Support Items >Contract.
2. Define details for the contract.
3. Click Finish to create the contract.
Create and manage transmittals

SmartPlant Foundation provides several transmittal creation and document attachment
methods. You can create transmittal objects using the File > New > Internal Transmittal or File
> New > External Transmittal commands, and then attach documents to the transmittals. You
can also select a list of documents, and use the Transmittals > New Internal Transmittal or
Transmittals > New External Transmittal command to create a transmittal with the files
already attached. Another method is to create a transmittal with the appropriate settings, and
then attach the documents to it or save the transmittal as a template for creating other
transmittals in the future.
 Documents are attached to transmittals conditionally. The default condition is that only
current documents can be attached, but the document controller can set up additional
controls, such as project, contract, or document type.
 Conditions can control attachment based on transmittal or section data. For example, each
section could be set up to accept only a certain document type, while the transmittal could
accept documents for only one contract.
 In the delivered SmartPlant Foundation model, the necessary conditions for documents
attached to internal transmittals with sections are that the document be signed off, that the
documents be related to the transmittal through the intermediate section object, and that the
transmittal section and documents belong to the same configuration.
 Since the document is not related directly to the transmittal by default, the software creates
a default section to which the documents selected in the first step are attached.
After transmittals are issued, the document controller can track comments from recipients using
the Transmittal Response Management command.
Update Step Recipients dialog box

Allows you to select the recipients for a workflow step.
User List - Displays the list of users or roles available for assignment. This box contains only
two roles (Submitter and ChangeOwner) until you query for users or roles.
Matrices List - Displays the list of users or roles available for assignment. This box is empty
until you search for matrices.
Assignment
User or Role - Displays the list of users or roles currently assigned to the transmittal.
Description – Displays the description for the user or role.

Transmittals
Reason for Receipt – Allows you to specify the reason that the user or the role will be assigned
the workflow step. The value is populated by default with the value in the Default action reason
for receipt box, but you can change the value here.
Format – Allows you to specify for the format in which information will be sent the user or role.
By default, the format is inherited from the setting in the Default format box, but the value here
can be modified.
Matrix Name – If the user name or role was already assigned to this step using a matrix, the
name of the matrix is displayed here.
Add - Allows you to assign the selected users or roles to the workflow step to perform an
assignment.
Remove - Allows you to remove the selected users or roles from the workflow step.
Information Only
User or Role - Displays the list of users or roles currently assigned to the step for information
purposes. The check box beside each user or role determines whether a response is required
upon receipt of the step.
Description – Displays the description for the user or role.
Reason for Receipt – Allows you to specify the reason that the user or the role will be assigned
the workflow step. The value is set to Information Only by default when a user or role is added
to the Information Only section. However, you can change the value here to any reason for
issue marked for Information Only when it was created.
Format – Allows you to specify for the format in which information will be sent the user or role.
By default, the format is inherited from the setting in the Default format box, but the value here
can be modified.
Matrix Name – If the user name or role was already assigned to this step using a matrix, the
name of the matrix is displayed here.
Add - Allows you to add the selected users or roles to the step for information purposes.
Remove - Allows you to remove the current users or roles assigned to the step for information
purposes.
If an email or paper user is assigned a workflow step, you will need to use the
Response Manager window to record their actions and complete the steps on their behalf.
Matrices
Matrix Name - Displays the name of any matrices assigned to the workflow steps to define
steps recipients.
Default values
Default format - Specifies the paper format automatically assigned to newly added paper users
or roles.
Default action reason for receipt - Specifies the reason for receipt automatically assigned to
newly added users or roles in the Assignment section of the dialog box.
Default information reason for receipt - Specifies the reason for receipt automatically
assigned to newly added users or roles in the Information Only section of the dialog box.
Group Acknowledgement Control

All recipients must acknowledge receipt - Indicates that all users in the Information list must
acknowledge the receipt of the step.

Transmittals
OneUserPerRole - Indicates that at least one user from each role included in the Information
list must acknowledge the receipt of the step.
OneUserPerStep – Indicates that only one user from all the users and roles included in the
Information list must acknowledge the receipt of the step.
Group Assignment Control

All recipients - Indicates that all users in the Assignment list must perform the work of the
step.
OneUserPerRole - Indicates that at least one user from each role included in the Assignment
list must perform the work of the step.
OneUserPerStep – Indicates that only one user from all the users and roles included in the
Assignment list must perform the work of the step.
Matrices - Allows you to search for particular matrices.
User - Allows you to search for users to assign to the step.
Role - Allows you to search for roles to assign to the step.
Response Manager dialog box

The Response Manager windows allows the document controller to perform workflow steps for
e-mail and paper users who do not have access to SmartPlant Foundation. The Response
Manager window behaves identically to the To Do List.
In the Response Manager window, you can view and complete checklists associated with
workflow steps. You can also complete voting steps and mark other steps completed or unable
to complete to update them.
The Response Manager window has several parts:

 Toolbar
 List View
 Checklist Preview Pane
Toolbar
The Response Manager toolbar contains the following buttons:
Icon Name Description
Refresh Refreshes the Response Manager

with new tasks. By default, the

Transmittals

software automatically refreshes the
Response Manager every 10 minutes
if the value is not changed through
user preferences. However, you can
force a manual update on the
Response Manager data using the
Refresh button. You can change the
default refresh interval by clicking File
> Change User Preferences.
Checklist Preview Displays the checklist associated with
Pane the workflow step in a pane at the
bottom of the Response Manager.
When the checklist preview pane is
displayed, the icon changes to .
Save Checklist Saves your changes to the checklist
associated with the workflow step.
List View
The list view displays a list of the workflow steps for the transmittal from which the Response
Manager was launched. All tasks appear here, regardless of the recipient to which the step is
assigned, allowing a document controller to manage responses for email and paper users.
There are several types of steps, called step classes, that may appear in the Response
Manager. The following icons represent these steps:
Icon Step Class Description

Info A step that appears in your Response Manager for your
information only. If an information step appears in your
Response Manager, you are required to acknowledge it.
Assignment A step that assigns work to you. You may be required to
complete a checklist before you can complete an assignment
step.
Approval A step that requires you to vote. You may be required to
complete a checklist before you can complete an approval
step.
Icons with red backgrounds indicate that the step is overdue. For example, if an
assignment step is overdue, the following icon appears beside the step in the Response
Manager: .
Checklist Preview Pane

If you select a workflow step that has a checklist associated with it in the list view, the checklist
preview pane displays the checklist associated with the step. You can update the checklist by
right-clicking the item that you want to change in the checklist. You can also update a checklist
for a step by right-clicking the step in the list view. For the issue step, the checklist includes an
item for each document attached to the transmittal.

Transmittals

 Create an internal transmittal (on page 330)
 Create an external transmittal (on page 332)
 Create an internal transmittal for a set of documents (on page 333)
 Create an external transmittal for a set of documents (on page 334)
 Attach a document to a transmittal (on page 335)
 Assign documents to an issue request (on page 335)
 Export a transmittal (on page 336)
 Copy a transmittal (on page 336)
 Create a transmittal from a template (on page 336)
 Set the planned date for a transmittal (on page 337)
 Update transmittal recipients (on page 337)
 Set the controlling recipient for a transmittal (on page 338)
 Cancel a transmittal (on page 338)
 Terminate a transmittal (on page 338)
 Terminate a transmittal section (on page 338)
 View a transmittal structure (on page 338)
 View a transmittal summary report (on page 339)
 Save a transmittal as a template (on page 339)
 View the transmittal history for a document (on page 339)
 Manage transmittal responses for e-mail and paper users (on page 339)
Create an internal transmittal

1. Click File > New > Internal Transmittal.
The commands available on the File > New menu vary depending on your
configuration and user access.

Transmittals
2. Define details for the new transmittal.

3. Click Next to select a transmittal workflow.
4. Click Finish to create the transmittal.
You can also click Apply to create the transmittal and keep the dialog box open to
create additional transmittals.
5. Right-click the transmittal, then click Create section.
6. Type a Purpose for the section.
The Purpose is used in conjunction with the transmittal name to name the section.
7. Click Finish.
8. Find the documents you want to attach to the transmittal. Drag and drop them onto the
section in the New Items window.
Only signed-off documents can be associated with the transmittal.
New transmittals and sections (for internal transmittals) are added to the New Items
window as you create them. The appropriate workflow step appears in the To Do List.

Transmittals
Create an external transmittal

1. Click File > New > External Transmittal.
The commands available on the File > New menu vary depending on your
configuration and user access.

5. Find the documents you want to attach to the transmittal. Drag and drop the documents on
to the transmittal in the New Items window.
Only signed-off documents can be associated with the transmittal.

Transmittals
Create an internal transmittal for a set of documents

1. Select the documents for which you want to create a transmittal.
2. Right-click and select Transmittals > New Internal Transmittal.
The commands available on the context menu vary depending on your configuration
and user access.
 Conditions can control attachment based on transmittal or section data. For example,
each section could be set up to accept only a certain document type, while the
transmittal could accept documents for only one contract.
attached to internal transmittals with sections are that the document be signed off, that
the documents be related to the transmittal through the intermediate section object, and
that the transmittal section and documents belong to the same configuration.
 Since the document is not related directly to the transmittal by default, the software
creates a default section to which the documents selected in the first step are attached.


Transmittals
Create an external transmittal for a set of documents

1. Select the documents for which you want to create a transmittal.
2. Right-click and select Transmittals > New External Transmittal.
The commands available on the context menu vary depending on your configuration
and user access.
 Conditions can control attachment based on transmittal or section data. For example,
each section could be set up to accept only a certain document type, while the
transmittal could accept documents for only one contract.
attached to external transmittals are that the document be signed-off and that the
document and the transmittal belong to the same configuration.
Options followed by an asterisk (*) are required to create the selected object.

Transmittals
Attach a document to a transmittal

1. In any view, drag the document name onto the name of the transmittal (for external
transmittals), or onto the name of the transmittal section (for internal transmittals).
2. Click OK in the New Relationship dialog box.
 Conditions can control attachment based on transmittal or section data. For example, each
section could be set up to accept only a certain document type, while the transmittal could
accept documents for only one contract.
attached to internal transmittals with sections are are that the document be signed off, that
the documents be related to the transmittal through the intermediate section object, and that
the transmittal section and documents belong to the same configuration.
attached to external transmittals are that the document be signed-off and that the document
and the transmittal belong to the same configuration.
Assign documents to an issue request

1. From the authoring tool, issue a document request.
For more information, refer to the authoring tool documentation for issuing document
requests.
2. Create a transmittal.
Create an internal transmittal (on page 330)
3. Click Find > Organization / Support Items > Contract to find the existing contract to which
you want to attach the documents.
4. Right-click on the contract, and click Show documents to be issued.
5. From the complete list of document revisions that appears, select those you want to attach
to the issue request, and drag and drop them onto the transmittal.

Transmittals
Export a transmittal
As part of the transmittal process, it might be necessary to create a package of the documents
associated with the transmittal. This procedure describes how to create a package that includes
copies of all files related to attached documents, as well as the transmittal report for distribution
to transmittal recipients.
 Right-click on the transmittal, and click Export Transmittal Structure.
 This step is typically performed as part of the Issue workflow task in the transmittal workflow
 Exporting is important for external transmittals where participants might not have access to
the SmartPlant Foundation database through the SmartPlant Foundation Desktop Client.
 By default, the compressed transmittal is exported to C:\temp. After successful export, this
directory should contain a folder for the transmittal, a .zip file of the exported structure, and
the transmittal report in HTML format. The folder contains copies of the electronic files
related to the documents in the transmittal, as pulled from the SmartPlant Foundation vault.
The .zip file contains the same files as the folder and a copy of the transmittal report,
compressed for easier distribution.
Copy a transmittal
1. Right-click the transmittal that you want to copy.
3. In the Copy dialog box, make changes to the attributes for the transmittal you copied.
4. Click Finish.
 Options followed by an asterisk (*) are required.

 You must change the transmittal name for the copied transmittal.
 The newly copied transmittal appears in the New Items window.
 The new transmittal is created with an issue state of RESERVED, and inherits the
following information from the original transmittal: transmittal data, sections, attached
objects, workflow, recipients, reason for receipt, and controlling recipient.
Create a transmittal from a template

1. Right-click the transmittal template you want to use to create a transmittal.
Use Find > Transmittal Templates to display a list of transmittal templates.
3. Define details for the new transmittal, changing the default values as necessary.
 Options followed by an asterisk (*) are required to create the selected object.
 You must provide a new name for the transmittal.

Transmittals
New objects are added to the New Items window as you create them.
Set the planned date for a transmittal

1. Right-click the reserved transmittal, then click Edit > Set planned date.
This option is available when the transmittal is in the RESERVED state.
2. Select a date in the Set Planned Date field.
The planned date is the date by which the transmittal should be completed.
3. Click OK.
Update transmittal recipients

1. Right-click the transmittal.
2. Click Edit > Update Step Recipients on the shortcut menu.
3. If necessary, populate the user list with users or roles.
 If recipients have already been assigned to the workflow to which the transmittal is
attached, these recipients are loaded into the dialog box automatically.
 To search for matrices, click Matrices, select the search criteria, and click OK.
 To search for users, click User, select the search criteria, and click Finish.
 To search for roles, click Role, select the search criteria, and click Finish.
4. To add a user or role to the Assignment or Information only recipient lists, click the
appropriate Add button.
5. Set the Reason for Receipt and Format for each user or role, as necessary.
 Reason for Receipt specifies which action, if any, is required of the user upon receipt
of the transmittal. The default values are I (information), C (comment), and W (work).
 Format specifies the paper size used to send printed documents to users.
 You can use the lists in the Default values section of the dialog box to set the Reason
for Receipt and Format values automatically for newly added users.
6. For users or roles in the Information only recipient list, click the check box beside the user
or role name to specify that a response is required upon transmittal receipt.

Transmittals
7. In the Group assignment control and Group acknowledgement control sections, select
an option from the drop-down list to specify what recipients must respond to the transmittal
workflow steps: all recipients, one per assigned role, or only one per step.
8. Click OK.
Recipients assigned using this command are not stored on the transmittal object, but on
a step in the workflow to which the transmittal is attached.
Set the controlling recipient for a transmittal

1. Right-click the transmittal, then click Edit > Set Controlling Recipient.
2. Select the user name of the controlling recipient.
The controlling recipient cannot be selected until transmittal recipients have been
assigned.
3. Click OK.
Cancel a transmittal
1. Right-click the transmittal, then click Edit > Cancel transmittal.
2. Click OK.
If the transmittal has already been issued when it is cancelled, it is reissued with an issue
state of CANCELLED to all recipients.
Terminate a transmittal
1. Right-click the transmittal you want to terminate.
3. Click Yes to terminate the transmittal.
Terminating a transmittal keeps the transmittal's history in the database.
Terminate a transmittal section

1. Right-click the transmittal section you want to terminate.
3. Click Yes.
Terminating a transmittal section keeps the section's history in the database.
View a transmittal structure

The Expand Structure command shows the transmittal object and all attached documents,
organized by section when applicable.

Transmittals
2. On the shortcut menu, click Edit > Expand Structure. The transmittal structure displays in
the list view.
View a transmittal summary report

2. Click External Transmittal Report or Internal Transmittal Report on the context menu.
 The transmittal report is automatically generated and saved to the vault when the transmittal
moves to the ISSUED state. Transmittal reports are saved in HTML format.
 Transmittal reports can be saved in PDF format.
 You can use the Transmittal Report command to view the transmittal report at any time
during the transmittal workflow, not just when the transmittal has been issued.
Save a transmittal as a template

2. Click Edit > Save as template on the context menu.
3. Click Yes.
 Any transmittal can be saved and used as a template.

 When you save a transmittal as a template, the transmittal workflow is terminated, and the
transmittal issue state changes to TEMPLATE. All section information, relationships to
documents, and workflow setup are locked.
View the transmittal history for a document

1. Right-click the document.
2. On the context menu, click Transmittals > Internal Transmittal History or External
Transmittal History.
Manage transmittal responses for e-mail and paper users

2. On the shortcut menu, click Edit > Response Management.
 This command is available only to transmittal administrators for issued transmittals.

 You can select a single transmittal or multiple transmittals.

Transmittals
The Response Manager displays all issue steps that are ready to run, regardless of which
users have been assigned.
3. Perform the necessary actions for the workflow steps in the Response Manager dialog box.
For example, the user can complete or sign off all steps. The user can also record
comments provided by others, such as email or paper users who do not have access to the
SmartPlant Foundation software.

SECTION 15
Workflows
In SmartPlant Foundation, workflows contain the steps necessary to manage the lifecycle of a
document or object. Each step defines an action that a user or the software must complete.
When a workflow step requires action from a user, that step is presented in the user's To Do List
where the appropriate commands are presented on the shortcut menu. The appearance of the
action in the user's To Do List clearly shows if the step is overdue.
Steps can optionally have a list of checklist items that the user must complete and check off
before the object moves to the next step.
Checklist items can be optional or required, depending on the way the workflow template
was configured.
Any object can be passed through a workflow, but the most typical objects in workflows are
documents, folders, and transmittals.
Learn more about workflows

A workflow is a set of configured steps that are used to model and manage the business
procedures of a customer, such as reviewing and signing off documents, loading published data
in an integrated environment, or issuing documents as part of a transmittal process. The steps
are configured to manage each stage of the process including validation, approval, distribution,
and notification.
These steps can be performed in sequence or in parallel. The workflows branch depending on
the outcome of the voting to specific steps in the same workflow or to other workflows, such as a
generic rejection handling workflow.
Each step in a workflow has a target completion date that is used to perform overdue notification
and workflow expiration.

 Workflow example (on page 342)
 Workflow templates (on page 345)
 Workflow status (on page 345)

Workflows
Workflow example
The following example shows a document going through a document review and sign off
workflow.
Accept Reject Reject

Step Name Description Step Definition Accept Step Status Step Status
Prepare For Submitter to PrepareForReview Approve
Review initially check
the document
Approve Matrix Approve Approve Vote
recipients
review and
approve
Approve Vote Vote on ApprovalVoting Sign Off WF-A Prepare WF-R
previous Revision For
approval step Review
Sign Off Automatically SignOffDocRev Notification WF-C Prepare WF-R
Revision sign off the For
revision Review
Notification Notify the EMailOwner
workflow
recipients of
successful sign
off
1. Create a document and attach the Document Review And Sign Off workflow. The
workflow is shown below.
2. The Prepare For Review step appears in the To Do List of the user assigned to the step.
In this case, the submitter--the person who submitted the document to the
workflow--receives the assignment.

Workflows
3. The user completes the checklist, if present, in the Checklist Preview Pane of the To Do
List, and clicks Save Checklist .
4. When the assignment step is complete, the user right-clicks the step in the To Do
List, clicks Completed, and then types any comments for the step or messages to the
recipient of the next step.
Because there is no reject path defined for this step, the revision moves to the next
step in the workflow even if the user clicks Unable to Complete on the context menu.
5. The Prepare For Review step disappears from the user's To Do List.
6. The Approve step appears in the To Do List for the user assigned to this step in the
workflow, UpdateUser. The user is expected to approve or reject the work done in the
previous step. The user can also reassign the approval step to another user or role.
7. If the user approves the work, the user right-clicks the step in the To Do List, clicks
Approve on the context menu, and then types any comments for the step.
 If the user rejects the work, the user right-clicks the step in the To Do List, clicks Reject
on the context menu, and then types any comments for the step.
 If the user rejects the step, the document revision is rejected back to the first step. In
order to maintain the complete workflow history, the current workflow is terminated at
this point, and the document revision is attached to a second revision of the workflow.
Another Prepare For Review step appears in the To Do List for the person assigned
that step, and the workflow starts again at step 1.

Workflows
 At this point, the workflow might look like the following:
 Step 1 is complete, so it has a green background. The document is at step 2 in the

workflow, so that step has a yellow background, indicating that the step is ready to start.
Steps 3, 4, and 5 are future steps that cannot be started yet, so they have a white
background.
 To display the workflow details, you can right-click the step in the To Do List, and then
click View Workflow.
 You can update workflow steps that have not occurred yet by right-clicking the step and
clicking Update Workflow.
8. The Approve step is removed from the To Do List.
9. When the user approves the document in the Approve step, the Approve Vote step
happens automatically. Because the user approved the step, the workflow status of the
document revision is set to WF-A as described by the success status for the Approve Vote
step.
This example is a very simple approval voting step. More complex approval voting
steps may require that a certain percentage of users approve the document revision before
the Approve Vote step is completed.

Workflows
10. When the software completes the Approve Vote step, the Sign Off Revision step also
automatically occurs.
 Sign off steps are special internal process steps that the software automatically
processes. Sign off steps are valid only on working document revisions.
 The sign off step performs the document sign off, changing the status of the working
document revision to current and the status of the previous current revision to
superseded. For more information, see Document life cycle (on page 155).
11. The Notification step causes an e-mail to be sent to workflow recipients, notifying them that
the document was successfully signed off.
Workflow templates
A workflow administrator creates workflow templates consisting of steps with defined recipients,
which are users, roles, or matrices. These templates are conditionally made available to
manage different classes of object. Shortcut menu commands on objects in the client are used
to associate them with a workflow and then manage the item in that workflow. SmartPlant
Foundation can provide information with the user through e-mail. most workflow communication
to the user is performed in the To Do List.
The workflow template defines the set of steps through which the object in a workflow must
pass. When a copy of a workflow template is attached to an object, the workflow template
definition is copied and used to manage that item. The copied workflow template is referred to
as the instantiated workflow. The instantiated workflow is used to record all the step completion
dates, user comments, and so forth. With valid permissions, a user can modify some of the
details and recipients of steps that have not yet been started without changing the original
template definition. The steps in the template workflow are selected from a library of step
definitions to ensure a consistent look and feel to all workflows. Administrators should refer to
the How to Configure the Workflow Model guide for information about creating and configuring
workflows.
Workflow status
The following workflow step statuses are delivered with SmartPlant Foundation.
Type Description
!WF-C Workflows that are in progress
WF In workflow
WF-A Approved in workflow
WF-C Workflow completed
WF-I Issued in workflow
WF-R Rejected in workflow
WF-V Validated in workflow

Workflows
Working with workflows

Use the following topics to learn how to work with workflows in the SmartPlant Foundation
Desktop Client.
Attach and Edit Workflow dialog box

Allows you to select a workflow to attach and edit the workflow before attaching it to the object.
Name - Displays the workflow name.
Description - Displays a description of the workflow.
Condition - Determines when you can attach an object to the workflow. For example, a
document would have to be working to be submitted to an approval/signoff workflow. In this
case the condition for the workflow would be IsWorking.
No Email Indicator - Indicates if this workflow was configured to suppress e-mail messages
from the workflow.
Attach - Attaches the selected workflow to the document. Depending on your configuration, this
button may not be available to you.
Edit - Displays the Edit Workflow Template dialog box so that you can revise the workflow
before you attach it to the document.
View - Displays the View Workflow dialog box, which displays a graphical representation of the
steps of the workflow.
New or Update Workflow Template dialog box

Allows you to create or update a workflow template. Most of these options are also available on
the Details for Workflow dialog box.
 To create or update a workflow, users must be working in a role associated with the
WorkflowAdmin access group.
 Before creating a new template, create any new step classes, definitions, statuses, check
lists, and reasons for receipt that will be required.
Name - Displays the name for the workflow template.
Description - Displays the description for the workflow template.
Transmittal Workflow - Displays the Issue Step box for specifying recipients for a transmittal
workflow.
No e-mail - Allows you to disable all e-mail notification to the recipients associated with this
workflow.
Reassign to participant - Determines who a step is reassigned to if the workflow is trying to
reject, or cannot reject, a step.
Condition - Determines when you can associate the workflow with an object.
Issue step - Used to identify a step to pre-expand the recipients when the workflow starts. It
allows you to see who the recipients will be before you run a report and is only used in
transmittal workflows on the issue step. This option appears when the Transmittal Workflow
check box is checked.
Find - Populates the drop-down lists for the Reassign to participant and Condition boxes.
Type * or other search criteria in the appropriate search box and click Find to populate the
drop-down list.

Workflows
Auto Order - Allows SmartPlant Foundation to select the best order for the steps. This will take
the first step in the grid and assume it is the first step in the workflow. It will then navigate the
accept steps to find a good order to display the steps. Branches in a parallel workflow are kept
together.
Insert Before - Adds a new step before the current selection.
Insert After - Adds a new step after the current selection.
Remove - Deletes the currently selected step.
View - Displays a graphical representation of the workflow.
Workflow Steps Pane

Name - Is populated automatically when you select a step definition, but can be altered. This
label is displayedas the task name displayed to users in the To Do list.
Description - Displays a description of the step.
Step Definition - Allows you to select a step definition. Click the down arrow to display the list.
Duration - Allows you to type or select the number of days the step should take to complete.
 The new value affects the target date for the next step, which is reflected in the Target Date
column of the user's To Do List.
 When a workflow is attached to an object, the target date becomes read-only. The system
recalculates the target date automatically when the step starts. At that point, the target date
is equal to the step start date plus the step duration.
 Normally, this date is set when the workflow is attached, and compared to the target date to
monitor progress and delays in the workflow.
 A system calendar is used when calculating target dates to ensure that non-working dates
are not included in the calculations. A customizable system calendar is included with the
software, or you can create a new calendar. The workflow feature uses the calendar defined
by the System Administrator in the system options.
Recipients - Allows you to specify the users, roles, or distribution matrices assigned to the step.
Checklist - Allows you to attach a checklist to the step. If the check box is not selected, the
recipient will have the option to complete none, some, or all of the check list items.
Completed - Forces the recipient to complete the checklist before the step can be completed.
Accept Step - Allows you to select the next step to be performed if the current step is
completed successfully.
Accept Status - Allows you to select the status of the workflow object if the step is completed
successfully.
Reject Step - Allows you to select the next step to be performed if the current step is not
completed successfully.
Reject Status - Allows you to select the status of the workflow object if the step is not
completed succesfully.
Displaying Workflow for <Object Name> dialog box

Graphically displays the current workflow for the selected object. You can change the display
colors for each step status by clicking the colored square beside the step status.
Properties - Configures the properties displayed in each step.

Workflows
Back - Displays the preceding revision of the workflow. This option is available only if the
document has multiple revisions of the workflow, if a step failed or was rejected in a previous
revision.
Next - Displays the next revision of the workflow. This option is available only if the document
has multiple revisions of the workflow, if a step failed or was rejected in a previous revision.
following
Properties to Display dialog box

Allows you to add and remove step properties displayed in the View Workflow dialog box, and
determine the size of the workflow step boxes.
Arrange Properties - Shows the current arrangement of properties on the workflow step boxes.
Step Width - Specifies the width of the step box.
Number of Lines - Specifies the number of lines inside the step box.
Column set - Specifies the column set to be used for the display. The column set determines
which properties of the step display on the workflow step boxes.
Display Property Name - Allows you to specify whether or not you want to display the name of
the step property in the workflow step box, as a label along with the property value.
Defaults - Restores the default properties for the step box, removing any changes you have
made.

 Attach a workflow (on page 349)
 Delete an attached workflow (on page 349)
 Put an attached workflow on hold (on page 349)
 Take an attached workflow off hold (on page 350)
 Reject an attached workflow (on page 350)
 Terminate an attached workflow (on page 350)
 Update a workflow (on page 352)
 Manage responses to workflow steps for users (on page 351)
 View a workflow (on page 352)
 Update a workflow (on page 352)
 Update users in the Assignment list (on page 355)
 View a workflow details report for a document (on page 357)
 View workflow details for a document (on page 357)
 View workflow history for a document (on page 357)
 View a report of overdue workflow steps (on page 357)

Workflows
Attach a workflow
1. Right-click the object to which you want to attach a workflow.
2. Click Workflow > Attach and Edit Workflow or Workflow > Attach Workflow.
3. In the Attach and Edit Workflow dialog box, select the workflow that you want to attach,
and click Attach.
 Depending on your configuration and user role, you may not be able to attach workflows
to objects. For more information, contact your system administrator.
 If you selected Attach and Edit Workflow, the Edit button is enabled and allows you to
edit the workflow, if necessary, before you attach it. See Update a workflow (on page
352) for more information about updating workflows.
 To view a graphical representation of the workflow, click View. See View a Workflow (on
page 352) for more tips about viewing workflows.
 Recipients begin receiving notification in their To Do Lists of tasks to be completed
immediately upon attaching the workflow. If the workflow is configured to send e-mail to
recipients when tasks reach their To Do Lists, e-mail also notifies users of tasks to be
completed in their To Do Lists.
After you attach a workflow to an object, the commands on the Workflow submenu
change for that document.
Delete an attached workflow

1. Right-click the object for which you want to delete the workflow.
2. Click Workflow > Delete Workflow.
3. Click Yes.
The software performs the following tasks when you delete a workflow:
 Removes the selected object from the workflow.
 Discards all the workflow history for this object in this workflow.
 Clears the object's workflow status.
 Removes all remaining steps from the To Do List for all users.
Put an attached workflow on hold

The Put Workflow on Hold command allows you to temporarily stop an item wherever it is in its
defined workflow. When you put a workflow step on hold, you remove it from the To Do List and
from the defined workflow.
1. Right-click the object for which you want to stop the workflow.
2. Click Workflow > Put Workflow on Hold.
3. Click Yes.
The software removes all remaining steps from the To Do List for all users.

Workflows
Take an attached workflow off hold

The Take Workflow off Hold command allows you to restart the workflow process for an item
that was stopped with the Put Workflow on Hold command.
1. Right-click the object for which you want to restart the workflow.
2. Click Workflow > Take Workflow Off Hold.
3. Click Yes.
The software adds the remaining steps back to the To Do List for all users.
Reject an attached workflow

1. Right-click the object for which you want to reject the workflow.
2. Click Workflow > Reject Workflow.
3. Click Yes.
4. Type any comments in the Enter comments box, and click OK.
The software performs the following tasks when does reject a workflow:
 Maintains the workflow history for the object.
 Sets all uncompleted steps in the workflow for the selected object to rejected.
 Sets the object's workflow status to completed.
Terminate an attached workflow

The Terminate Workflow command terminates the relationship between an object and the
workflow attached to it. Neither the object nor the workflow template are terminated, but the
object is no longer attached the workflow. The workflow history records that the workflow was
terminated and the point at which it was terminated. All historical information regarding any
steps already processed prior to termination is saved in the database and available for viewing.
1. Right-click the object for which you want to terminate the workflow.
2. Click Workflow > Terminate Workflow.
3. Click Yes.
4. Type any comments in the Enter comments box, and click OK.
The software does the following tasks when you delete a workflow:
 Maintains the workflow history for the object.
 Terminates all uncompleted steps in the workflow.
 Sets the object's workflow status to completed.

Workflows
Manage responses to workflow steps for users

The Response Manager windows allows the document controller to perform workflow steps for
e-mail and paper users who do not have access to SmartPlant Foundation. The Response
Manager window behaves identically to the To Do List.
In the Response Manager window, you can view and complete checklists associated with
workflow steps. You can also complete voting steps and mark other steps completed or unable
to complete to update them.
1. Right-click the objects (transmittals or documents) that are attached to a workflow.
You can select a single object or multiple objects.
2. On the shortcut menu, click Workflow > Response Management.
The Response Manager window displays all workflow steps that are ready to run and to
which all users have been assigned.
3. Perform the necessary actions for the workflow steps in the Response Manager dialog box.
For example, the user can complete or sign off all steps.

Workflows
View a workflow
1. Right-click the object for which you want to view the workflow.
2. Click Workflow > View Workflow on the context menu.
 You can use the Back and Next buttons to move through different revisions of the workflow,
if they exist.
 The following colors indicate workflow states:
 Yellow - The workflow step is ready to begin.
 White - The workflow step is not ready to begin yet.
 Green - The step has been signed off.
 Pink - The step has been rejected.
 Blue - The step has been terminated.
 You can click the color boxes at the bottom of the dialog box to change the display colors for
the workflow states. These changes are saved in your user profile when you exit SmartPlant
Foundation.
Update a workflow
1. Right-click the object for which you want to update the workflow, and click Workflow >
Update Workflow.
2. Make the necessary workflow changes on the Update Workflow dialog box.
 The workflow is based on a predefined template set up by the workflow administrator.

Changes that you make to the current, or created, workflow do not affect the workflow
template.
 You can make updates to the workflow with the following exceptions:
 It is not possible to alter the transmittal issue step on an instantiated workflow.

Workflows
 It is not possible to change a step that has already started.

 The procedures below describe the kinds of updates that are possible using the Update
Workflow dialog box. However, the functionality available to you depends on your role
assignment and user permissions within a project as defined by your system
administrator.
Reassign a workflow step

1. To display the Reassign to participant list, type * or other suitable search criteria in the
Reassign to Participant search box, and click Find.
2. Click and select the participant from the list.
Disable e-mail for the workflow

 To disable e-mail notifications to the recipients associated with this workflow, select the No
E-mail check box.
Add a workflow step

1. To create a new step, select a step and click Insert Before or Insert After. A new row is
displayed in the step list.
2. Select a value from the Step Definition list. The Name box is populated automatically with
the step name. You can edit the name value if necessary.
3. Complete the properties for the new step as necessary using the procedures below.
Change the name or description of a step

 To change the name of the selected workflow step, click in the Name box and type a new
name.
 To change the description of the selected workflow step, click in the Description box and
type a new description.
Update checklist
Administrators can create checklists for step definitions. If the step definition for the step
you are updating has no associated checklists, the Checklist box is not available. If you are a
system administrator, see Step Checklist Configuration in the How to Configure the Workflow
Model guide for information about creating checklists.
1. If the step definition for the new step has an associated checklist, click beside the
Checklist box and select a checklist from the list.
2. To enforce the completion of a checklist before the step can be signed off, select the
Completed checkbox.
Set workflow accept and reject steps

1. To change the accept step (the next step if the current step completes successfully), click
beside the Accept Step box, and use the Select Accept Steps dialog box to add or
remove an accept step.
 The accept step for the current step cannot be changed.

 You can use the Find button on the Select Accept Steps dialog box to find steps in
other workflows.

Workflows
2. To set the accept status (that is, the status of the workflow object if the step is completed
successfully), click beside the Accept Status box, and select the status from the list.
3. To change the reject step (the next step if the current step is rejected or is not completed
successfully), click beside the Reject Step box, and use the Select Reject Step dialog
box to add or remove a reject step.
 The reject step for the current step cannot be changed.

 You can use the Find command on the Select Reject Steps dialog box to find steps in
other workflows.
4. To set the reject status (the status of the workflow object if the step is rejected or is not
complete successfully), click beside the Reject Status box, and select the status from
the list.
Change the arrangement of the steps

 To change the display order of the steps, select a step and use the up and down arrows to
move the step up or down in the list. This action changes the display order only. The
sequence of the workflow is determined by the accept and reject step boxes.
You can also use Auto Order to have SmartPlant Foundation select the best order.
This feature takes the first step in the table and assumes it is the first step in the workflow.
The software navigates through the accept steps to find a good order in which to display the
steps. Provisions have been made to keep a branch in a parallel workflow together.
Change the step definition

To change the step definition, click the down arrow in the Step Definition box, and select a new
definition from the list.
Change the duration for a workflow step

 In the Duration box, type or select the number of days the step should take to complete.
 The new value affects the target date for the next step, which is reflected in the Target
Date column of the user's To Do List. See Change the duration for a workflow step (on
page 370) for more information about target dates.
 When a workflow is attached to an object, the target date becomes read-only. The
software recalculates the target date automatically when the step starts. At that point,
the target date is equal to the step start date plus the step duration.
 Normally, this date is set when the workflow is attached, and compared to the target
date to monitor progress and delays in the workflow.
 A system calendar is used when calculating target dates . You must ensure non-working
dates are not included in the calculations. A customizable system calendar is included
with the software, and you can also create a new calendar. The calendar used by the
workflow feature is defined by the System Administrator on the SPF System Options
dialog box.

Workflows
Update users in the Assignment list

Update recipients for a workflow step
The Update Step Recipients dialog box allows you to update the recipients for a workflow step.
Recipients may be users, roles, or matrices.
To update the recipients for a workflow step, click beside the Recipients box in the Update
Workflow Template dialog box.
To add users to the assignment list:
1. Click Users in the Update Step Recipients dialog box.
2. Enter the search criteria in the for Users dialog box.
3. Click Finish.
The list of users is displayed in a tree view on the upper left pane of the Update Step
Recipients dialog box.
4. Select one or more users from the left pane in the Update Step Recipients dialog box.
5. Click Add.
The user is added to the assignment list.
To remove users from the assignment list:
 Select the user from the Assignment list, and click Remove.
Alternatively, you can click Role to update the Assignment list.
 You can also select a recipient in the left pane and drag it to the assignment pane.
 You can use the CTRL key to select multiple users from the tree view.
 If the associated step is information only, then you will not be able to populate the
assignment set.
Update users in the Information Only list

To add a recipient to the Information only list, select one or more user or role in the tree view,
and click Add.
To remove the users from the Information Only list, select the user or role from the
Information Only list, and click Remove.
You can select multiple recipients in the left pane, then drag and drop the recipients into
the Information Only pane to add them to the list.
 The Information only columns are the same as the Assignment columns except that the
User or Role name has a response option.
 If you do not want the user to acknowledge the information step, clear the option beside the
recipient name.
 The response option is selected by default when you add a recipient to the information only
list.
Update the Matrices in list

1. Click Matrices.
The Find Matrices dialog box appears.
2. Enter the search criteria and click OK.

Workflows
The matrices appear in a tree view on the lower left pane in the Update Step Recipients
dialog box.
3. In the Update Step Recipients dialog box, select matrices in the tree view.
4. Click Add.
To remove the matrices from the list, select one or more matrices from the list and click
Remove.
You can select one or more matrices in the left pane, then drag and drop the matrices into
the Matrices pane to add them to the list.
Set the default values

You can use the lists in the bottom left of the dialog box to set the default values.
 Default format - Specifies the default print format of the document for users who receive
physical documents.
 Default action reason for receipt - Specifies the actions required from the user or role.
 Default information reason for receipt - Specifies the reason of receipt for that user.
Update the group controls

If a role is assigned to a step as information only, select any one of the options in the Group
acknowledgment control.
 One user per step - Only one user can acknowledge receipt of the step. Any assigned
user can acknowledge receipt to proceed to the next step in the workflow.
 One user per role - Any of the assignees in each role can acknowledge receipt.
 All recipients - All assignees must acknowledge receipt to proceed to the next step in
the workflow.
If one of the assignment recipients is a role, select options in the Group assignment
control.
 One user per step - Only one user can perform the step task. If one user among all the
assigned users completes the task, then the workflow can proceed to the next step.
 One user per role - Any one of the assignees in each role can perform the task, but
they must first claim it in order to prevent other recipients from duplicating the work.
 All recipients - All assignees must perform the task to proceed to the next step in the
workflow.
For more information, see Update Step Recipients Form (on page 71) in the How to Configure
the Workflow Model.

Workflows
View a workflow details report for a document

1. Right-click the document master or revision for which you want to generate a workflow
details report.
2. Click Workflow > Workflow Details Report.
View workflow details for a document

1. Right-click the document master or revision for which you want to view workflow details.
2. Click Workflow > Workflow Details.
3. To view the workflow steps in the graphical viewer, click View.
The editing options on this dialog box and on any dialog boxes accessible from it are
disabled when you use this command.
View workflow history for a document

1. Right-click the document master or revision for which you want to view workflow history.
2. Click Workflow > Workflow History.
3. To view a graphical display of the workflow, select the workflow in the Workflow History
dialog box, and click View.
View a report of overdue workflow steps

1. Right-click the document master or revision for which you want to view overdue workflow
steps.
2. Click Workflow > Workflow Overdue Steps Report.
The results appear in the Desktop Client list view.
You can run the same report from the All Overdue Steps Report command. Click File >
All Overdue Steps Report. The results are displayed in a new Internet Explorer browser
window.

Workflows

SECTION 16
To Do List
In SmartPlant Foundation, the To Do List provides a place for you to view all workflow steps
that have been assigned to you and their statuses. For example, when a workflow is attached to
a SmartPlant Foundation object and your user name or role is assigned to a particular step in
the workflow, the workflow step appears in your To Do List. Virtually all of your interaction with
workflows in the Desktop Client occurs in the To Do List.
Depending on your SmartPlant Foundation configuration, the To Do List may be
called the Inbox in the Desktop Client.
In the To Do List, you can view and complete checklists associated with workflow steps,
complete voting steps, and update steps as completed or unable to complete.
was configured.
To Do List window
Allows you to view all workflow steps that have been assigned to you and their statuses.
The To Do List window has several parts:

 Toolbar
 List View
 Checklist Preview Pane
Toolbar
The To Do List toolbar contains the following buttons:

Refresh Refreshes the To Do List with new tasks assigned to you.
By default, the software automatically refreshes the To Do
List every 10 minutes if the value is not changed through
user preferences. However, you can force a manual
update on the To Do List data using the Refresh button.

To Do List
You can change the default refresh interval on the

Change User Preferences dialog box, available by
clicking File > Change User Preferences.
Checklist Preview Pane Displays the checklist associated with the workflow step in
a pane at the bottom of the To Do List. This command
turns the preview pane on and off.
Save Checklist Saves your changes to the checklist associated with the
workflow step.
Configuration Filtering Filters the To Do List so that it contains only items in your
current scope.
Show Workflow Objects Displays related items, such as transmittals or documents.
List View
The columns that appear in the list view are determined by your configuration. Your system
administrator defines which columns display by default.
The list view displays a list of all workflow steps assigned to you. There are several types of
steps, called step classes, that may appear in the To Do List. The following icons represent
these step classes:
Icon Step Class Description

Info A step that appears in your To Do List for your information
only. If an information step appears in your To Do List, you
are required to acknowledge it.
Assignment A step that assigns work to you. You may be required to
complete a checklist before you can complete an
assignment step.
Approval A step that requires your approval. You may be required to
complete a checklist before you can complete an approval
step.
Icons with red backgrounds indicate that the step is overdue. For example, if an
assignment step is overdue, the following icon appears beside the step in the To Do List: .
Checklist Preview Pane

If you select a workflow step in the list view that has a checklist associated with it, the checklist
preview pane displays the checklist associated with the step.
 Checklists can contain no more than 25 items.

 Some of the column headings described here are configurable. Your system administrator
defines which columns display by default.
List View - Displays a list of all workflow steps assigned to you.
Name - Displays the name of the step.
Description - Displays a description of the step.
Recipient Role - Displays the SmartPlant Foundation role of the recipient. Recipients can play
numerous roles in a configuration. If a role is assigned to a workflow step, users know what role
to play when taking action on the workflow step.

To Do List
Workflow - Displays the name of the workflow to which the step is assigned.
RFR - Displays the reason for receipt value, or why the user has been assigned the workflow
step. The default values are I (information), C (comment), and W (work).
Target Date - Displays a target date for when the step is completed based on the assignment
date and the defined duration.
Related Object - Displays the object to which the workflow is attached, typically a document or
transmittal.
Password Required - Indicates if the user's password is required to sign off the step.
Message - Displays the message entered by the recipient of the previous step; this message
could be some comments or instructions.
Checklist Preview Pane - Displays the checklist associated with the step, if one exists. You can
update the checklist by clicking the item that you want to change in the checklist, and modifying
the information in the grid.
was configured.
Description - Displays a description of each checklist step.
Value - Allows you to type a value that indicates the completion of the item.
Comments - Allows you to type text about the checklist step.
Allocated To - Allows you to save additional information about the checklist item, such as the
user to which the item was allocated.
<Step Type> Task dialog box

Allows you to type comments for a workflow step that has just been completed, successfully or
not successfully.
Step description - Displays the description of the step that just completed.
Comments - Allows you to type comments about the completion of a step. The software saves
information from the Enter Comments box with the object in the database and includes the
information in an email sent to the recipients of the next step.
Message to next step - Allows you to enter a message for the following step. Information
entered in the Message to next step is included in the e-mail message sent to the next
recipient and saved in the database.
Reassign dialog box

Allows you to reassign a workflow step to another SmartPlant Foundation user or role. You
cannot reassign it to both.
Select user - From the list box, select the user to whom you want to assign the workflow step.
Select role - From the list box, select the role to which you want to assign the workflow step.
Update Step Description dialog box

Allows you to make changes to the description of a workflow step.

To Do List
Current Step Description - Displays the current description for the selected step. This option is
for display only.
New Step Description - Enter the new description for the selected step.
Update Step Duration dialog box

Allows you to make changes to the duration and target and planned dates for a workflow step.
Enter new duration - Type the number of days the step should now take to complete. Changing
the duration updates the target dates for this and future steps. The planned date remains the
same. If there are parallel steps, changes to the duration are based on the longest duration.
Target date - Displays the target date for the step. Changing the planned date must be done
manually; it is independent of the other dates. Changing the target date on this dialog box
updates only that property of the the step; the duration of this step and dates for other steps are
not updated.
Planned date - Displays the planned date for the step. This value can be edited manually, but
will not be updated as a result of other changes in the dialog box.

 Show or hide the To Do List (on page 363)
 Refresh the To Do List (on page 363)
 Set the refresh interval for the To Do List (on page 363)
 Show items related to a workflow step (on page 363)
 Show or hide the checklist preview pane in the To Do List (on page 364)
 Update the checklist for a workflow step (on page 364)
 Acknowledge an information step (on page 365)
 Claim a step in a workflow (on page 365)
 Complete a step in a workflow (on page 366)
 Indicate a step cannot be completed (on page 367)
 Approve a step in a workflow (on page 368)
 Reject a step in a workflow (on page 369)
 Reassign a step to another user or role (on page 369)
 Update the description for a workflow step (on page 370)
 Change the duration for a workflow step (on page 370)
 Update workflow (on page 371)
 Update users in the Assignment list (on page 355)
 View relationship objects (on page 373)
 View workflow (on page 373)
 View workflow details (on page 374)

To Do List
Show or hide the To Do List

The To Do List command displays the To Do List, allowing you to view the workflow steps
that have been assigned to you. If the To Do List is already displayed, this command closes the
list.
 On the Desktop Client toolbar, click To Do List .
You can also display and hide the To Do List by clicking View > To Do List.
Refresh the To Do List

The Refresh To Do List command updates the To Do List with your current workflow step
information.
The To Do List refreshes automatically using the interval set in the User Preference
dialog box. To set the refresh interval for the To Do List, click File > Change User
Preferences.
 In the To Do List window, click Refresh To Do List .
If your To Do List is not displayed, click To Do List on the Desktop Client toolbar.
Set the refresh interval for the To Do List

2. Click the General tab.
3. In the To Do List refresh interval in minutes box, type how often, in minutes, you want the
software to update your To Do List.
By default, the refresh interval is set to 10 minutes.
Show items related to a workflow step

1. In the To Do List, select the step for which you want to see the related workflow items.
 If your To Do List is not displayed, click To Do List on the Desktop Client toolbar.
 You can use CTRL+click or SHIFT+click to select multiple steps and view their related
items.
2. Click Show Workflow Objects.
The related workflow items, such as documents or transmittals including their related
documents, appear in the list view.
Show Related Items in a Workflow Across Multiple Plant Configurations

You can see related items for a workflow step across multiple plant configurations.
Your user preferences should be set to display different windows for each configuration.
See Display objects in a separate window by configuration (on page 91).
1. Click File > Set Active Scope.

To Do List
2. In the Query scope list, check the box beside the configurations for which you want to
search for objects.
3. In the Create scope list, check Scope Not Set.
4. In the To Do List, select multiple steps, and then click Show Workflow Objects.
Documents or other items related to a workflow are displayed in separate windows by
configuration.
Show or hide the checklist preview pane in the To Do

List
1. To display the checklist preview pane, click Checklist Preview Pane in the To Do List
window.
2. To hide the checklist preview pane, click Checklist Preview Pane again.
This setting is saved in your user profile. If you exit SmartPlant Foundation with the
checklist preview pane displayed, it will display when you next log on.
Update the checklist for a workflow step

1. In the To Do List, select the step for which you want to update the checklist.
2. Click Checklist Preview Pane to display the checklist in the checklist preview pane.
If the checklist preview pane is already displayed, the checklist associated with the
step appears in the checklist preview pane when you select the step.
3. Click and type in the appropriate checklist boxes to complete the checklist, providing
information about the completion of the checklist item and additional notes to be saved in
the database.
4. Click Save Checklist .
After you complete the checklist, you can approve or complete the workflow step.
was configured.

To Do List
Acknowledge an information step

1. In the To Do List, right-click the information step that you want to acknowledge.
 You can use CTRL+click or SHIFT+click to select multiple steps of the same step class.
2. If the step requires a password, type your user name and password, and then click OK.
3. Click Acknowledge on the shortcut menu.
Your system administrator might configure a checklist that requires you to complete
the checklist before you can acknowledge the step.
 If the checklist does not require completion, you have the option to complete some,
none, or all of the checklist items. When you click Acknowledge, the software prompts
you to continue without completing the checklist. Click Yes to complete the step.
 If the checklist requires completion, and if you have not completed all checklist items
when you click Acknowledge, the software prompts you to complete and save the
checklist before signing off on the step. See Update the checklist for a workflow step (on
page 364) for more information about completing checklists.
4. Type any comments and messages to the next recipient in the SignOffStep Task box.
 Information entered in the Comments box is saved with the object in the database and
may be included in the email to the next recipient depending on how the step was
configured.
 Information entered in the Message to next step box is displayed on the next step in
the To Do List as a message from the previous step, is included in the email sent to the
recipient of the next step, and is saved in the database for archival purposes.
5. Click OK. The software automatically removes the step from your To Do List, and the
workflow continues to the next step.
Claim a step in a workflow

This option is available when a workflow step has multiple recipients.
1. In the To Do List, select the step or steps that you want to claim.
 Steps can be set up so that one user responds for all recipients or so that one user
responds per role. If the step is set up either of these ways, you must claim the step
before continuing.
 You can use CTRL+click or SHIFT+click to select multiple steps of the same class.
2. Right-click the selected step or steps.
3. Click Claim on the shortcut menu.
4. Click Yes to claim the step.
5. Type any comments in the Enter comments box, and then click OK.

To Do List
When you claim a step, the Claim command disappears from the shortcut menu for the
step in your To Do List, and the step disappears from the To Do Lists of other users.
 After you claim a step, you can complete the action required by the step.
 In a parallel workflow, you can claim a single step, instead of all parallel steps, if that single
step has a role assigned to it. This situation applies if the step is set up for claim by role.
Complete a step in a workflow

The Completed command allows you to mark the selected workflow step as completed. This
command is available when you right-click a workflow step in the To Do List.
1. In the To Do List, select the step or steps that you want to complete.
3. If there is a checklist associated with the step, click Checklist Preview Pane on the To
Do List toolbar to display the checklist.
4. Complete the checklist.
The completion of the checklist items may be optional or required depending on how
the workflow template was configured. Your system administrator might configure a
checklist that requires you to complete the checklist before you can approve the step.
5. Right-click the step that you want to complete.
6. Click Completed on the shortcut menu.
none, or all of the checklist items. When you click Completed, the software prompts you
to continue without completing the checklist. Click Yes to complete the step.
when you click Completed, the software prompts you to complete and save the
checklist before signing off on the step. See Update the checklist for a workflow step (on
page 364) for more information about completing checklists.
configured.
8. Click OK. The software automatically removes the step from your To Do List, and the object
moves to the Accept Step defined for this step in the workflow.
When you complete a workflow step, target dates are updated for downstream steps that
are in the Ready to Start status.

To Do List
If you are signing off multiple workflow steps one after the other in your SmartPlant
Foundation To Do List, an administrator can increase the Timeout duration for signoff time by
updating your SmartPlant Foundation user settings. This increases the number of minutes
before you have to re-type your password. The default signoff time is set to zero so the user
must enter a password for all steps that require them. This setting helps prevent unauthorized
users from signing off steps that require a password if a user inadvertently leaves the To Do List
running.
Indicate a step cannot be completed

The Unable to Complete command allows you to indicate that you cannot complete the
selected workflow step. This command is available when you right-click a workflow step in the
To Do List.
1. In the To Do List, right-click the step that you are unable to complete.
2. If the step requires a password, type your username and password, and then click OK.
3. Click Unable to Complete on the shortcut menu.
the checklist before you can sign off the step.
none, or all of the checklist items. When you click Unable to Complete, the software
prompts you to continue without completing the checklist. Click Yes to complete the
step.
when you click Unable to Complete, the software prompts you to complete and save
the checklist before signing off on the step. See Update the checklist for a workflow step
(on page 364) for more information about completing checklists.
4. Type any comments and messages to the next recipient in the Rejectstep Task box.
configured.
5. Click OK. The software automatically removes the step from your To Do List, and the step
moves through the defined rejection path, which can be another workflow or another step in
the same workflow.

To Do List
Approve a step in a workflow

The Approve command allows you to approve the selected workflow step. This command is
available when you right-click a workflow step in the To Do List.
1. In the To Do List, select the step or steps that you want to approve.
3. If there is a checklist associated with the step, click Checklist Preview Pane to display
the checklist.
4. Complete the checklist.
The completion of the checklist items may be optional or required depending on how
the workflow template was configured. Your system administrator might configure a
checklist that requires you to complete the checklist before you can approve the step.
5. Right-click the step that you want to approve.
6. Click Approve on the shortcut menu.
none, or all of the checklist items. When you click Approve, the software prompts you to
continue without completing the checklist. Click Yes to approve the step.
when you click Approve, the software prompts you to complete and save the checklist
before signing off on the step. See Update the checklist for a workflow step (on page
364) for more information about completing checklists.
configured.

To Do List
Reject a step in a workflow

The Reject command allows you to reject the selected workflow step. This command is
available when you right-click a workflow step in the To Do List.
1. In the To Do List, right-click the step that you want to reject.
3. Click Reject on the shortcut menu.
the checklist before you can reject the step.
none, or all of the checklist items. When you click Reject, the software prompts you to
continue without completing the checklist. Click Yes to reject the step.
when you click Reject, the software prompts you to complete and save the checklist
before signing off on the step. See Update the checklist for a workflow step (on page
364) for more information about completing checklists.
4. Type any comments and messages to the next recipient in the Rejectstep Task box.
configured.
Reassign a step to another user or role

The Reassign command allows you to assign the selected workflow step to a different user or
role. You cannot reassign it to both a user and a role. This command is available when you
right-click a workflow step in the To Do List.
1. In the To Do List, right-click the step that you want to reassign.
2. Click Reassign on the shortcut menu.
3. In the Reassign dialog box, select the user or role to which you want to reassign the step.
You cannot assign it to both.
4. Click OK. The software removes the reassigned step from your To Do List, and the step
appears in the To Do List of the user or users to whom you assigned the step.

To Do List
Update the description for a workflow step

The Update Step Description command allows you to change the description of the selected
workflow step. This command is available when you right-click a workflow step in the To Do
List.
1. Right-click the workflow step for which you want to update the description.
 You can modify workflow steps in the Edit Workflow Template dialog box when you
attach a workflow. Right-click the document to which you want to attach a workflow, and
then click Workflow > Attach and Edit Workflow. Click Edit in the Attach and Edit
Workflow dialog box.
 You can also modify workflow steps in the Update Workflow dialog box. Right-click the
document for which you want to update a workflow, and then click Workflow > Update
Workflow.
 You can only modify workflow steps that have not already started.
2. Click Update Step Description on the shortcut menu.
3. Type a new description for the step.

The Update Step Duration command allows you to alter the target date of the selected step.
This command is available when you right-click a workflow step in the list view.
1. Right-click the workflow step for which you want to update the duration.
 You can modify workflow steps in the Edit Workflow Template dialog box when you
attach a workflow. Right-click the document to which you want to attach a workflow, and
then click Workflow > Attach and Edit Workflow. Click Edit from the Attach and Edit
Workflow dialog box.
 You can also modify workflow steps in the Update Workflow dialog box. Right-click the
document for which you want to update a workflow, and click Workflow > Update
Workflow.
2. Click Update Step Duration on the shortcut menu.
3. Type the new duration for the step in days.
4. Use the buttons to select the Target date and Planned date values from the calendar.
 The Target date value is set and recalculated by the software and equals the start date
of the step plus the step duration. This date is the date when overdue management and
step expiration are initiated.
 The Planned date is not recalculated automatically when the duration is changed.
However, you can modify either date manually from the Update Step Duration dialog
box.
 The Planned date value can be used within reports to plan work.

To Do List
Update workflow
The Update Workflow command allows you to edit the copy of the workflow template attached
to a specific document. It is available by right-clicking a step in the To Do List or right-clicking a
document currently in a workflow.
1. Right-click the step in the To Do List, and click Update Workflow.
2. Make the necessary workflow changes on the Update Workflow dialog box.
 The workflow is based on a predefined template set up by the workflow administrator.

Changes that you make to the current, or created, workflow do not affect the workflow
template.
 You can make updates to the workflow with the following exceptions:
 It is not possible to alter the transmittal issue step on an instantiated workflow.
 It is not possible to change a step that has already started.
 The procedures below describe the kinds of updates that are possible using the Update
Workflow dialog box. However, the functionality available to you depends on your role
assignment and user permissions within a project as defined by your system
administrator.
Reassign a workflow step

1. To display the Reassign to participant list, type * or other suitable search criteria in the
Reassign to Participant search box, and click Find.
2. Click and select the participant from the list.
Disable e-mail for the workflow

 To disable e-mail notifications to the recipients associated with this workflow, select the No
E-mail check box.

To Do List
Add a workflow step

1. To create a new step, select a step and click Insert Before or Insert After. A new row is
displayed in the step list.
2. Select a value from the Step Definition list. The Name box is populated automatically with
the step name. You can edit the name value if necessary.
3. Complete the properties for the new step as necessary using the procedures below.
Change the name or description of a step

 To change the name of the selected workflow step, click in the Name box and type a new
name.
 To change the description of the selected workflow step, click in the Description box and
type a new description.
Update checklist
Administrators can create checklists for step definitions. If the step definition for the step
you are updating has no associated checklists, the Checklist box is not available. If you are a
system administrator, see Step Checklist Configuration in the How to Configure the Workflow
Model guide for information about creating checklists.
1. If the step definition for the new step has an associated checklist, click beside the
Checklist box and select a checklist from the list.
2. To enforce the completion of a checklist before the step can be signed off, select the
Completed checkbox.
Set workflow accept and reject steps

1. To change the accept step (the next step if the current step completes successfully), click
beside the Accept Step box, and use the Select Accept Steps dialog box to add or
remove an accept step.
 The accept step for the current step cannot be changed.

 You can use the Find button on the Select Accept Steps dialog box to find steps in
other workflows.
2. To set the accept status (that is, the status of the workflow object if the step is completed
successfully), click beside the Accept Status box, and select the status from the list.
3. To change the reject step (the next step if the current step is rejected or is not completed
successfully), click beside the Reject Step box, and use the Select Reject Step dialog
box to add or remove a reject step.
 The reject step for the current step cannot be changed.

 You can use the Find command on the Select Reject Steps dialog box to find steps in
other workflows.
4. To set the reject status (the status of the workflow object if the step is rejected or is not
complete successfully), click beside the Reject Status box, and select the status from
the list.

To Do List
Change the arrangement of the steps

 To change the display order of the steps, select a step and use the up and down arrows to
move the step up or down in the list. This action changes the display order only. The
sequence of the workflow is determined by the accept and reject step boxes.
You can also use Auto Order to have SmartPlant Foundation select the best order.
This feature takes the first step in the table and assumes it is the first step in the workflow.
The software navigates through the accept steps to find a good order in which to display the
steps. Provisions have been made to keep a branch in a parallel workflow together.
Change the step definition

To change the step definition, click the down arrow in the Step Definition box, and select a new
definition from the list.

 In the Duration box, type or select the number of days the step should take to complete.
 The new value affects the target date for the next step, which is reflected in the Target
Date column of the user's To Do List. See Change the duration for a workflow step (on
page 370) for more information about target dates.
 When a workflow is attached to an object, the target date becomes read-only. The
software recalculates the target date automatically when the step starts. At that point,
the target date is equal to the step start date plus the step duration.
 Normally, this date is set when the workflow is attached, and compared to the target
date to monitor progress and delays in the workflow.
 A system calendar is used when calculating target dates . You must ensure non-working
dates are not included in the calculations. A customizable system calendar is included
with the software, and you can also create a new calendar. The calendar used by the
workflow feature is defined by the System Administrator on the SPF System Options
dialog box.
View relationship objects

 Right-click the step in the To Do List, and click View Relationship Objects on the shortcut
menu.
View workflow
The View Workflow command allows you to display the workflow attached to the step in the To
Do list.
1. In the To Do List, right-click the step for which you want to view the workflow.
2. Click View Workflow on the shortcut menu.
 You can use the Back and Next buttons to move through different revisions of the workflow,
if they exist.
 The following colors indicate workflow states:
 Yellow - The workflow step is ready to begin.

To Do List
 White - The workflow step is not ready to begin yet.

 Green - The step has been signed off.
 Pink - The step has been rejected.
 Blue - The step has been terminated.
 You can click the color boxes at the bottom of the dialog box to change the display colors for
the workflow states. These changes are saved in your user profile when you exit SmartPlant
Foundation.
View workflow details

1. In the To Do List, right-click the step for which you want to view workflow details.
2. Click Workflow Details on the shortcut menu.
3. To view the workflow steps in the graphical viewer, click View.
The editing options on this dialog box and on any dialog boxes accessible from it are
not available when you use this command.

SECTION 17
Schedulers and Queue Management

When documents are published to SmartPlant Foundation, the documents must be processed
by the Scheduler and Loader before any data in the published documents is available for use.
SmartPlant Foundation uses a scheduler to queue and process tasks at a central location and
allows you to manage the tasks in the queue and view statuses of tasks.
You can check the status of documents already submitted to the Scheduler through Query for
Scheduled Tasks . Query for Scheduled Tasks allows you to find and view tasks based
on specified criteria, which helps you limit the information displayed.
Once a document has been scheduled, you can view and manage the status of documents
loaded into the data warehouse. Documents can be added to the queue using Load Options,
and then viewed. You can view all documents in a queue or filter to view documents published
to a specific queue.
Query for Published Documents allows you to find and view documents based on the
queue to which the document was published and by status. Through Query for Published
Documents, you can check documents already submitted to the Scheduler.
Scheduler
Each scheduler can be configured to contain a site object that denotes the location of the
scheduler server that processes the tasks. It is not necessary for the Scheduler to monitor the
various SmartPlant Foundation databases because the SmartPlant Foundation servers “push”
the task data to the centralized scheduler server.
This information is displayed in the Desktop Client through the Find > Administration >
Schedulers command, which retrieves the information from the database and displays it in the
list view.
Task specific information is stored in a database for each task sent to the Scheduler. This holds
information necessary to process a task once, a number of times, or repeatedly on a specified
schedule. The Configuration Service polls the database using a configurable interval; it will look
at each of the schedulers configured in the system. If it finds an enabled scheduler then it will
see if the related site (or default site) is active. If the site is active then it will send a request to
the scheduler asking it to poll for tasks.
The task tells the Scheduler what service or process to run, when to run it, and where to run it.
Information about scheduled tasks is displayed in the Desktop Client through the Query for
Schedule Tasks command .

The following scheduler tasks are delivered with the core Scheduler:
 Print Scheduler Task
 Full Text Retrieval (FTR) Scheduler Task
 Alternate Rendition Scheduler Task
 Archive Purge Scheduler Task
 Data Loading Scheduler Task
 Send Email Digest Scheduler Task

 Title Blocking Scheduler Task

 Export and Compress Scheduler Task
Administrators can use the Scheduler menu in the Desktop Client to start, stop, or pause the
Scheduler or to specify the additional databases that the Scheduler monitors. Right-click a
scheduled task to use the Scheduler menu. System administrators should refer to How to
Configure the Infrastructure Model for information about configuring the Scheduler.
The printing and PDF generation tasks require the Scheduler service to log in with a user
name that has access to the printer. For instructions on setting this user name, see Specify a
User for the SmartPlant Foundation Scheduler in the SmartPlant Foundation Installation and
Setup Guide.

 Stop or start a scheduler (on page 376)
 Query for scheduled tasks (on page 376)
 Retry a failed task (on page 377)
Stop or start a scheduler

1. Click Find > Administration > Schedulers.
2. In the Find Schedulers dialog box, type the name of the Scheduler, and click OK.
combination of the name and wildcard (such as n%).
3. To stop a Scheduler, right-click the Scheduler, and click Scheduler > Stop.
4. To start a Scheduler, right-click the Scheduler, and click Scheduler > Start.
You should only stop and restart a scheduler if all scheduled jobs are complete.
To view details for a Scheduler, right-click the scheduler and click Details.
Query for scheduled tasks

The Query > Schedule Tasks command opens a list view in which you can view tasks in the
database. For each task, the list displays information about the processor that performs the task,
the status of the task, the dates on which the task was created and will end, frequency
information, and so on.
Scheduled tasks run as individual tasks, and all task options are available on the shortcut menu.
This command is available only to users with administrative privileges in the SmartPlant
1. Click Query > Schedule Tasks, or click Query for Scheduled Tasks on the toolbar.
2. In the Schedule Tasks dialog box, type the name of the task and any other details for the
query.
3. Click Finish.
To view details for a Scheduler, right-click the Scheduler, and click Details.

Retry a failed task

 To retry a failed task, right-click the failed task in the list view and click Task > Retry Task.
 To see the error that caused a task to fail, right-click the task in the list view and click Task >
Show Task Failure.
The software displays an error message containing the error that caused the task to fail.
Do not remove failed documents. Documents are queued to the appropriate domain
or queue based on publish order. Removing a document from the queue that has a failed task
can result in loss of data or could cause your data in SmartPlant Foundation to be out of sync
with the authoring tool. For example, removing or skipping a document version with a failed task
can result in the following:
 Overwriting newer property values with older values.
 Failure to process update instructions because the object to be updated was not created
from the previous document version.
 Failure to process delete instructions.
Load Queue Management

Load Queue in SmartPlant Foundation allows you to view and manage document statuses of
published documents. A document must be published for any information relating to that
document to be available for use within the Desktop Client. When a document is published, the
document automatically relates to the queue and can either be loaded or removed from the
queue.
Published documents can be submitted to the load queues several ways. During publish, select
the AutoLoadPublish workflow from the Workflow list on the Publish dialog box. The queue
automatically processes your document. If no workflow is selected, find your published
document and manually submit to the queue.
When you publish a 3D model, you must enable the Scheduler and Loader to make
the 3D model data document retrievable. The load, consolidate, and merge tasks must complete
successfully before the 3D model document can be retrieved. For more information, see
Schedulers and Queue Management (on page 375).

 Publish documents (on page 378)
 View documents in a queue (on page 378)
 Find published documents (on page 379)
 Query published documents (on page 379)
 View a successfully published document (on page 380)
 View published document information (on page 380)
 Access load queues (on page 380)
 Query for a published document by queue (on page 380)

 Check published document status (on page 381)

 Manage the load queue (on page 382)
 Retry failed document (on page 382)
 Stop or start load queue (on page 383)
Publish documents
In an integrated SmartPlant environment, you must publish documents containing the drawing
data and relationships before the authoring tools can share the information. The publishing
process involves selecting a document to publish, assigning a workflow (if necessary), and
specifying a revision and version of the document if specified in SmartPlant Foundation. For
most documents, the associated data is included in the publishing process.
Published documents can be accessed in multiple ways in the Desktop Client. You can view the
documents currently in the queue, or query documents previously published to the queue. By
accessing published documents in the load queue, you can check each document status.
For additional details on publishing documents in SmartPlant Foundation, see Publishing in an
integrated environment (on page 445).
For details on the load process steps and document version objects, see Understand Load,
Consolidated, and MergeDelta tasks (on page 451).
For additional details on workflows, see Learn about publish workflows (on page 450).
View documents in a queue

You can view documents currently in the queue, the document statuses, and the order in which
the documents are queued.
Some document versions can be removed from the queue if the
SkipFailedDocumentsInLoad setting is enabled for the site. If SkipFailedDocumentsInLoad
is enabled, a document that successfully loads any previous failed versions of that document
are removed from the queue. For additional details, see Set Up SmartPlant Foundation Sites
and Modifying Site Settings in the SmartPlant Foundation Installation and Setup Guide.

Find published documents

1. Click Find > Published Data > Documents.
2. In the Find Documents dialog box, type the criteria for the query.
Query published documents

1. On the toolbar, click Query Published Documents.
2. In the Query Published Documents dialog box, type the name of the document to query,
or select the queue and status filters that you want to query.

View a successfully published document

Use one of the following options after a document status publishes successfully:
 View and Markup - The Files > View and Markup option allows you to view design files. If
SmartPlant Markup Plus is installed on your client computer, the file displays inside the View
and Markup window with the SmartPlant Markup Plus options available for viewing and
modifying the file. Otherwise, the file is opened in the default viewer. For more information,
 Expand Drawing Items - Displays a list view with all drawing items related to a published
document. For more information, see View drawing items in a published document (on page
449).
 Inconsistency Report - You can view an inconsistency report in Excel for a document. The
report is available for any document status, not just successful. For more information, see
Viewing Inconsistency Reports in Excel in How to Configure the Authoring and Data
Warehouse Models guide.
View published document information

After you query for published documents, the List View window contains published documents
with their Version, statuses for Data Load, Consolidate, and Merge Delta and times for Data
Load, Consolidate, and Merge Delta. You can access the published data from Documents in
Queue.
Access load queues

1. Click Find > Integration > Load Queues.
2. Right-click a queue and click Show Documents or Show Scheduler Task.
Query for a published document by queue

In the Desktop Client, you can perform a detailed search based on object properties for
published documents.
1. Click Query > Published Documents.
2. Enter the criteria for the query in the Published Documents dialog box.
3. Select the queue in Related Load Queue list to query the document.

4. Click Finish to display a list containing documents published to the selected queue.
Check published document status

Selecting the document in the List View displays the Properties. The status and time of the
document can be viewed in the List View or Properties window.
Published document statuses

The statuses shown in the column set are defined as follows:
 Data Load, Consolidate and Merge Delta
 Successful - Indicates the document has been processed.
 Failed - Indicates the document did not process.
 Canceled - Indicates the document did not process and was removed from the queue.
 Shared-Only - Indicates the document is read-only, is related to the queue, is not
published with a default workflow and that no data is loaded.
 Processing - Indicates the document is processing.
 Queued - Indicates the document is ready to be processed.
When both Data Load Status and Consolidate Status succeed, the document no longer
displays in the queue. The only exception to the document being removed from the queue is a
3D document with a merge delta.

Manage the load queue

The Load Queue processes documents submitted for loading into SmartPlant Foundation.
Documents must be published before any information from the published document is available
for use. You can check the status of a submitted document in the load queue.
Load Options allows you to add documents to the queue or remove documents that have failed
to load from the queue, or retry loading documents. Right-click a published document and select
Load Options from the shortcut menu.
To access Load Options, right-click a document in the queue and do one of the following:
The options available depend on the state of your document in the queue.
 Load Published Data - Add as published document to the SmartPlant Foundation queue.
 Load Published Data into Document Configuration - Publishes data into a document
configuration for verification before loading data into the plant.
 Remove from Queue - Removes a failed document or a document that has not been
processed from the load queue.
 Consolidate Document - Builds and populates the shared objects that exist between the
various tools and SmartPlant Foundation. Documents must be loaded before the document
can be consolidated into SmartPlant Foundation.
 Retry Load - Republishes to the queue to load.
 Retry Merge Delta - Resubmits the merge process to the queue.
 Retry Consolidate - Rebuilds, repopulates and shares consolidated objects between tools.
 Retry Load Into Document Configuration - Allows you to resubmit the published data
before loading the configuration.
 Show Failure - Displays document failure details.
 Merge Delta - Merges 3D graphic elements for published documents.
The system can be configured automatically. For details on configuring a Default
Workflow, see Learn about publish workflows (on page 450) or Allow users to publish
documents to a default workflow (on page 450).
Retry failed document

When a document displays in the list view with a status of Failed for Data Load, Consolidate or
Merge Delta, you can retry the action by selecting the document and using the shortcut menu.
1. Right-click the failed document in the list view and click Load Options > Retry Load.
2. Select Load Options > Show Failure to review the details of the document failure.
To review details of a document failure in an upgraded SmartPlant Foundation
environment (4.x.x to 2009 R3 SP3), you can use the Show Failure option on the
scheduled task, rather than on the document in the queue. Query for the scheduled task,
then right-click the scheduled task and select Show Failure to review the details of the
failure. For more information, see Retry a failed task (on page 377).
3. Select Load Option > Remove from Queue to remove the document from the queue.

Available options depend on the type of status failure. For example, the options for a
load fail are Remove from Queue, Retry Load, Retry Load Into Document
Configuration and Show Failure.
Documents are queued to the appropriate domain or queue based on publish

order. Removing a document with a status of Failed from the queue can result in data loss
or cause data in SmartPlant Foundation to become out of sync. For example, removing or
skipping a document version with a failed status can result in the following:
 Newer property values can be overwritten with older values.
 Update instructions can fail to process because the object being updated was not
created from the previous document version.
 Failure to process delete instructions.
Stop or start load queue

Each queue is related to a single scheduler task that continuously monitors the queue for the
next document that needs to be loaded. The scheduler task determines which document to
process next for that particular queue. When a document is first on the queue and has a Load
and Consolidate status of Queued, the document is processed.
To stop a particular queue from processing the next available document, select Stop. Select
Start to begin processing the queue again. The process of stop and start allows a reset and also
provides the ability to stop processes on one queue and resume processing on another queue.
2. In the Find Load Queues dialog box, enter search information and click OK.
3. To stop the document process, right-click an item in the queue, and click Queue > Stop.
 The queue stops if a queue is not associated with a scheduled task.

 When the queue is stopped the scheduler task is deleted and the queue stops
processing documents.
 If a document in the queue is stopped, a dialog box appears.

4. To start the document process, right-click an item in the queue, and click Queue > Start.
If a scheduled task does not exist for the queue, a task is created upon resuming the
queue.
You can view the processing status of the queue in the Enabled column in the List View and
Properties View.

SECTION 18
Printing in the Desktop Client

In the Desktop Client, you can print the contents of the list view in the client, the contents of a
dialog box, or you can also batch print files attached to documents, as well as print files attached
to documents to a local printer.
The Batch Print Files command retrieves the files to be printed using the Scheduler, which may
be installed on a different machine than the Desktop Client. Printers listed in the Batch Print
Files dialog box are those configured by the system administrator. Because batch printing is a
scheduled activity, printing may not take place immediately.
The Print (Local) command retrieves files to be printed on the printers that are configured on
the local computer where the Desktop Client is installed.
You can also print files when you open them with SmartPlant Markup Plus.
Batch Print Files dialog box

Allows you to submit several print requests at the same time to a specified plotter or printer.
Name - Displays the names of the printers associated with the files that were selected for
printing. You can change the destination printer for a file by dragging and dropping the files to
any of the printers in the list.
Description - Displays a brief description of each document, including its file type.
Dimension - Displays the actual dimension of file stored in SmartPlant Foundation.
Parent - Displays the name of the document to which the selected file is attached.
Revision - Displays the current revision of the document.
Revision Status - Displays the current status of the document. The document status is either
WORKING, CURRENT, or ISSUED.
Out of Date - Specifies whether the document is out of date. This option is display only.
Viewable - Displays whether you can view the file in SmartPlant Foundation.
Is Editable - Displays whether you can edit the file in SmartPlant Foundation.
Expand All - Expands the list of all printers associated with the files.
Collapse All - Collapses the list of all printers associated with the files.
Select All - Allows you to select all printers associated with the files.
Clear All - Allows you to clear all printers associated with the files.
Options - Allows you to set the optional printer settings to be used for printing.
Batch Print Options dialog box

Allows you to set options for the selected file and printer.
Basic print options

Allows the user to specify orientation and number of copies for the selected file and printer.

Orientation - Specifies the direction in which the file should be printed on paper: vertically
(Portrait) or horizontally (Landscape).
Copies - Specifies the number of copies you want to print.
Print paper size - Specifies the paper size to be used for printing. Selected from the available
set of paper sizes supported by the selected printer. (Available for local printing only)
Markup options
This section is only available for the selected file and printer if the system administrator has
specified SmartPlant Markup Plus as the default print application for that file type on the
selected print server.
Print range - Displays a range of pages to print.
All - Prints all pages of the document or drawing in the active window.
Sheets - Allows you to specify the page range to print using the From and To boxes.
Print within frame - Prints only items within the drawing frame. Items displaying outside the
frame will not print. This option is only available for use with files using the SmartPlant format
(for example, SmartSketch).
Scaling - Specifies the scale to be applied to the image when it is printed.
Fit to page - Modifies the print selection to make it fit on the printed page.
Scale - Adjusts the ratio at which files are printed. For more information about using the scaling
feature, refer to the SmartPlant Markup Plus documentation.
0 Fits the image to page.
1 Prints the image the same size as on the screen.
2 Prints the image twice the size as on the screen.
Print to scale - Allows you to print the image (drawing) to a specified scale by indicating the
scale factors to be used when transferring the image to paper. Use the corresponding options to
specify the number of units that appear in the specified space. For example, you can indicate
that a circle 10 inches in diameter should be scaled to 2 inches of space on paper. These
settings result in a circle 5 inches in diameter on paper. You may select any combination of
image units (inches, feet, mm, cm, meters, kilometers, and so forth) per paper units (inches,
mm).
Print quality - Select the resolution at which you want to print the active file. The higher the
resolution, the greater the number of dots that appear per inch on the printed document. This
option is only available for use with files using the SmartPlant format (for example,
SmartSketch).
View Rotation - Select the amount of image rotation, from 0, 90, 180, and 270 degrees.
(Available only for non-SmartPlant file types.)
Print in pure black and white - Indicates whether the file are printed in black and white, or
whether the colors embedded in the drawing or document will appear in the printed copy.
Print with markups - Indicates whether markup elements added to the document appear in the
printed copy. (This option is only available for SmartPlant file formats.)
Print markups in color - Indicates whether the markup elements appear in their applicable
color in the printed copy. (This option is only available for SmartPlant file formats.)
Watermark Information
Allows you to modify the watermark to appear on the printed document.

You can only modify the watermark information if the system administrator has granted
you appropriate access permissions.
Watermark text - Specifies the watermark text that appears when the document is printed.
Watermark Type - Specifies the fill pattern of the watermark text. Choose from outlined text,
filled text, hatch- patterned text, or text that combines the outline and filled styles. (Available only
for non-SmartPlant file types.)
Position - Specifies the position of the watermark on the printed page. (For non-SmartPlant file
types, the only available option is diagonal.)
Font Name – Specifies the font to use for the printed watermark text.
Font Size – Specifies the size of the printed watermark text. (Available only for non-SmartPlant
file types.)
Font Style - Specifies whether the printed watermark text is bold, italic, or regular. (Additional
styles are available for non-SmartPlant file types: underline, bold-italic, bold-underline,
italic-underline, and bold-italic-underline.)
For more information about using objects to assign watermark information to documents, refer to
Working with Watermarks and Labels.
Label Information
Allows you to modify the labels that appear on the printed document.
You can only modify label information if the system administrator has granted you
appropriate access permissions.
Top left – Text to appear in the top left position on the printed page.
Top center – Text to appear in the top center position on the printed page.
Top right – Text to appear in the top right position on the printed page.
Bottom left – Text to appear in the bottom left position on the printed page.
Bottom center – Text to appear in the bottom center position on the printed page.
Bottom right – Text to appear in the bottom right position on the printed page.
Font name - Specifies the font to use for the printed label text.
Font size - Specifies the size of the printed label text.
Font style - Specifies whether the printed label text is bold, italic, or regular. (Additional styles
are available for non-SmartPlant file types: underline, bold-italic, bold-underline, italic-underline,
and bold-italic-underline.)
For more information about using objects to assign watermark information to documents, refer to
Working with Watermarks and Labels.

 Print the contents of a List View window (on page 388)
 Print a List View window (on page 388)
 Print the contents of a dialog box (on page 388)
 Batch print attached files (on page 388)
 Print files to a local printer (on page 389)

Print the contents of a List View window

The Print command sends a copy of the active window to a specified plotter or printer.
Options are available for print range, print paper size, number of copies, and other printing
characteristics. You must install and select a printer or plotter before you use this command. For
help on installing a printer or plotter, see the Windows Help.
Print Contents and Print Window commands are also available on the File menu.
1. Click in the list view window that you want to print.
2. Click File > Print Contents.
3. In the Print preview window that appears, click .
Print a List View window

1. Click in the list view window that you want to print.
2. Click File > Print Window.
Print the contents of a dialog box

1. Click the Print button in the dialog box.
To print an image of the dialog box instead of the contents of the dialog box, select the
Print Window option in the User Preferences dialog box. See Change general user
preferences (on page 88) for details about setting user preferences.
Batch print attached files

The File > Print command sends one or more attached files to a specified plotter or printer.
Options are available for print range, print paper size, number of copies, and other printing
characteristics. You must install and select a printer or plotter before you use this command. For
help on installing a printer or plotter, see the Windows Help.
1. Right-click the documents with attached files that you want to print.
2. Click Files > Print on the shortcut menu.
3. Set up the printing information to meet your needs. If there is more than one printer in the
printer group, you can select which printer will print the files. Drag and drop the file onto the
required printer. To configure printing options for a file, select the file to be printed and click
Options.
4. Click OK.
 By default, the software prints all files attached to the documents you selected. The software
submits the print jobs to the default printer for that file type.
 The default printer for a file depends on the file type and the printer specified for that file
type by an administration in the SmartPlant Foundation Desktop Client.

Print files to a local printer

The File > Print (Local) command sends one or more attached files to any local plotter or
printer that is installed on your local computer. Options are available for print range, number of
copies, and other printing characteristics. You must install and select a printer or plotter before
you use this command. For help on installing a printer or plotter, see the Windows Help.
1. Search for the document that you want to print.
2. Right-click the document and select Files > Print (Local) on the shortcut menu.
3. Set up the printing information to meet your needs.
Only printers installed on the local machine appear in the Batch Print Files dialog box.
Print servers and printers configured for batch printing by your system administrator will not be
available for use.


SECTION 19
Integration
Integrating the SmartPlant tools standardizes and improves communication among these tools
over the course of designing, constructing, and operating a plant. Working in an integrated
environment manages data exchange among these tools, which enables sharing and re-use of
information throughout the plant lifecycle. In addition to being a tool to create and modify
information, SmartPlant Foundation acts as a repository for data and a medium through which
information is shared among other tools, such as Aspen Basic Engineering, SmartPlant
Instrumentation, SmartPlant P&ID, SmartPlant Electrical, SmartPlant Materials, SmartPlant 3D,
SmartMarine 3D, SmartPlant Review, PDS, and Microsoft Excel.
Aspen Basic Engineering, SmartPlant Instrumentation, SmartPlant P&ID, SmartPlant
Electrical, SmartPlant Materials, SmartPlant 3D, SmartMarine 3D, SmartPlant Review, PDS,
and Microsoft Excel can be integrated out-of-the box. Other applications can be integrated by
developing their own SmartPlant adapter. For more information, see the SmartPlant Foundation
programming documentation.
Learn more about working in an integrated

environment
Most of the commands that provide access to SmartPlant functionality exist in the SmartPlant
common user interface. You have access to the common user interface through commands in
the authoring tools.
In the Desktop Client, you can use the commands on the SmartPlant menu to interact with the
integrated environment, including publishing and retrieving data and comparing the design
basis.
In addition to the Plant Breakdown Structure (PBS) documents that SmartPlant Foundation
publishes, it can also publish instrument and process data sheets as well as items lists, such as
equipment lists and instrument master lists.

 SmartPlant Enterprise integration methods (on page 392)
 SmartPlant Basic Integrator (on page 392)
 Launch SmartPlant Foundation in an integrated environment (on page 392)
 Launch SmartPlant Foundation from a command prompt (on page 392)
 Learn about the Consolidated Data Warehouse (on page 394)

Integration
SmartPlant Enterprise integration methods

SmartPlant Enterprise offers integration options that address the needs of your engineering
enterprise. By integrating the SmartPlant applications, you can share and reuse plant
information across engineering disciplines and over the life cycle of a plant. SmartPlant
Enterprise offers the following types of application integration.
 Full Integration - Provides a complete tool integration and information management system
using SmartPlant Foundation.
 Basic Integration - Provides complete tool integration and limited information management
capabilities using SmartPlant Basic Integrator.
 Direct Integration - Provides tool-to-tool data transfer without using SmartPlant Foundation
or SmartPlant Basic Integrator.
SmartPlant Basic Integrator

Basic integration provides managed data exchange among SmartPlant Enterprise authoring
tools using SmartPlant Basic Integrator. The publish and retrieve capabilities of basic integration
are the same as the publish and retrieve capabilities of full integration, except that the published
data is not loaded into the SmartPlant Foundation data repository for viewing and navigating.
When you publish documents using basic integration, the SmartPlant Basic Integrator
components load only the document metadata into SmartPlant Foundation. SmartPlant Basic
Integrator cannot load published data.
Licensing determines the features available to SmartPlant Basic Integrator. SmartPlant
Basic Integrator allows one concurrent user to access the SmartPlant Foundation Desktop
Client. For more information, see the Integration Setup Guide.
Launch SmartPlant Foundation in an integrated environment

In an integrated environment, key integration functionality, such as publish and retrieve, is
available only when you open the Desktop Client using the SmartPlant > Browser command in
one of the authoring tools, such as SmartPlant P&ID, SmartPlant Instrumentation, or SmartPlant
3D.
SmartPlant Foundation can also be launched from a Command Prompt. See Launch
SmartPlant Foundation from a command prompt (on page 392).
Launch SmartPlant Foundation from a command prompt

1. Open a Command Prompt window.
2. In the Command Prompt window, change directories to the product directory, for example:
c:\Program
3. Type the following command: DesktopClient.exe /SINSTANCE True /u <username>
/p “” /s <servername>
When launching the Desktop Client from the command line, all parameters that begin
with a slash ( / ) are uppercase and require a space between the parameter and the value. If the
value contains spaces, it must be enclosed inside double quotation marks (“ ”), as shown in the
following example.

Integration
Logon Parameters
U User name
P Password
PLANT Plant name
PROJECT Project name
H Host
S Server name (as defined in the logon dialog box)
W Web directory
CURRDIR Current directory
SECURE True/False: if logging on to server using SSL
DEBUGLOG Path and file name for a debug file. This parameter is only
valid for URLs.
The following details logon parameter behavior, depending on what you specify in the command
line or URL. The following are provided in command line format. They can also be used in the
URL format.
/U /P /PLANT /PROJECT /S
Logs you in as the user specified with the plant/project specified on the given server if the server
is not authenticated. The user and password are ignored if the server is authenticated. If the
server is authenticated, the Logon dialog box appears with the User name and Password
boxes disabled, and the Server list to select the correct server.
/U /P /PLANT /PROJECT /H /W
Same as the previous example, but uses the host and web directory instead of the server.
/U /P /PLANT /PROJECT
A Logon dialog box appears with the User name and Password boxes populated.
/S /PLANT /PROJECT
If the server is authenticated, this command logs you on to the Desktop Client. Otherwise, the
Logon dialog box appears with the Server list disabled, but displays the specified server.
If the server specified is not defined, a message box appears to inform the user, and the logon
process stops.
/H /W /PLANT /PROJECT
Same as the previous example except that if the specified Web host and Web directory have not
been defined, a new server is created from these. If the new server is authenticated, this logs
you on. Otherwise, the Logon dialog box appears with the Server list disabled, but displays
the specified server.
/PLANT /PROJECT
Displays the Logon dialog box, but once you select a server and log on, the specified Plant and
Project is honored.
 If you do not specify any command line parameters, the Logon dialog box appears.
 If you select an authenticated server from the list, the User name and Password boxes are
disabled. They are enabled if you select a server that is not authenticated.
 If a server is not responding, a message box appears to tell the user, and the OK button is
disabled. The OK button is enabled if you select another server that is responding.

Integration
 When using the /SECURE switch, you may need to adjust the timeout setting in your
web.config file to keep the login attempt from timing out while the secure login is processing.
If this occurs, add or edit the following key in the web.config file with the following value:
<add key="IsResponding.Timeout" value="600" />.
 The logon parameters are case-sensitive.
Examples
Desktop_Client.exe /U abc /P /S SPF42
Desktop_Client.exe /U abc /P /PLANT Plant1 /PROJECT Project1 /S SPF42
For more information about starting the Desktop Client from a command line, see Desktop Client
Learn about the Consolidated Data Warehouse

The Consolidated Data Warehouse (CDW) is an alternative to shared object technology, linking
together all data published by the tools and exposing that data in the data warehouse. If you
want to implement Consolidated Data Warehouse, please contact your Intergraph Support
Representative and see the SmartPlant Foundation How to Configure the CDW for further
information.
Working with Microsoft Excel

In SmartPlant Foundation, you can use a Microsoft® Excel spreadsheet to:
 Create and edit data in an Excel file, then load the Excel file and its contained data into
 Retrieve data edited in Microsoft Excel and compare it to existing data in SmartPlant
Foundation
 Export data in SmartPlant Foundation to Excel
Once published, the Excel file and its data are available for viewing and navigation within
SmartPlant Foundation and for retrieval into any integrated tool, provided that tool has been
configured to retrieve the Excel file and data.
Access to Excel Import features depend on your role assignment and user permissions.
Excel Import Wizard

Allows you to load data created or edited in a Microsoft Excel spreadsheet, compare the data
with existing data, create a new document with the same name as that of the Excel file from
which the data is being loaded, and attach files to that document.
Excel file - Selects the Excel file to import. Click to select the file.
Template - Selects the template document to use when importing an Excel file. Click to
select the file.
Import Document - Stores the spreadsheet in SmartPlant Foundation attached to a new
document that is named after the spreadsheet. You can change the name in the new document
form if required.
Run Compare - Compares the data in the Excel file to the existing SmartPlant Foundation
database. If Import Document is not also selected, the Compare Scope options are enabled to
indicate if the compare should be done by object or by a selectable Container ID. A View
window appears showing the comparison results between the imported data and the data that
already exists in SmartPlant Foundation.

Integration
Add objects to New Items window - Places objects imported from the Excel file into the New
Items window.
Main Details
Name - Creates a document with the name specified.
Description - Creates a document with the description specified.
Details
Title - Creates a document with the title specified.
Status - Creates a document with the configured status. This is configured as a read-only field
by default.
Owning Group
Item owning group – Associates the selected owning group to the document being created.
Revision Details Section

Revision scheme - Creates the document with the selected Revision Scheme.
Major Revision - Creates the document with the Major revision specified. By default, this file is
automatically populated based on the selected Revision Scheme.
Minor Revision - Creates the document with the Minor revision specified. By default, this is
automatically populated based on the selected Revision Scheme.
Excel Import Wizard View dialog box

Displays the comparison results between the Excel file and the existing SmartPlant Foundation
database.
Results tree - Displays the objects imported in a tree view. You can click an object in the tree
view and see the comparison results in the Details window.
Excel View - Displays the import in an Excel spreadsheet.
New - Displays data that is new in grey. New items are created in SmartPlant Foundation.
Different - Displays data that is different in pink. Data that is different is merged into SmartPlant
Foundation.
Identical - Displays data that is identical in green.
Details - Displays the comparison results when an object is selected in the Results tree.
Excel Import Wizard Summary dialog box

Displays a summary of the Excel import results.
Import Results
Name - Displays the name of the imported Excel file.
Container - Displays the name of the container in which the objects are stored.
Created objects - Displays the number of new objects created during import.
Updated objects - Displays the number of existing objects updated during import.
Processed instructions - Displays the number of instructions executed during import.
Unchanged objects - Displays the number of existing objects that were not changed during
import.

Integration
Failed objects - Displays the number of objects that failed to create or update during import.
Process time - Displays the total amount of time of the import process.
Export (Select Template) dialog box

Select a file to use as a template. The contents of the List view window are exported to Excel
using the selected file as a template.
Excel Publish Wizard dialog box

Allows you to publish data created or edited in a Microsoft Excel spreadsheet, compare the data
with existing data, create a new document with the same name as that of the Excel file from
which the data is being publish, and attach files to that document.
Excel file - Selects the Excel file to publish. Click to select the file.
Template - Selects the template document to use when publishing an Excel file. Click to
select the file.
Publish Window
Identification Section
Last Published – The date on which the document or documents were last published.
Name – Creates the document with name as <Name of Excel file selected>_<Name of
Template selected>.
Source – The authoring tool in which the document is created (Excel).
Type – Type of document or documents selected.
Configuration Section
Revision scheme – Creates the document with the selected revision scheme.
WorkFlow – Publishes the document into the selected workflow.
Operation – Operation to be performed on the document, such as Publish, Batch Publish, or
Background Publish.
Property
Name – Name of the object.
Description – Object description.
‘Last In’ Value – Last published value of the property. One column per tool that published the
same object with the values last published by those tools for the properties.

 Import data from Microsoft Excel (on page 397)
 Import data from Microsoft Excel and compare (on page 398)
 Export the contents of a List View to the default template (on page 59)
 Export the contents of a List View to the selected template (on page 59)

Integration
 Export the contents of a List View to Excel (on page 60)

 Publish data from Microsoft Excel (on page 402)
 Publish data from Microsoft Excel and compare (on page 404)
 Configure export template (on page 407)
Import data from Microsoft Excel

1. Click File > Excel Import.
 The commands available on the File > Excel Import submenu depend on your role
assignment and user permissions within a project. For more information about user
roles and access, see Plant and Project Data in SmartPlant Foundation (on page 80).
 Templates that are available for you to use during import are configured by a system
administrator and depends on your role assignment and user permissions within a
project.
2. Click next to the Excel file box, then click the Excel file to import.
3. Click next to the Template box, then click the template to use for import.
information.

Integration
5. Select the Import Document option to include the Excel file in the import.
6. Select the Add objects to New Items window option to place objects in the New Items
window in SmartPlant Foundation.
7. Click Next.
When import is complete, a summary report window appears detailing the name of the
import and the number of objects created.
8. Click Finish.
In the New Items window of SmartPlant Foundation, the import creates the document and
the objects.
Data imported is stored in the appropriate domain database. Data is stored in the data
warehouse when it is published.
Import data from Microsoft Excel and compare

1. Click File > Excel Import.
 The commands available on the File > Excel Import submenu depend on your role
 Templates that are available for you to use during import are configured by a system
project.
2. Click next to the Excel file box, then click the Excel file to import.
3. Click next to the Template box, then click the template to use for import.

Integration
information.
5. Select the Import Document option to include the Excel file in the import.
6. Select the Add objects to New Items window option to place objects in the New Items
window in SmartPlant Foundation.
7. Select the Run Compare option.
 If the Import Document option is not selected, the software compares the objects being
loaded to the database.
 If the Import Document option is selected, the software compares the ContainerID
derived from the name of the spreadsheet.
 If the Run Compare option is selected and Import Document option is not selected,
then the compare scope options are enabled. The user has two options to select and
the default is By object.
 The menu adjacent to By container ID becomes active when this option is selected.
8. Click next to the Attachments box to attach any files to the import.
9. Click Next to begin the import.

Integration
When import is complete, a View window appears showing the comparison results between
the data imported and data already existing in SmartPlant Foundation.
10. Click an object in the Results tree view to see the comparison results in the Details window
at the bottom of the View window.
 Gray represents data that is new. New items will be created in SmartPlant Foundation.
 Pink represents data that is different. Data that is different will be merged into
 Green represents data that is identical.
11. Click Next to finish the import.
When import is complete, a Summary window appears showing the number of objects
created and updated.
12. Click Finish.
13. In the New Items window of SmartPlant Foundation, the import creates any new objects
and updates the appropriate existing objects.
Data imported is stored in the appropriate domain database. Data is stored in the data
warehouse when it is published.

Integration
Export the contents of a List View to the default template

The File > Export (Default Template) command allows you to export the contents of a window
into a Microsoft Excel file.
3. Click File > Export (Default Template).
Export the contents of a List View to the selected template

The File > Export (Selected Template) command allows you to export the contents of a list
view window into a Microsoft Excel file.
3. Click File > Export (Select Template).
4. In the Define Excel Template dialog box, select a template from the list. For more
information on creating a new template, see Configure export template (on page 407).
5. Click OK.
Export the contents of a List View to Excel

The File > Extract List to Excel command allows you to export the contents of a window into a
Microsoft Excel file.
3. Click File > Extract List To Excel.
 You must have Microsoft Excel installed on the client computer to use this command.
 You must set your Internet security level to low to use this command. Click Tools > Internet
Options > Security > Local Intranet > Custom Level in Internet Explorer and then set
Initialize and script ActiveX controls not marked as safe to Enable or Prompt.

Integration
Publish data from Microsoft Excel

1. Click SmartPlant > Excel Publish.
 The availability of the SmartPlant > Excel Publish menu depends on your role
 Templates that are available for you to use during publish are configured by a system
project.
2. Click next to the Excel file box, and click the Excel file to publish.
3. Click next to the Template box, and click the template to use for publish.
For information regarding creation of templates, refer to the How To Configure the
Datasheet Model guide.
4. Click Next.

Integration
5. Enter the SmartPlant Foundation URL, and click Next.
6. Log in and type the SmartPlant Foundation user name and password when prompted.
7. Select a plant and click Finish.
9. Perform the following in the Publish window:
 Select the document to be published from the Selected Documents tree list view.

Integration
 In the Publish tab, select a Revision Scheme and Workflow for the document to be
published, select Publish from the Operation list, and click OK.
10. Click Close on the Publish window when the publish operation has completed.
 Data published is stored in the data warehouse in the appropriate domain.

 To ensure document is scheduled to be published, refer to Schedulers and Queue
Management (on page 375).
 To view published data, use Find > Published Data > <Object Type>.
 To publish similar objects again, the same Excel file can be used with the new data
appended to it. Removal of existing data from the file will delete the already published
objects from the data warehouse.
Publish data from Microsoft Excel and compare

1. Click SmartPlant > Excel Publish.
 The availability of the SmartPlant > Excel Publish menu depends on your role
 Templates that are available for you to use during publish are configured by a system
project.
2. Click next to the Excel file box, and click the Excel file to publish.
3. Click next to the Template box, and click the template to use for publish.

Integration
For information regarding creation of templates, refer to the How To Configure the
Datasheet Model guide.
4. Click Next.
5. Enter the SmartPlant Foundation URL, and click Next.

Integration
7. Select a plant and click Finish.
9. Perform the following in the Publish window:
 Select the document to be published from the Selected Documents tree list view.
 In the Publish tab, select a Revision Scheme and Workflow for the document to be
published, select Publish from the Operation list, and click OK.
10. Click Close on the Publish window when the publish operation has completed.
 Data published is stored in the data warehouse in the appropriate domain.

 To ensure document is scheduled to be published, refer to Schedulers and Queue
Management (on page 375).
 To view published data, use Find > Published Data > <Object Type>.
 To publish similar objects again, the same Excel file can be used with the new data
appended to it. Removal of existing data from the file will delete the already published
objects from the data warehouse.

Integration
 Comparison between properties of objects previously published using other tools and those
published again using Excel Publish may be viewed by right-clicking on the Excel object and
selecting View Shared <object type>.
 Light Cyan represents data that was published last.

 Orange represents data that is inconsistent between two.
Configure export template

The Excel templates used by ad-hoc reports and the Export (Select Template) command are
stored in SmartPlant Foundation. The following procedures explain how to create and import
them into SmartPlant Foundation.
Create this template from Configuration Top so that it can be used by all plants in the
site; otherwise you can only use the template with the plant under which it was created. To
change the scope to Configuration Top, select Scope Not Set in the Create scope section of
the Set Active Scope dialog box. For more information, see Set the active configuration by
roles (on page 79).
There are two ways to create an Excel template:

Integration
 Provide an Excel document that did not originate from the Desktop Client. For more
information, see Create a template from Microsoft Excel (on page 408) section.
 Create an Excel file by exporting data from the Desktop Client. For more information, see
the Create a template from the Desktop Client (on page 409) section.
Before attaching an Excel document to the template, make sure the document is formatted to
your specifications. Excel templates are compatible with ad-hoc reports and the Export (Select
Template) command.
When creating an Excel template, verify the column order matches either the column
order in the Edit Report Definition dialog box that you use to configure your report or the
column set used to display data in the list view window. For example, if the list view contains the
columns (from left to right) Name, Description, Revision, Version, and Class, the software
exports the data in that order. If the Excel template does not match the software, the template
columns and exported columns will not match.
If you have already created an Excel file to use as your template, skip to Load the template
file into the Desktop Client (on page 409).

 Create a template from Microsoft Excel (on page 408)
 Create a template from the Desktop Client (on page 409)
 Load the template file into the Desktop Client (on page 409)
Create a template from Microsoft Excel

1. Create a new Excel document.
2. Add a logo or other information to the Excel document if necessary. Anything you add to the
document must be to the right of any potential exported data that will populate the
document. For example, if your template populates columns A through G with data, any
additional information in the template must be added in column H or after.
3. Create a macro that is to be run when the file is opened and name it Initialize_It. For
example, you can write a macro to move cells, apply formatting, remove empty rows or
columns, or remove duplicate headers and titles.
 The macro must reside inside a VBA module or it will not run.
 Refer to the macro used in the Excel file attached to the Excel Default Template
document stored in SmartPlant Foundation.
4. Save the Excel file as an Excel 97-2003 Workbook (.xls) file.
The file must be saved with the .xls extension or SmartPlant Foundation cannot
use it.
5. Close the Excel file and skip to the Load the template file into the Desktop Client section.
If you do not close the file, you will not be able to attach it later.

Integration
Create a template from the Desktop Client

1. Click File > New > Report in the Desktop Client.
2. Select the report (view definition) and click OK.
3. Select Excel in the Report output style list, and select one or more items in the Report
details list.
4. Using the Report Definition dialog box, configure the view as you want to view your data.
For example, use the Up and Down buttons to organize the properties in the order you want
to see them in your report, or use the Caption values to display the column headers as you
want to see them.
5. Click OK to export the results to an Excel file.
The Excel file opens when SmartPlant Foundation completes the export process.
6. Add a logo or other information to the Excel document if necessary. Anything you add to the
document must be to the right of any potential exported data that will populate the
document. For example, if your template populates columns A through G with data, any
additional information in the template must be added in column H or after.
7. Create a macro that is to be run when the file is opened and name it Initialize_It. For
example, you can write a macro to move cells, apply formatting, remove empty rows or
columns, or remove duplicate headers and titles.
 The macro must reside inside a VBA module or it will not run.
 Refer to the macro used in the Excel file attached to the Excel Default Template
document stored in SmartPlant Foundation.
8. Save the Excel file as an Excel 97-2003 Workbook (.xls) file.
The file must be saved with the .xls extension or SmartPlant Foundation cannot
use it.
9. Close the Excel file.
If you do not close the file, you will not be able to attach it later.
Load the template file into the Desktop Client

1. Select Document Category > Template Documents > Excel Template in the Desktop
Client Tree.
2. Right-click Excel Template and click New Template Document from the shortcut menu.
3. In the New Template Document form, type a Name and Description for the new template.

Integration
4. Select the Item owning group, and click Next. The Attach Files form is displayed.
 By default, the local copy of the Excel file is removed from the local folder and stored in
the SmartPlant Foundation database as a blob. Clear the Delete Local Files option to
keep a local copy of the file.
5. Attach the Excel file created above and click Finish. The new template document is
displayed in the Desktop Client New Items window.
To edit the new report template, you must check out the template, modify it,
and then check the template back into SmartPlant Foundation.
Comparing documents
In the Desktop Client, you can compare document versions of published documents with each
other and the differences in data published to SmartPlant Foundation using the Compare and
View and Compare commands.
When you compare versions, you must select two document versions in the Desktop Client, and
then right-click and select either the Compare command or the View and Compare command,
the Desktop Client displays the comparison results in the View and Compare window, which
displays the view files for the documents side-by-side with changes highlighted. This window
also includes a table that lists the specific changes identified when the documents were
compared. When you select an object in the graphic view or the table, you can also view
properties for that object in the Properties window. A color scheme lets you see at a glance
whether objects were created, deleted, or changed between the two versions being viewed.
The Compare command does not show the view files of the published documents, but uses a
color-coded table to illustrate the difference between to two selected versions of the document

Integration
View and Compare window

Displays two documents for comparison.
changes highlighted. The View and Compare window also includes a table that lists the specific
changes identified when the documents were compared. When you select an object in the
graphic view or the table, you can also view properties for that object in the properties window.
Compare Window
the object.
the object.
of the document.
 Exists in document 1 only – Indicate that the object was deleted between the two
not change. If this check box is not selected, then all properties appears in the list, even those
Export – Extracts the information in the table to a Microsoft Excel spreadsheet for review or
sharing.
Compare window
the object.

Integration
the object.
of the document.
 Exists in document 1 only – Indicates that the object was deleted between the two
not change. If this check box is not selected, then all properties appear in the list, even those
Export – Extract the information in the table to a Microsoft Excel spreadsheet for review or
sharing.
Set Display Preferences dialog box

Provides tabs for selecting the layout, colors, and other view options for the Compare window.
 Layout tab
 Display tab
 Auto-focus tab
Layout tab (Select Display Parameters dialog box)

Allows you to select the layout of the View and Compare window by clicking the button that
corresponds to the configuration you want.
Different colors represent different parts of the View and Compare window:
Display tab (Select Display Parameters dialog box)

Allows you to define color settings and display indicators for the comparison results displayed in
the View and Compare window.
Set Color - Allows you to set the color for the comparison result type you selected in the list.
Restore Default Color - Restores the default color for the comparison result type you selected
in the list. By default, the following colors represent types of comparison results:
Restore All Default Colors - Restores the default colors for all comparison results.

Integration
Set Color - Allows you to indicate whether you want color to identify comparison results of the
selected type. If the check box is selected beside a comparison result type, color is used to
identify that type of change in the drawings, comparison results table, and Properties window.
Make Bold - Allows you to indicate which of the comparison results of the selected type to bold.
If the check box is selected beside a comparison result type, bold is used to identify that type of
change in the drawings, comparison results table, and Properties window.
Display Titlebar in Drawing Frames - Indicates whether you want to display the name of the
drawing and its major and minor revision numbers in the title bars of the drawings in the View
and Compare window.
Auto-focus tab (Select Display Parameters dialog box)

Allows you to define auto-focus settings for the View and Compare window.
When selecting an item in a drawing, do you want to automatically find it in the list of
changes? - Determines whether clicking an object in one of the drawing views automatically
scrolls to the changes for that object in the comparison results table. Click Yes to automatically
find the changes for an object in the comparison results table; click No to turn this option off. By
default, this option is set to No.
drawings? - Determines whether clicking a change in the comparison results table
automatically finds the object in the drawing views. Click Yes to automatically find the
corresponding objects in the drawing views; click No to turn this option off. By default, this option
is set to Yes.
When finding an item in the drawings, what method do you want to use? - Sets how you
want the Compare window to behave when the software automatically locates an object in the
drawings. Available options include the following:
 Zoom in on minimum bounding box - Zooms the drawing views to the selected object
regardless of the current zoom level in either drawing.
 Center on the item without changing zoom level - Centers the drawing views on the
selected object using the current zoom level.

 View and compare document versions (on page 205)
 Compare document versions (on page 206)
 Select the layout for the Compare window (on page 208)
 Change colors for comparison results (on page 210)
 Change display indicators for comparison results (on page 210)
 Change auto-focus options for comparison results (on page 210)
 Find a change in the Comparison Results table (on page 211)
 Find a selected change in compared drawings (on page 211)
 Learn more about the View and Compare window (on page 212)

Integration
View and compare document versions

This command is not available for use with 3D models.
2. Right-click the versions and select View and Compare.
 The two documents you selected to compare display in side-by-side graphical views.
 A list of differences between the two documents displays in a comparison results table
under the graphical views.
 Differences between the two documents appear in different colors. By default, new
items appear in red, deleted items appear in green, modified items appear in blue, and
items that are the same appear in black. You can change these default colors by
clicking Set View Options .

Integration
3. To center the display on a particular item in both views, click the item in the table.
 When you click an item in the view or in the table, the software also displays properties
for the selected item in a properties window to the right of the view panes. The
properties are color coded to show whether they are new, deleted, modified, or the
same. If the properties window contains identical properties, you can click Show
Modified to show only modified properties.
 By default, the software centers on an object in the drawings when you click the object
in the comparison results table. You can change the default auto-focus behavior by
clicking Set View Options , and then changing the options on the Auto-focus tab.
 If you right-click a navigable object, a menu for that object displays. If you right-click
elsewhere in the drawing, a menu for the document displays. In some cases the menu
is not be available. For example, if a deleted item is selected, the shortcut menu is not
be available unless the effectivity date is set back to a time when the item existed.
4. To display the changes for a particular item in the properties grid, click the item in the
appropriate graphical view.
To automatically find an object in the comparison results table, click an object in the
graphical view. This behavior is automatic if you have selected Yes for the When selecting
an item in the drawing, do you want to automatically find it in the list of changes?
option on the Auto-focus tab of the Set Display Preferences dialog box.
5. To sort the properties alphabetically, click , or to sort the properties by category, by

clicking .
6. To filter a column in the comparison results table, right-click the column header, point to
Filter, and then click the type of information by which you want to filter the column.
To define a custom filter, click Filter > (Custom). Then define your filter criteria in the
Custom Filter dialog box and click OK.
7. To move through the changes in the comparison results table, use the Next Change
and Previous Change buttons on the toolbar.
Compare document versions

The Compare command allows you to compare two revisions or two versions of a published
document. This command is available only if you have selected two revisions or versions of the
same document.
2. Right-click and select Compare.

Integration
The Document Version Comparison dialog box displays the differences between the two
versions.

Integration
Select the layout for the Compare window


Integration
2. On the Layout tab, click the layout that you want for the View and Compare window.
On the Layout tab, different colors represent different parts of the View and Compare
window:
3. Click OK.

Integration
Change colors for comparison results

3. Under Color Settings, click the type of comparison result for which you want to change the
display color.
4. Click Set Color.
5. Select the color that you want, and click OK.
6. In the Set Display Preferences dialog box, click OK.
 To restore the default display color for the selected type of comparison results, click
Restore Default Color.
 By default, the following colors represent types of comparison results:
 To restore the default display colors for all results, click Restore All Default Colors.
Change display indicators for comparison results

3. Under Drawing Item Display Indicators, select the Set Color option beside each result
type that you do not want to use color to identify.
By default, color is turned on for all result types.
4. If you want a result type to appear in bold in the drawing, comparison results table, and the
properties window, select the Make Bold option beside that result type.
 By default, bold is turned off for all result types.

 You can combine color and bold text by selecting both the Set Color and Make Bold
options for a result type.
5. Click OK.
Change auto-focus options for comparison results

2. Click the Auto-focus tab.
3. Select the appropriate options to determine the software behavior when you select an object
in the drawing view or the comparison results table.
4. Click OK.

Integration
Find a change in the Comparison Results table

The Find Change in List command finds the changes for an object in the comparison
results table when you select the object in one of the drawing views. The software finds the
change automatically in the table if the When selecting an item in the drawing, do you want
to automatically find it in the list of changes? option on the Auto-focus tab of the Set
Display Preferences dialog box is set to Yes.
The Previous Change command moves to the previous change in the comparison results
table.
The Next Change command moves to the next change in the comparison results table.
1. In the View and Compare window, click an object in one of the drawing views.
 If you set the When selecting an item in the drawing, do you want to automatically
find it in the list of changes? option on the Auto-focus tab of the Select Display
Parameters dialog box to Yes, the software automatically finds the object in the
comparison results table.
 If this option is set to No, continue to step 2 to display the selected change in the table.
2. Click Find Change in List .
Find a selected change in compared drawings

The Find Change in Drawing command finds the change you selected in the comparison
results table in the drawing views. The software finds the change automatically in the table if the
drawings? option on the Auto-focus tab of the Select Display Parameters dialog box is set to
Yes.
1. In the View and Compare window, click a change in the comparison results table.
 If you set the When selecting an item in the list of changes, do you want to
automatically find it in the drawings? option on the Auto-focus tab of the Set
Display Preferences dialog box to Yes, the software automatically finds the object in
both drawings.
 If this option is set to No, continue to step 2 to display the selected change in the
drawings.
2. Click Find Change in Drawing .
 The properties window automatically updates when you click an object in one of the
drawings.

Integration
Learn more about the View and Compare window

changes highlighted. The following explains more about the options available in the View and
Compare window.

 Set view options (on page 212)
 Zoom in (on page 212)
 Zoom out (on page 212)
 Zoom area (on page 213)
 Fit (on page 213)
 Pan (on page 213)
 Select (on page 213)
 View and markup (on page 214)
Set view options

The Set View Options command allows you to set the layout, colors, and other view options
for the Compare window.
Zoom in
The Zoom In command increases the drawing view magnification. You remain in zoom in
mode until you right-click, click Select , or press ESC.

Zoom out
The Zoom Out command decreases the drawing view magnification. You remain in zoom
out mode until you right-click, click Select , or press ESC.


Integration
Zoom area
The Zoom Area command increases the drawing view magnification of an area that you
define with two points. Click the Zoom Area command from the toolbar, and then click in one of
the drawing views and, holding down the left-mouse button, drag to draw a box around the area
on which you wish to zoom.

Fit
The Fit command resets the drawing view magnification so you can see the entire drawing.

Pan
The Pan command repositions the drawing so you can see another drawing area without
changing the view magnification. You remain in pan mode until you right-click, click Select ,
or press Esc. Click the Pan command on the toolbar, and then click in a drawing view and drag
the image in any direction to change the area displayed in the view.

Select
The Select command turns on the Select mode. When in Select mode, you can click an
item in the drawing to view the item properties. Right-click an item to view the shortcut menu for
that item. You can use Select to exit the continuous zoom and pan modes.
This command is available only when a drawing is displayed.

Integration
View and Markup

View and Markup command allows you to view design files inside a SmartPlant Markup
window rather than the Compare and View window. If SmartPlant Markup Plus is installed on
your client computer, the file appears inside the View and Markup window with the SmartPlant
Markup Plus commands available for viewing and marking up the file.
For more information about using the Markup commands, refer to the SmartPlant Markup Plus
Help.
If the file is a master file, it can be viewed along with its nested references.
 For more information about using View and Markup commands in SmartPlant Foundation,
Comparing published documents

When data has been published by a SmartPlant Foundation authoring domain in an integrated
environment, then retrieved by another SmartPlant Foundation authoring domain, such as
instrumentation, that data can be compared with the design basis before the items are created
in the retrieving SmartPlant Foundation authoring domain.
The Compare Latest Retrieved Data command finds the last items retrieved into the authoring
domain from the data warehouse. These items are placed in the To Do list for review, allowing
you to select items and relationships to create in the SmartPlant Foundation authoring domain.
Comparing published items with the design basis using the Process Design Basis and
Instrument Design Basis commands compares all retrieved items and their revisions.
To Do List dialog box

Allows you to compare and review retrieved data, then select items and relationships to be
created in SmartPlant Foundation.
Items Retrieved
Domain - Displays the shared domain from which the items were retrieved.
Filter - Filters the type of items displayed.
Display
Display List - Filters the retrieved items display to show all items or only new, updated, or
deleted items.
All Items - Displays all items and the relationships in the Property Details area
Primary Items - Displays items without the relationships in the Property Details area.
Relationships will not be created if this option is selected.
By default, the following colors represent types of comparison results:
 Green - Changed objects
 Blue - New objects
 Red - Deleted objects

Integration
 Black - Objects that are unchanged

Select All - Selects all retrieved items and relationships to create in SmartPlant Foundation.
Clear All - Clears all selections of retrieved items and their relationships.
Property Details
Class Definition - Displays the class definition associated with the retrieved item.
Name - Displays the name of the retrieved item.
Property Details Table

Property - Displays the properties that are related to the retrieved item.
Source Domain - The domain in which the property is stored and retrieved.
Design Value - Displays the current values stored in the SmartPlant Foundation authoring
environment.
Design Basis Value - Displays the current values in the design basis, such as the P&ID or 3D
model.
Retrieve Value - Displays the value in the retrieved file when the property is being created.
If the property is being updated, this retrieve value column displays the unit of
measurement value from the retrieved file adjusted to match the unit of measurement value
stored in the authoring environment. If the value is not a unit of measurement, this column
displays a blank value.

 Compare published items and work process considerations (on page 424)
 Compare design basis objects to the design (on page 425)
 Compare design basis documents to the design (on page 426)
 Compare with design (on page 427)
Compare published items and work process considerations

The ability to have an automated, visual comparison between the state of the data in the
authoring domain and the state of the data being retrieved is useful in the following work
processes:
 When downstream disciplines evaluate the quantity and nature of design changes
introduced with a new issued revision of a design document from another application, this
information can be helpful in ensuring all changes have been properly recorded.
 By running a To Do List task, the retrieved information is used to automatically update the
target design data. This saves time and improves quality by avoiding data re-entry.

Integration
Compare design basis objects to the design

In this procedure, we will use retrieved instruments as an example for comparing items with the
design basis.
1. Click SmartPlant > Instrumentation > Instrument Design Basis Items.
The Find Instrumentation Design Basis Items list view appears.
2. Enter the name of an instrument or click OK to find all instruments to compare.
All retrieved instruments and their revisions are displayed.
3. In the results window, right-click an instrument, then click Compare with Design.
4. In the ToDo List, select All Items in the Display area.
All Items - Displays all items and the relationships in the Property Details area.
Relationships are not created if this option is selected.
5. Click OK to create or update the instrument and relationships in SmartPlant Foundation.

Integration
Compare design basis documents to the design

The Compare Latest Retrieved Data command finds the last items retrieved into the authoring
domain from the data warehouse. These items are placed in the To Do list for review, allowing
you to select items and relationships to create in the SmartPlant Foundation authoring domain.
In this procedure, we will use retrieved instruments as an example for comparing the latest index
items to be created or updated in SmartPlant Foundation.
1. Click SmartPlant > Instrumentation > Compare Latest Retrieved Data for IDX.
The command only compares the last retrieved item. To compare other items, see
Compare with design (on page 427). To compare other items and all of their revisions, see
Compare design basis objects to the design (on page 425).

Integration
Compare with design

1. Right-click a retrieved item in the New Items window, then click Compare with Design.
Correlating items
In many cases, an object in one application may be similar to an item in another application. For
example, a pump may be defined through a data sheet, P&ID, 3D model, and equipment list.
Correlation is the action of saying an object from one data source is the same as an object from
another data source; for example, the pump in the P&ID is the same as the pump in the 3D
model.
SmartPlant Foundation models engineering information by providing publish domains to allow
isolation of the data from each source. This is important because each engineering discipline
must maintain independent control of their information. While each engineering discipline
depends on others for information, they must be able to execute their work in parallel based on
design assumptions when necessary. Publish domains provide the ability for each application to
share its information without overwriting information from other applications.
While each discipline must maintain independent control of their information, there are
dependencies in the information between disciplines. These dependencies are the fundamental
reason for integration. The dependencies in the information between disciplines are described

Integration
above as design basis objects. The process of establishing a specific instance of dependency
(such as establishing a design basis object) is known as correlating.
By providing a combination of information isolation and information correlation, the
independence and interdependence of engineering information is managed.
Correlating objects allows a system to compare data to generate To Do list tasks that reflect the
data inconsistencies. Also, correlating items results in a shared object in SmartPlant Foundation.
For items to correlate, their classes must have a shared object definition in common.
Shared objects in SmartPlant Foundation assist in navigating between data from multiple
sources to find information. You can compare the information in SmartPlant Foundation to
address data inconsistencies. After objects are correlated in SmartPlant Foundation, the View
Shared Object command displays the information on the object from each of the sources.
Correlation in SmartPlant Foundation is recommended when an authoring tool does not

have correlate capability or it does not have the Retrieve command.

 Correlate items manually after publish (on page 429)
 Correlate items automatically during publish (on page 429)

Integration
 Correlate items from a new tool (on page 430)

 Correlate items from PDS or AVEVA PDMS (on page 432)
 View shared objects (on page 434)
Correlate items manually after publish

The Correlate command allows you to review and edit the correlation between plant items and
design basis items from the Correlate Items dialog box.
You can correlate objects that have been published to SmartPlant Foundation.
1. Click Find > Published Data > <object>.
2. Select the objects to correlate.
You can only correlate two objects.
3. Right-click the selected objects, and click Correlate.
4. Click one of the object names from the drop-down list to be the shared object name or type
a new name.
5. Click OK and the software automatically correlates the selected objects and creates a new
shared object in SmartPlant Foundation.
To learn more about shared object classes, see Correlate items automatically during
publish (on page 429).
Correlate items automatically during publish

If you publish a document into the Auto-Correlate workflow, the workflow compares the objects
in that document to the objects that are already in SmartPlant Foundation. For each object in the
document, the Auto-Correlate workflow looks for objects in the database that are shareable
through the same shared object class as defined by the SmartPlant Schema. Among the objects
that are shareable through the same object class, Auto-Correlate looks for objects that have
the same name as the object in the document that you put in the workflow. Objects that match in
both name and shared object class can correlate.
If an object in the document that you put in Auto-Correlate can correlate through objects using
one shared object class, Auto-Correlate automatically correlates the objects. However, if an
object can correlate with objects using more than one shared object class, Auto-Correlate puts
a task in the To Do list to allow you to pick the correlation.
The following is an example of publishing a document to the Auto-Correlate workflow.
A 3D model document is published using the Auto-Correlate workflow. The document contains
an object of class PDSPipeline named P-222 and an object of class PDSInstrument named
CV-100.
Objects of class PDSPipeline can be correlated through one shared object class,
SharedPipeline. Auto-Correlate looks in the database for objects that are named P-222 and
can be correlated through SharedPipeline. Auto-Correlate automatically correlates these
objects with the PDSPipeline object named P-222.
Objects of class PDSInstrument can be correlated through two shared object classes,
SharedInstrument_PM and SharedPipingComponent_PM. The software searches the
database for objects that are named CV-100 and that can be correlated through either
SharedInstrument_PM or SharedPipingComponent_PM.

Integration
If the software only finds objects that can be correlated through SharedInstrument_PM, it
correlates those objects with the PDSInstrument object named CV-100. If the software only
finds objects that can be correlated through SharedPipingComponent_PM, it correlates those
objects with the PDSInstrument object named CV-100.
If the software finds both types, it cannot automatically correlate because an object can be
correlated through only one shared object class. In this case, a Correlate task is added to the
To Do list. For more information about running a correlate task, see Correlate items from a new
tool (on page 430). You then select to correlate with either the object found through
SharedInstrument_PM or the object found through SharedPipingComponent_PM, but not both.
Correlate items from a new tool

The following example explains how to publish objects to a correlate workflow from a tool that
has been used to modify data for your plant, but was just added to the integrated environment.
In this example, SmartPlant Instrumentation has been used to create instrument data, including
an instrument index. However, other tools have already published process data based on the
same tag numbers. You want to publish data to SmartPlant Foundation without first publishing
and retrieving data from other tools, and correlate it against the data that exists in SmartPlant
Foundation.
1. In SmartPlant Instrumentation, publish the instrument index. The Publish dialog box
displays.
2. On the Publish tab, select Correlate from the Workflow list.
You can select the Auto-correlate workflow to automatically correlate items during
publish. See Correlate items automatically during publish (on page 429).
3. Click OK.
4. In SmartPlant Foundation Desktop Client, click View > To Do List.

Integration
5. In the To Do List, right-click on the Correlate task, then click Correlate on the shortcut
menu.
6. In the Correlate dialog box, check the instruments you want to correlate. All items are
selected by default.
7. Click OK.
8. In the To Do List, right-click on the Correlate task, then click Approve on the shortcut
menu.
9. Add comments or messages in the SignOffStep Task dialog box.

10. To verify the data is updated, click Query > Published Documents. The instrument index
should appear in the loader queue.
11. Verify that the load and consolidate tasks complete successfully
12. Click Find > Published Data > Instruments.
13. Right-click an instrument, and click View Shared Instrument.

Integration
Review the data to make sure data from the correlated objects appear.
Correlate items from PDS or AVEVA PDMS

Because PDS and PDMS are not correlating tools, the process of correlating data from
them is slightly different than from other tools. The loader automatically correlates all PDS and
PDMS item types that are tagged, such as equipment, instruments, and lines. The data from
PDS and PDMS is loaded but the relationships are not processed. That step is performed as an
item in the To Do List. In this task you review the results of the automatic correlation, correct
any wrong results, and finish any incomplete results.

Integration
1. In the To Do List, select the steps that represent the correlation of the PDS or PDMS data.
In the graphic below, the correlation completion step has been selected and the results are
displayed in the pane below.
2. Modify the existing correlation information as necessary to correlate items that were not
automatically correlated or to correct items that were not correlated correctly.
For more information about workflows, including those to use for correlation of PDS
and PDMS documents, see the Model Loader User's Guide.
3. Once you have made all the necessary changes to the correlation information, right-click the
step in the To Do List, and click Approve. The loader will then process the relations.
You can click the Filter icon to switch the display list at the bottom of the window to display
all of the correlation information or only those items that were not correlated automatically.
 The interface supports drag and drop functionality from other views in the SmartPlant
 The ClassDef and Tag values display the information published from PDS or PDMS. The
Target Class Definition and Target Tag columns show the current correlation information.
When you choose the blank option from the Target Class Definition list box, no correlation is
made.

Integration
View shared objects

SmartPlant Foundation allows you to view data about a shared object, such as instruments,
equipment, and pipelines, that has been published by multiple sources into their tool-specific
domains, then correlated. You can see inconsistencies between the data published by tools, the
latest retrieved value, and more.
Published objects must be correlated in order to view data across multiple domains.
In this example, we will view data published about a shared instrument.
1. Click Find > Published Data > Instruments.
2. Right-click an instrument, and click View Shared Instrument.
The Property dialog box appears. Review the data about the instrument.
 For properties scoped by a unit of measure, the SI values of the property values are used to
determine inconsistencies. This means that the units of measure for the property values do
not have to be the same to be considered consistent, as long as the SI values are the same.
 The tolerance value for comparing numeric values is +/-0.5%.

Integration
Viewing status and history

In the Desktop Client, you can view the publish history of a document, the status of load queues,
and the tools that are registered with the current plant.
When documents are published, these must be processed by a loader, or scheduler, before any
data from these published documents is available for use. Documents that have been submitted
to a loader, or scheduler, can be checked for their status in the load queues.

 View document history (on page 435)
 View documents in a queue (on page 378)
 View documents in load queues (on page 436)
 Use load options (on page 436)
 View authoring tools registered with the current plant (on page 437)
View document history

The History command allows you to display the publish and retrieve history of a document. The
command provides information such as when a document has been published and by whom,
when a document has been retrieved and by whom, and into what tool.
1. Right-click the document for which you want to display the publish and retrieve history.
2. Click History on the shortcut menu.
3. Review the history of the document.
View documents in a queue

You can view documents currently in the queue, the document statuses, and the order in which
the documents are queued.
Some document versions can be removed from the queue if the
SkipFailedDocumentsInLoad setting is enabled for the site. If SkipFailedDocumentsInLoad
is enabled, a document that successfully loads any previous failed versions of that document
are removed from the queue. For additional details, see Set Up SmartPlant Foundation Sites
and Modifying Site Settings in the SmartPlant Foundation Installation and Setup Guide.

Integration
View documents in load queues

Documents in the approval queue are waiting for approval to take place so that they can enter
the SmartPlant loader. Documents in the SmartPlant loader queue are waiting to be loaded into
2. Right-click a queue, and then click Show Documents on the shortcut menu.
The list contains documents from both the load and approval queues.
Use load options

Load Options allows you to add documents to the queue or remove documents that have failed
to load from the queue, or retry loading documents. Right-click a published document and select
Load Options from the shortcut menu.
To access Load Options, right-click a document in the queue and do one of the following:
The options available depend on the state of your document in the queue.
 Load Published Data - Add as published document to the SmartPlant Foundation queue.
 Load Published Data into Document Configuration - Publishes data into a document
configuration for verification before loading data into the plant.
 Remove from Queue - Removes a failed document or a document that has not been
processed from the load queue.
 Consolidate Document - Builds and populates the shared objects that exist between the
various tools and SmartPlant Foundation. Documents must be loaded before the document
can be consolidated into SmartPlant Foundation.
 Retry Load - Republishes to the queue to load.
 Retry Merge Delta - Resubmits the merge process to the queue.
 Retry Consolidate - Rebuilds, repopulates and shares consolidated objects between tools.
 Retry Load Into Document Configuration - Allows you to resubmit the published data
before loading the configuration.
 Show Failure - Displays document failure details.
 Merge Delta - Merges 3D graphic elements for published documents.
The system can be configured automatically. For details on configuring a Default
Workflow, see Learn about publish workflows (on page 450) or Allow users to publish
documents to a default workflow (on page 450).

Integration
View authoring tools registered with the current plant

The SmartPlant > Tool Participants command allows you to view a list of authoring tools that
are registered with the current plant, along with all information gathered during the registration
process. This information is helpful for knowing which SmartPlant Foundation plant is registered
with which tool and where that tool's corresponding plants are located.
 Click SmartPlant > Tool Participants.
This information is helpful for knowing which SmartPlant Foundation plant is registered
with which tool and where the corresponding plants for that tool are located.

Integration
Revising document
The document revision process is separate from the publishing process, making it possible to
revise a document locally and save it to the tool database without re-publishing the document.
You specify the revision using the Revise command. Revising a document creates a revision for
the document with major and minor set, depending on the revision schema selected. When
revising a document, you can modify the major and minor revision data on the document.
Functionality is now available to make revising a document more flexible within an integrated
environment. You can now change the revision scheme after a document has been published,
skip revision numbers, and manually add a revision number, then have it validated against the
revision scheme. It is now no longer required to assign a minor revision number. Also, revision
numbers from tools are supported even if the document has previously been revised in
Reserving Revision Numbers

The Revise functionality also provides an option that allows you to designate revision numbers
to the plant or to particular projects. For each document, you can reserve revision numbers at
the plant or project level. Using this feature, you can use the same document in different
projects, while still allowing the revision numbers to be sequential within each project.
For each project (or even at the plant level) you can reserve a certain number of revisions that
are held for that particular project. If the document is used within a different project and revised,
it is given either a later revision number or its own set of numbers.
Revise dialog box

Allows you to revise a document in the authoring tool without publishing it.
Boxes with a shaded background are read-only and cannot be edited.

Integration
Engineering Tool — Displays an authoring tool-specific dialog box that allows you to select
documents to add to the Selected documents list.
Delete — Removes the selected document from the Selected Documents list.
Selected documents — Displays a list of the documents selected to be revised. You populate
this list by selecting documents before activating the Revise command. You can click the Delete
button to remove documents from this list.
Revision Scheme — If you have selected a new document or a document for which no revision
scheme has been selected, choose the revision scheme to be applied from the list of available
options. If you have selected a document with a defined revision scheme, that scheme is
displayed here in a read-only format. Only revision schemes that are applicable to the
configuration (plant) or classification (document type) are available in the drop-down menu. If
none of the revision schemes are related to the configuration or classification, then all revision
schemes are available. For more information on revision schema configuration, see Configuring
Different Revision Scheme Strategies in the How to Configure Document Management guide.
Current Revision in Tool > Major — For existing documents, this box displays the current
major revision of the document, as defined in the authoring tool, in a read-only format. For new
documents, this box is empty.
Current Revision in Tool > Minor — For existing documents, this box displays the current
minor revision of the document, as defined in the authoring tool, in a read-only format. If the
revision scheme does not use minor revision, or if the selected document has not yet been
revised, this box is empty.
If you do not use the Minor box when revising a document for the first time, the
minor revision option will never be available for that document for future revisions.
Revise in Tool > Major — From this list box, choose the next available major revision number
for the document to revise it locally, without publishing the new information.
Revise in Tool > Minor — From this list box, choose the next available minor revision number
for the document to revise it locally, without publishing the new information. If minor revisions
are not supported for the document, no options are available in this list.
Next Major — Selects the next available major revision number for the document to revise it
locally, without publishing the new information.
Next Minor — Selects the next available minor revision number for the document to revise it
locally without publishing the new information.

 Learn more about revising documents (on page 440)
 Revise a document (on page 440)
 Revise a document in SmartPlant 3D (on page 442)
 Use minor revisions in SmartPlant P&ID (on page 443)
 Learn revision scheme behavior through scenarios (on page 444)
 Learn more about revising documents (on page 440)

Integration
Learn more about revising documents

The SmartPlant > Revise command allows you to select a document or documents from the
authoring tool to be revised, but not published.
Revising and publishing are two separate actions. Revising a document creates a revision for
the document with Major and Minor set, depending on the revision schema selected. If you are
working in an integrated environment, you cannot modify the Major and Minor revision data, but
you can modify the other revision information on the document.
Revise a document
1. From within the authoring tool, click SmartPlant > Revise. The Revise dialog box displays.
 This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard and if the authoring tool has implemented the
SmartPlant Foundation revision functionality.
 If you logged onto the authoring tool with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
 The documents that appear in the Selected documents list on the Revise dialog box
when it first appears are documents that were selected within the authoring tool before
you clicked the Revise command. Click Engineering Tool to add documents from
authoring tools. Click Delete to remove a document from the list.
 You can revise multiple documents at once by clicking Engineering Tool and adding
other documents from the authoring tools.
 If you skip revisions or change revision schemes while revising or publishing a
document, the Reserve Revisions in Foundation settings will not reflect the current
state.

Integration
2. For a new document or a document that does not yet have a defined revision scheme,
select the revision scheme you want to use from the Revision Scheme list.
 Any revision scheme that was previously assigned to a document can be changed even
if the document has been published or retrieved. For example, the original revision
scheme for a document was set as Rev01A, you can change the revision scheme to
Rev1A at any time.
 Revision schemes can be set at any level of the document hierarchy. For example, if
you select Equipment Documents from the top level of the tree, then select a
Revision Scheme, the revision scheme applies to all documents and all documents in
subfolders under Equipment Documents. If you select a folder, such as Equipment
Datasheets, then select a Revision Scheme, the revision scheme applies only to the
documents in that folder.
3. In the Revise in Tool section, select the next available major and minor revision numbers.
 Any revision numbers that have been reserved by another project are not available and
are skipped in the revision scheme, if applicable. For example, if the current version of
the document is B and the next three major revision numbers are reserved and shown
as not available for the document in all projects, the next available value displayed in
the Major list is F.
 To use revision numbers not reserved by another project, you can manually type the
revision number with which you want to start in the Major or Minor field. The Minor
number is optional.
 You can skip revision numbers not reserved by another project by selecting the revision
number in the Major list with which you want to start.
4. Click OK. The revised document is saved to the authoring tool database. The document
currently available for retrieval by other authoring tools is not updated until you publish this
revised document. The Revise command also reserves the revision number, if specified, in
the integrated environment. For a new document or a document that does not yet have a
defined revision scheme, select the revision scheme you want to use from the Revision
Scheme list.
Rev1A at any time.
you select P&ID Documents from the top level of the tree, then select a revision
scheme, the revision scheme applies to all documents and all documents in subfolders
under P&ID Documents. If you select a folder, such as P&ID, then select a revision
scheme, the revision scheme applies only to the documents in that folder.

Integration
Revise a document in SmartPlant 3D

You can revise drawings, reports, and 3D Model Data documents if you have registered your
plant using the SmartPlant Registration Wizard.
1. Open the Drawings and Reports task.
2. Right-click a document, and select Revise. The Revise dialog box displays.
 You can also multi-select documents in the Detail View, or select a folder in the
Management Console hierarchy to select all documents within the folder, if they all
have the same revision level, before selecting Revise.
3. If necessary, click Engineering Tool to add documents to the Selected documents list
or click Delete to remove a document from the list.
4. For a new document or a document that does not yet have a defined revision scheme,
select the revision scheme you want to use from the Revision Scheme list.
Rev1A at any time.
you select Equipment Documents from the top level of the tree, then select a
Revision Scheme, the revision scheme applies to all documents and all documents in
subfolders under Equipment Documents. If you select a folder, such as Equipment
Datasheets, then select a Revision Scheme, the revision scheme applies only to the
documents in that folder.

Integration
5. In the Revise in Tool section, select the next available major and minor revision numbers.
 Any revision numbers that have been reserved by another project are not available and
are skipped in the revision scheme, if applicable. For example, if the current version of
the document is B and the next three major revision numbers are reserved and shown
as not available for the document in all projects, the next available value displayed in
the Major list is F.
 To use revision numbers not reserved by another project, you can manually type the
revision number with which you want to start in the Major or Minor field. The Minor
number is optional.
 You can skip revision numbers not reserved by another project by selecting the revision
number in the Major list with which you want to start.
6. Click OK. The revised document is saved to the authoring tool database. The document
currently available for retrieval by other authoring tools is not updated until you publish this
revised document. The Revise command also reserves the revision number, if specified, in
the integrated environment.
7. Right-click the document and select Properties.
8. Go to the Revision tab and edit the values in the new revision row.
9. Update the document to update any document property title block information.
10. Re-publish the document. The document stored in SmartPlant Foundation is not updated
until you publish it.
Use minor revisions in SmartPlant P&ID

The following example explains how SmartPlant P&ID supports minor revisions. This example
creates a revision from a new P&ID document.
1. Click Revisions > New Revision.
If you logged on to the authoring tool with a user name that is not defined in the
2. On the Revise dialog box, select the revision scheme you want to use from the Revision
Scheme list. In this example, Rev1A is the revision scheme.
3. In the Major list under Revise in Tool, select 1. This is the first available major revision
number.
4. In the Starting Minor list under Reserve Revisions in Foundation, select A. This is the
first available minor revision number.
The Starting Minor and Revise in Tool > Minor fields become inactive once you
have selected the revision scheme, major number, and minor number. The minor number is
automatically set based on the major revision number and count.
5. Revise the document and keep the Major revision number as 1.

Integration
The minor revision number is automatically incremented and becomes B.
6. Revise the document and change the Major revision number to 2.

The minor revision number begins again at A.
Learn revision scheme behavior through scenarios

SmartPlant allows you to change revision schemes, skip revisions, and switch between using
and not using minor revisions. A number of dependencies, such as a tools revision scheme or
whether a document has other revisions, influence the behavior of a document when a revision
is created in SmartPlant Foundation.
In this example, a single document has one previous revision of B and lacks a minor revision
value. The revision scheme selected for the document is RevA01. The following shows some
possible revision scheme scenarios between the tool and SmartPlant Foundation:
 If the tool sets the major revision of the document as 3, SmartPlant Foundation sets the
initial available major revision as B because the revision scheme for the document is
RevA01 and the previous revision was B.
 If the tool sets the major revision of the document as D, SmartPlant Foundation sets the
initial available major revision as D. D is compatible with RevA01 and the next available
number skips to D.

Integration
 If the tool sets the major revision of the document as C, SmartPlant Foundation sets the
initial available major revision as C. C is compatible with RevA01 and the next available
number skips to C.
 If the tool sets the major revision of the document as B, SmartPlant Foundation sets the
initial available major revision as B, but also sets the version to 2 because a previous
revision of B exists.
 If the tool sets the major revision of the document as A, SmartPlant Foundation sets the
initial available major revision as B because the previous revision of the document was B. A
documents revision cannot be set to a value that is lower than the last revision.
The following examples describe scenarios for revising documents for an off-site project. These
examples include creating a revision for a new project document, publishing a new document
before revising, and revising existing documents that have revision schemes managed by the
tools, but could be compatible or incompatible with the revision scheme set in SmartPlant
Foundation.
Publishing in an integrated environment

When the SmartPlant Enterprise authoring tools are integrated, you must publish documents
containing the drawing data and relationships before the authoring tools can share this
information. The publishing process involves selecting a document to publish, assigning it to a
workflow (if necessary), and specifying a revision and version of the document (if necessary).
For most documents, the associated data is included in the publishing process.
When using Background publish to publish a large number of documents
simultaneously, some documents may not be published. This is usually the result of not having
enough available computer memory (RAM) to complete all the publishing tasks.
Published Documents dialog box

Allows you to search for an object by the object properties. The options that appear on this
dialog box vary, depending on what type of object you are querying for and how your model was
configured by your system administrator.
Options are available on all standard query forms. The availability of other options is determined
by the system administrator, who configures and manages forms, and depends on the type of
object for which you are searching.
Main details
Name - Displays the name of the published document.
Description - Displays the description of the published document.
Master document details

Category - Lists the document categories available for selection.
Type - Lists the types of documents available for selection.
Subtype - Lists the subtypes of documents available for selection.
Title - Displays the title of the published document.
Status - Allows you to select if the document for which you are searching is ISSUED or
RESERVED.

Integration
Document Publisher
Publisher - Lists the tools that are registered with SmartPlant Foundation. When publisher is
selected, the query lists the documents published by the tool.
Revision details
Revision scheme - Lists the revisions schemes available for the document.
Major revision - Lists the major revision numbers available for the document.
Minor Revision - Lists the minor revision numbers available for the document.
Status - Allows you to select if the document for which you are searching is CURRENT,
WORKING, SUPERSEDED or RESERVED.
Owning Group
Item owning group - Lists the owner of the published documents.
Related Items
Related Load Queue - Lists the load queues available for the published documents.

 Learn more about publishing in an integrated environment (on page 453)
 Publish SmartPlant Foundation data (on page 446)
 Query for a published document (on page 448)
 View drawing items in a published document (on page 449)
 Allow users to publish documents to a default workflow (on page 450)
 Learn about publish workflows (on page 450)
 Understand Load, Consolidated, and MergeDelta tasks (on page 451)
 Learn more about publishing in an integrated environment (on page 453)
Publish SmartPlant Foundation data

1. Click SmartPlant > <Application Type> > Publish.
For example, do one of the following:
 To publish a process data sheet, click SmartPlant > Process > IPDs > Publish.
 To publish an instrument index, click SmartPlant > Instrumentation > Publish.
SmartPlant Registration Wizard.

Integration
 The documents that appear in the Selected documents list on the Publish dialog box
when it first appears are documents that were selected within the authoring tool before
you clicked the Publish command.
2. Add any additional documents to the Selected documents list by using the Engineering
Tool, File System, or Find toolbar buttons.
(on page 440).
Documents.

Integration
Foundation.
Query for a published document

In the Desktop Client, you can perform a detailed search based on object properties for
published documents.
1. Click Query > Published Documents.

Integration
2. Enter the criteria for the query in the Published Documents dialog box.
3. Click Finish.
 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 QuickFind
menu.
 To save the query, click Save.
View drawing items in a published document

When you select a published document in the Desktop Client and display information about it
using the Expand Drawing Items command, a list view appears and shows all drawing items
related to a published document.
1. Right-click on a published document, such as a P&ID document.
2. Click Expand Drawing Items on the shortcut menu.
A list view appears displaying items, such as instrument, equipment, pipelines associated
with the P&ID.

Integration
Allow users to publish documents to a default workflow

The following provides an example for configuring SmartPlant Foundation to allow users to
publish documents to a default workflow.
1. In SmartPlant Foundation Server Manager, expand SmartPlant Foundation Server
Manager > SmartPlant Foundation Sites > <SmartPlant Foundation site name> >
Settings.
2. Right-click DefaultPublishWorkflow, then click Properties.

3. On the Properties dialog box, type the default workflow you want to use in the Property
value box.
If a Workflow is not selected on the Publish dialog box, then the default workflow
defined in SmartPlant Foundation Server Manager is automatically used during publish.
Learn about publish workflows

When a SmartPlant application publishes, the user can publish documents using a workflow.
The following list describes the delivered publish workflows and use cases for the workflows.
Workflow Workflow Description Workflow Use Cases

Auto-Correlate Compares the objects in a Use Auto-correlate
published document to the objects  When a publishing tool
that are already in SmartPlant does not have correlation
Foundation. If the object correlates functionality.

Integration
Workflow Workflow Description Workflow Use Cases

(by name) to an object with the  When a publishing tool
same shared object definition, does not retrieve.
automatically correlates the objects.
If the object can correlate to more
than one object through multiple
shared object definitions, a task is
placed in the To Do list to allow the
user to select the correlation.
AutoLoadPublish Generates a document load task Use AutoLoadPublish when
and consolidate task for the you intend to load the
publishing document. These tasks published document data into
are performed by the SmartPlant SmartPlant Foundation.
Foundation Scheduler.
AutoLoadPublishMerge Publish large 3D models. Creates Use AutoLoadPublishMerge
the published 3D document, loads when you intend to view or
the 3D data in SmartPlant navigate the complete plant in
Foundation, then merges these one 3D view.
object sets into a new composite
document that represents the entire
3D model.
Correlate Places published objects in the To Correlate works similar to
Do list. From the To Do list, the Auto-Correlate except you can
user manually correlates selected view the possible correlations
items. SmartPlant Foundation before the actual correlation
creates a shared object. takes place.
Publish Takes the document through an Use Publish when you want
approval step. Upon approval, it the published document
creates the document load and approved before it is loaded
consolidate tasks. into SmartPlant Foundation.
The approval step is added to
the To Do list.
PublishWithDocLoad Loads document into a document Use PublishWithDocLoad
configuration and submits when you want to view the
document to approval step. Upon document data in SmartPlant
approval, it creates document the Foundation before approval.
load and consolidate tasks. The approval step is added to
the To Do list.
Understand Load, Consolidated, and MergeDelta tasks

A tool published document results in a document version object in SmartPlant Foundation. A
document version has four files attached to it.
1. Data XML file – Contains published objects, relationships and correlations (SameAs
relationships).
2. Meta data XML file – Contains meta data about the published document version.

Integration
3. Instructions XML file – Contains instructions for deleted objects and relationships. Also
contains resurrect instructions for objects that were deleted previously and resurrected as a
result of restoring a tool database.
4. View file – This is a file in the tool format that represents the (graphical) view of the
published document.
When a document is submitted to a workflow that has a load process step, the following tasks
are created.
If the document is not published to such a workflow, and when the Load document
command in SmartPlant Foundation Desktop Client is run on the published document, the same
tasks are created.
 Load Task - This task processes the objects and relationships in the data XML by loading
them into a publish domain. This task also processes the instructions in an Instructions XML
file. For example, the delete instruction would result in termination of the object referenced in
the delete instruction.
 Consolidate Task - This task processes the correlations (SameAs relationships) in the data
XML file. A SameAs is a correlation relationship published by tools indicating that a
published object is identical to an object published by another tool. The correlation of the
object in the current publish domain (say, local object) to the external object (object
published by another tool in another publish domain) is done by creating a shared object in
the Data Warehouse domain. The local and external objects are linked through
SPFComprisedOf relationships; for example, one SPFComprisedOf relationship between the
local object and the shared object, and a second SPFComprisedOf relationship between the
external object and the shared object.
An object that is not correlated also has a shared object created in the Data
Warehouse domain in preparation for future correlation.
The consolidate task also creates a hidden file, known as graphical mapping file, which has
mappings between objects in the database and graphical elements in the view file. This file
is used by SmartPlant Foundation Desktop Client for navigation between published objects
in the list view and their graphical representations in the view file.
 MergeDelta Task - This is a task created for delta publishes of SmartPlant 3D. A delta
publish contains new, modified and deleted objects in a document since the last publish of
that document. Only SmartPlant 3D has the capability to do a delta publish. Other tools
publish full data where every object is published whether it is modified or not since last
publish.
Since a delta published data XML file and view file only contains the delta, it is required that
it becomes a full data XML and full view file for complete view of the data and graphics of
that document. The MergeDelta task converts the delta data XML file into a full XML file by
merging data from the previous full XML file into the delta XML file.
When you publish a 3D model, you must enable the Scheduler and Loader to
make the 3D model data document retrievable. The load, consolidate, and merge tasks
must complete successfully before the 3D model document can be retrieved. For more
information, see Schedulers and Queue Management (on page 375).
If you are using SmartPlant Basic Integrator, only the merge task must complete
Schedulers and Queue Management (on page 375)..
The merge involves the following:
a. Replace modified objects and relationships in the full publish XML, view file, and the
hidden graphic map file.

Integration
b. Delete objects and relationships that are identified in the delete, and move instructions
in the delta instructions XML file, view file, and the hidden graphic map file.
c. Add new objects and relationships to the full publish XML, view file, hidden graphic map
file.
d. Replaces the delta XML file in the vault with the updated full publish XML file, view file,
and the hidden graphic map file.
Learn more about publishing in an integrated environment

The authoring tools publish data in XML format. The publishing process places the XML file in
the appropriate vault and loads the data from the XML files to the SmartPlant Foundation plant.
After the document is published, users can retrieve the data from the XML file in the SmartPlant
Foundation vault into other authoring tools.
When you publish documents, the software:
 Creates a new master document and the first revision on the initial publish for a particular
document. From that point on, the software creates new versions and revisions when the
document is subsequently published. The software relates revisions to the master
document. You can publish subsequent revisions into a workflow, which can be a different
workflow than assigned in the original publish. Changes in the document status of a related
revision change the status of the subsequently published versions and revisions of the
document.
 Publishes a visual representation of the document that you can view without the authoring
tool. For many Intergraph applications, this is the application's native format. The viewable
file can also be an Excel workbook or another viewable file type, such as PDF or DOC. You
can review the visual representation of the document, which is attached to the document
revision, using SmartPlant Markup Plus or SmartPlant Review. You can also mark up the
visual representation of the document using SmartPlant Markup Plus.
 Publishes associated data, depending on workflow approval. If the data is approved and
loaded, it is used for reporting and subsequent retrieval by downstream applications when
the authoring tools retrieve the latest data. The published data is not enough to re-create the
document in the originating authoring tool. Some document types are published without the
associated data, such as reports from authoring tools (for example, line lists in SmartPlant
P&ID). You can submit documents published without data to workflows just like documents
with data. The document types and data that you can publish depend on the authoring tool
you are using.
 Places the published XML file and any view files in the appropriate SmartPlant Foundation
vault. This XML file can be retrieved when users in the authoring tools retrieve as-published
data.
 Sends notification to the publishing tool.

 Reasons to publish (on page 455)
 Publishing documents (on page 455)
 Publishing files without data (on page 457)
 Revisions and versions of publishing documents (on page 457)

Integration

Integration
Reasons to publish
You can publish documents and associated data for several reasons:
 Exchange and enhance data among tools, to avoid creating data multiple times in multiple
authoring tools.
 Report on common data originating in multiple tools.
 Provide enterprise-wide accessibility to published documents.
 Manage change, including workflow history and document revision management.
You can also publish documents to share information with users in other tools without going
through a formal workflow. To share data, you can publish a document to a "for sharing"
workflow that has only a load step, so that the data is made available to other authoring tools as
soon as you publish the document.
You can also publish a document by not assigning the document to a workflow, but rather by
using the default workflow from SmartPlant Foundation. When you do not select a workflow for a
document during publishing, the SmartPlant Loader loads the document as soon as it reaches
the top of the Loader queue.
Publishing documents
Each authoring tool publishes different documents and data.
The plant breakdown structure (PBS) document, published by SmartPlant Foundation, contains
information about the physical plant with a structure consisting of a plant, areas, and units. The
default structure is plant/ functional area/ functional unit, but you can define a custom hierarchy
by using the Schema Editor. When a PBS document is published from SmartPlant Foundation,
the authoring tools are notified about the plant, areas, and units that need to be created in each
authoring tool.
The following list contains each SmartPlant Enterprise authoring tool and the document types
published by each of those tools by default. The types of documents that you can publish
depend on the authoring tool you are and whether you are using a full integration system or a
basic integration system. Full integration includes SmartPlant Foundation as the data repository;
basic integration uses SmartPlant Basic Integrator for data exchange and has no data
repository. You can configure the software to publish additional types of data and documents.
SmartPlant Materials
 Purchase Orders (view files only)
 Requisitions (view files only)
PDS
 Design Review Files
 Isometric Drawings (view files only)
 Orthographic Drawings (view files only)
 Reports (view files only)
SmartPlant 3D
 3D Model Data (SmartPlant Review File Type)
 Model Data Filtered for Cable Schedule Data (SmartPlant Review File Type)
 Isometric Drawings (view files with links to data)
 Orthographic Drawings (view files with links to data)
 Reports (view files with links to data)
SmartMarine™ 3D

Integration
 3D Model Data (SmartPlant Review file type)

 3D Cable 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)
SmartPlant Electrical
 Cable Schedule Reports
 Electrical Signal I/O Lists
 Excel Reports
 Instruments and Cabinets Requiring Electrical Power Supply
 Schematics (view files only)
 Single-Line Diagrams (view files only)
SmartPlant Engineering Manager
 Does not publish
 Equipment Lists (published as Equipment Data Sheets; full integration only)
 Instrument Process Data Sheets (IPDs; full integration only)
 Instrument Master Lists (published as Instrument Indexes; full integration only)
 Plant Breakdown Structures (PBS)
 Project Breakdown Structures (full integration only)
 Project Definition Documents (full integration only)
 Project Lists (full integration only)
SmartPlant Instrumentation
 Browsers (view files with links to data)
 Dimensional Data Sheets (DDPs)
 Electrical Tag Signal Lists
 Enhanced SmartLoop Reports (view files only)
 Instrumentation Requiring Electrical Power Supply
 Instrument Indexes
 Instrument Process Data Sheets (IPDs; view files only)
 Instrument Specification Sheets (view files only)
 Select Wiring Reports (view files only)
SmartPlant P&ID
 P&IDs
 Reports (view files only)
SmartSketch
 Drawings (view files only)
Aspen Basic Engineering
 Equipment Data Sheets
 Equipment Lists (published as Equipment Data Sheets)
 Process Flow Diagrams (PFD)
 Stream Data Sheets (published as Equipment Data Sheets)

Integration
Publishing files without data

You can also browse to and publish other file types, such as Microsoft Word, Microsoft Excel, or
SmartSketch files. These documents are always published without data. The primary reason to
publish documents without data is so that you can manage document changes and reviews
using workflows, and view the document electronically using the SmartPlant Foundation change
management functionality.
Revisions and versions of publishing documents

The first time you publish a document, the software creates a new document master and the first
revision in SmartPlant Foundation. A revision (major) is an officially recognized change to a
document. A version (minor) is an intermediate update that you have published. Revisions can
be published for sharing, or they can go through the approval process, depending on your
needs. Each revision of a document can have multiple versions.
After the first publish of a document, the software creates new versions and revisions.
Subsequent revisions are related to the master document and stored as revisions. Subsequent
revisions are also published into a workflow, which may be a different workflow than the original
publish. It is not possible to publish into a specific step of a workflow, so each overall workflow
must be divided into logical sub-workflows.
Some tools, such as SmartPlant Instrumentation, provide the ability to manage revision
information and display it in the title block. When you enter the revision information (revision
number, description, and so on) in the tool, that information is published with the document and
is used to define the revision. If the tool does not provide this, you can select this information
from the available list during the publish process.
Changes in the document status of a related revision change the status of the master document.
When you publish data from an authoring tool, you may not be able view all the
properties that you published in the SmartPlant Foundation client. You can customize view
definitions to allow you to see additional properties. For more information about defining view
definitions in the SmartPlant Schema, see Working with View Definitions and Create a View
Definition in the Schema Editor User's Guide. For further assistance with visualizing data in
SmartPlant Foundation, contact Intergraph Support Services
(http://ppm.intergraph.com/services/support.asp).
Publishing large 3D models in SmartPlant Foundation

Publishing large 3D models to SmartPlant Foundation can exceed memory resource limitations
of the publishing computer. To make publishing some large 3D models possible, you can divide
the large model into separate smaller models using filters in SmartPlant 3D. The separate
smaller models are treated as one large 3D model (known as a Composite Model) by
SmartPlant Foundation for the purpose of viewing. The scope of the filters should be defined to
avoid overlaps resulting in duplicated objects when viewing a composite model, which causes
duplicate graphics in the 3D model.

 Learn more about publishing large 3D models to SmartPlant Foundation (on page 458)
 Maintain versions of the composite document in SmartPlant Foundation (on page 458)
 Publish the 3D model in SmartPlant 3D or SmartMarine 3D (on page 459)
 Publish the 3D model in PDS (on page 459)

Integration
 Publish the 3D model to AVEVA PDMS (on page 459)

 Query for a 3D composite document in SmartPlant Foundation (on page 459)
 View the 3D model in SmartPlant Foundation (on page 459)
 Create the 3D composite model manually (on page 459)
 Add or remove relationships for composite 3D documents (on page 461)
Learn more about publishing large 3D models to SmartPlant

Foundation
Publish these separate smaller models with a specific workflow configured to represent a
composite model. See your administrator to have a composite model workflow established for
you. The composite model workflow is the AutoLoadPublishWithMerge workflow. This
workflow has MergePublishedFile process step configured.
This workflow creates the published 3D document, loads the 3D data in SmartPlant Foundation,
then merges these object sets into a new composite document that represents the entire 3D
model. The name of the composite document created is the same as the name of the workflow,
for example, AutoLoadPublishWithMerge, to which the published 3D model is submitted. To
publish to different 3D model composite documents, you can copy the
AutoLoadPublishWithMerge workflow to a different document name.
If you have existing published 3D models in SmartPlant Foundation and want to merge these
into one representative model document, you can create a 3D composite document manually,
and then relate the published models to the document.
Any workflow can be configured to include the MergePublishedFile process step. It
allows you to use any workflow to consolidate 3D models. However, the name of the workflow
will be used as the name of the 3D model composite document. Contact your SmartPlant
Foundation system administrator to configure your workflows. For more information on
configuring workflows, see the How to Configure the Workflow Model guide.
Maintain versions of the composite document in SmartPlant

Foundation
The first 3D model published to the workflow (with process step MergePublishedFile
configured) creates a composite 3D document, the first version of the document, and copies the
3D model from the published 3D model.
Subsequent publishing of the 3D models into the same workflow result in the following actions:
 Create a new version of the composite 3D document.
 Merge the newly published 3D model into the existing composite 3D model.
 Attach the merged composite 3D model to the new version of the composite 3D document.

Integration
Publish the 3D model in SmartPlant 3D or SmartMarine 3D

SmartPlant 3D and SmartMarine 3D allow you to publish modified and new objects with the
Changes Only option. Publish tasks processed through the Changes Only workflow are
smaller compared to All publishes, and are queued to Load and Consolidate before the merge
operation. The merge operation combines the delta data with the previous complete publish
data. After the merge operation succeeds, the information is retrievable. The Changes Only
publishes are not retrievable. To retrieve a Changes Only publish, you must perform an All
publish, which only happens after the load and consolidate processes.
For information about publishing in SmartPlant 3D and SmartMarine 3D, see Publishing 3D Data
and Publishing Documents in the SmartPlant 3D Integration Reference Guide and SmartMarine
3D Integration Reference Guide.
Publish the 3D model in PDS

For information about publishing PDS documents, see Working with PDS Documents Sets in the
SmartPlant Foundation Model Loader User’s Guide.
Publish the 3D model to AVEVA PDMS

For information about publishing PDMS documents, see Working with AVEVA PDMS
Documents Sets in the SmartPlant Foundation Model Loader User’s Guide.
Query for a 3D composite document in SmartPlant

Foundation
1. In the Desktop Client, click Query > Composite 3DDocuments.
2. Under Select a classification, click the document type to query.
3. Type in the information to query to find a specific composite document, or click OK to return
all composite documents.
View the 3D model in SmartPlant Foundation

To view or navigate a consolidated 3D model, use the graphical navigation commands delivered
with SmartPlant Foundation. Commands available for viewing models are View Item in Model
and View Item in SmartPlant Review. For more information, see see Graphical Navigation (on
page 107).
Create the 3D composite model manually

Before publishing the 3D model, you must manually create the composite document in
SmartPlant Foundation. Once you publish your models, you can relate the model to the
composite document.
1. Click File > New > Composite 3D Document.

Integration
2. Under Select a classification, select the document type for the composite document.
3. Click Next.

Integration
information.
Select the Is PDS Document check box, if the document to be merged with the
composite document master is a PDS Document.
5. Click Apply or Finish.
Add or remove relationships for composite 3D documents

A published 3D model document that has been published without selecting a workflow, such as
the AutoLoadPublishWithMerge workflow, can be related to the composite document in the
following two ways.
 Drag the published 3D model onto the composite model.
 Right-click the published documents and select Merge File into Composite to open the
Merge into composite document dialog box. On the Merge into composite document
dialog box, select the composite document into which you want to merge the published
documents.
 Documents can only be merged if they are published documents, have viewable files
attached to them, and are the same file type. For example, you can only merge published
PDS documents that have attached viewable files with other published PDS documents that
have attached viewable files.

Integration
 If you try to merge a PDS document with a non PDS document and/or vice versa, an error
message appears .
Remove Relationship
The relationship between a 3D model and the composite document can be removed using the
Terminate Relationship command from the shortcut menu. This also removes any relationship
with published .zvf files and map files. For more information, see Relationship Management (on
page 229).
Retrieving in an integrated environment

When you retrieve documents into an authoring tool, you are retrieving the document data that
was published by another authoring tool. For example, in SmartPlant Instrumentation, you can
retrieve engineering information from a published P&ID into the SmartPlant Instrumentation
database.
Using the SmartPlant > Retrieve command in the authoring tools allows you to select a
document and retrieve it into that tool.

 Learn more about retrieving documents in an integrated environment (on page 462)
 Data handling after retrieval (on page 463)
 Document types for retrieval (on page 463)
 Design basis (on page 465)
 Retrieve and restore (on page 465)
 Retrieve in SmartPlant Foundation (on page 465)
Learn more about retrieving documents in an integrated

environment
You can retrieve a document in two ways:
 As published - Retrieves only the data the authoring tool originally published with the
selected revision and version of the document. Retrieving as-published data retrieves the
.xml file the authoring tool published from the appropriate vault.
 With the latest data - Retrieves the latest data associated with the selected document. If
another, more-recently published document contains updates to objects in the selected
document, the software retrieves the most current data for those shared objects. When you
retrieve the latest data, SmartPlant generates an .xml file containing the published data.

Integration
Data handling after retrieval

The authoring tool that you use also determines how the software deals with changes in
downstream data when you retrieve a document. SmartPlant P&ID, SmartPlant Instrumentation,
SmartPlant Electrical, and Aspen Basic Engineering analyze the impact of the newly retrieved
data on the existing database, and then place tasks on the authoring tool To Do list that allow
you to create, delete, or modify items at the appropriate time in the design process. The To Do
list gives you the opportunity to view and understand potential changes before accepting,
deleting, or modifying those changes. In SmartPlant 3D, you can view the P&ID using the View
> P&ID command to pull in the data and correlate items.
Document types for retrieval

The types of documents that you can retrieve depend on the authoring tool you are using and
whether you are using a full integration system or a basic integration system. Full integration
includes SmartPlant Foundation as the data repository; basic integration uses SmartPlant Basic
Integrator for data exchange and has no data repository. The following lists include the
documents that each authoring tool can retrieve by default. You can configure the software to
retrieve additional types of data and documents.
SmartPlant Materials
 3D Bill of Materials (BOM) Data (Piping and equipment data)
 Document View Files Published by Any Tool
PDS
 Does not retrieve
SmartPlant 3D
 Cable Schedule Reports
 Dimensional Data Sheets (DDPs)
 P&IDs
 Plant Breakdown Structure (PBS)
 Project Breakdown Structure (full integration only)
 Title Block Issue Information (full integration only)
SmartMarine 3D
 SmartPlant Electrical cable schedules
 SmartPlant Instrumentation dimensional datasheets (DDPs)
 Project Breakdown Structure
 Project lists
SmartPlant Electrical
 3D Model Data Filtered for Cable Schedule Data
 Electrical Tag Signal List
 Enhanced SmartLoop Reports (view files only)
 Instrumentation Requiring Electrical Power Supply
 P&IDs (Electrical Consumer Lists)
SmartPlant Engineering Manager
 Project Definition Documents (full integration only)

Integration
SmartPlant Instrumentation
 Electrical Power Element Reports
 Electrical Signal I/O Lists
 Instrument Process Data Sheets (IPDs)
 P&IDs
 Plant Breakdown Structure (PBS), if SmartPlant Engineering Manager is not used)
 Project Definition Documents, if SmartPlant Engineering Manager is not used (full
integration only)
 Schematics (view files only)
SmartPlant P&ID
 Equipment Data Sheets
 Equipment Lists (published as Equipment Data Sheets)
 Instrument Indexes
 Instrument Master Lists (published as Instrument Indexes)
 Process Flow Diagrams (PFD)
 Stream Data Sheets (published as Equipment Data Sheets)
SmartSketch
 Title Block Issue Information (full integration only)
Aspen Basic Engineering
 P&IDs
 Project Lists (full integration only)
All Authoring Tools
From the authoring tools, you can retrieve the plant breakdown structure (PBS) and project
documents. The PBS and project documents, created in and published by SmartPlant
Foundation, are retrieved by authoring tools to provide information about the plants, areas, units,
projects, and contracts that need to be created in the authoring tool so that the information is
consistent across all authoring tools.
The PBS document published by SmartPlant Foundation contains information about the physical
plant whose structure consists of plants, areas, and units. The default structure is
plant/area/unit, but you can define a custom hierarchy in the Schema Editor.
 Retrieving the project breakdown documents and the PBS into SmartPlant Engineering
Manager creates the appropriate structures automatically for SmartPlant P&ID, SmartPlant
Electrical, or SmartPlant Instrumentation (if SmartPlant Engineering Manager is used).
 When using the SmartPlant Instrumentation Administration module instead of SmartPlant
Engineering Manager to define the PBS for SmartPlant Instrumentation, you must create the
plant hierarchy according to the PBS information in SmartPlant Foundation before you
retrieve either the PBS or the project definition document. You must create at least one plant
hierarchy item at the lowest level, such as a unit, before you can retrieve the PBS and
project definition document.
 When you retrieve a project list in SmartPlant 3D, a new project is created only if the
SmartPlant Foundation status on the project is Created or Active.
 To ensure that pipelines from a retrieved P&ID appear in the SmartPlant 3D Workspace
Explorer, you must specify the value SmartPlant 3D for the Use Piping Specification
property in SmartPlant P&ID Options Manager.

Integration
Design basis
Objects that tools retrieve from other authoring tool documents can become the design basis for
objects in downstream documents. Objects that become the design basis for other objects can
be specific objects that get richer as they move through the lifecycle or can be schematic or
logical objects in one application that evolve into more detailed objects downstream.
Design basis is implicitly based on retrieval; you do not have to define it. For example, a pump
retrieved from a PFD becomes the design basis for a pump in the P&ID. When you change
common properties for the pump and retrieve the changes into SmartPlant P&ID, tasks to
update property values automatically appear in the To Do List. The same process works for
logical items that are a design basis for other items, such as a stream in Aspen Basic
Engineering that results in multiple pipe runs in SmartPlant P&ID.
Retrieve and restore

The retrieval process in SmartPlant 3D supports restore. For example, when another application
has been restored to a previous state, the SmartPlant 3D design basis objects are deleted and
re-created upon retrieve. To avoid duplicating 3D objects, the retrieval process checks systems,
pipelines, and projects/contracts to see if they already exist with the same name and type as
design basis objects. If so, the software correlates to the objects upon retrieve rather than
creating new objects.
After the retrieve operation, you must re-correlate the other 3D objects (besides systems,
pipelines, and projects/contracts) with the new design basis objects.
Retrieve in SmartPlant Foundation

1. Click SmartPlant > <Application Type> > Retrieve.
For example, to retrieve process data, click SmartPlant > Process > IPDs > Retrieve. To
retrieve instrument data, click SmartPlant > Instrumentation > Retrieve.
SmartPlant Registration Wizard.
 The Retrieve command searches the SmartPlant Foundation plant for documents that
are ready to be retrieved into the authoring tool. These documents appear in the
Documents to retrieve list on the Retrieve dialog box.

Integration
Clear All.

Integration

SECTION 20
Concurrent Engineering
Concurrent Engineering is managing the life cycle of major assets in the plant effectively. It
governs the method in which change is made to the asset, and considers the impact change has
on the asset itself, operating production, and cost.
Use concurrent engineering

Concurrent Engineering in SmartPlant Foundation allows you to create, view, modify, and delete
changes within a particular plant configuration, without affecting the as-built data.These
long-term transactions may span days, weeks, or months, while controlling changes to the data
and the original data.
To initiate a change, the user claims data from a plant into a project and makes changes, such
as updating items, deleting items, and creating new items in the project. When complete, the
data is merged back into the plant.
To make changes in a project, or lower configuration, items or documents must first be claimed
or revised into that configuration. SmartPlant Foundation can implicitly claim items from the plant
into an active project configuration when running commands that update these objects.
SmartPlant Foundation can be configured for explicit claiming to force all users to claim objects
before editing them. Or, items can be claimed exclusively preventing them from being modified
in another parallel configuration. You can configure SmartPlant Foundation to force all users to
work in exclusive mode.
When working in non-exclusive mode, parallel changes can be made to the same item. As a
result, the design basis of a claim may be changed by data merged from another parallel project
or by a change made to the design basis itself within the plant configuration. This makes the
design basis of the first claim now out of date and requires that conflicts be resolved prior to
merging another project into the plant.
Claim dialog box

Allows you to claim objects in a lower configuration, such as a project, without impacting the
as-built configuration.
Mandatory objects:
Name - Displays the name of the objects claimed.
Description - Displays a description of the objects.
Class Definition - Displays the class definition for the objects.
Status - Displays the current status of the object.
Previously Claimed To Configuration - Displays whether the object has been previously
claimed to a configuration.
Optional objects
Name - Displays the name of any tags related to a system that has been claimed and allows
you to select which tags to claim with the system.


Previously Claimed To Configuration - Displays whether the object has been previously
claimed to a configuration.
Collapse All - Collapses the object and all relationships to the highest object level for display.
Merge dialog box

Allows you to merge objects changed at the project level back to the as-built plant.
Mandatory objects
Rel Name - Displays the name of the relationship definition.
Name1 - Displays the name of the object that appears at the first end of the relationship
definition.
Name2 - Displays the name of the object that appears at the second end of the relationship
definition.
Unclaim dialog box

Allows you to release objects from the control of a project.
Mandatory objects:
Rel Name - Displays the name of the relationship definition.
Name1 - Displays the name of the object that appears at the first end of the relationship
definition.
Name2 - Displays the name of the object that appears at the second end of the relationship
definition.

 Change user preferences for a claim (on page 471)
 Claim an object (on page 471)
 Claim an issued document (on page 474)
 Merge a claimed object into the plant (on page 474)
 Merge a complete configuration (on page 475)

 Unclaim an object (on page 475)

 Subscribe to claim notifications (on page 475)
Change user preferences for a claim

2. Click the Claim tab.
3. To force an exclusive claim, select the Exclusive claim option. An exclusive claim means
that items may be claimed into only one configuration at a time.
This applies to both tags and documents.
4. To force an explicit claim, select the Explicit claim option. An explicit claim means that you
must use the Claim command to claim an object into a sub-configuration to modify it. See
Claim an object (on page 471) for more information.
This option does not apply to documents.
5. If you want the software to present you with a confirmation dialog box before claiming an
object, select the Implicit claim confirmation option.
 This option does not apply to documents.

 This is the default claim option if neither Exclusive claim nor Explicit claim are
selected.
 The confirmation box notifies you that the action you are performing will cause the
system to claim the object first. For example, if you update a tag in the project
configuration, the system first claims the tag to the project.
The options on this tab are user-level settings and may be overridden by system-wide
preferences set by your system administrator.
Claim an object
The Claim command allows you to claim objects in a lower configuration, such as a project,
without impacting the as-built configuration.
1. Query for the object you want to claim. For example, select Query > Tag.
Before you can claim an object to modify in a project, you must set your active scope
to the project.
2. Right-click the object that you want to modify.

3. On the shortcut menu, click Concurrent Engineering > Claim.
The Claim dialog box displays. Verify that the object is being claimed to the proper project.
Select the Collapse All check box to hide the details of the selected objects.
If you attempt to claim an object without properly setting your configuration, an error
message appears.

4. Right-click the object, then click Update to make changes to the object.

Claim an issued document

1. Query for the document you want to claim. In this example, we will use Query > Design
Document.
 Documents can only be explicitly claimed.

 Documents can only be claimed if the status is ISSUED.
 Before you can claim a document to revise in a project, you must set your active scope
to the project.
2. Right-click the document, then click Revise to make changes.
3. Click Finish to complete revising the document.
The revision appears in the New Items window.
4. Right-click the document in the New Items window, then click Concurrent Engineering >
Compare Object to Higher Configuration.
The Object Compare dialog box displays. You can review the differences between the
revised document at the project level and the document at the plant level.
When changes are complete, you can merge the document back into the plant
configuration. See Merge a claimed object into the plant (on page 474).
Merge a claimed object into the plant

The Merge command allows you to merge claimed objects back into a higher configuration,
such as a plant. You can merge:
 Selected items within a configuration
 A complete configuration
 Selected items or a configuration in batch or scheduled mode
 Through a workflow process step
1. Right-click a claimed object, then click Concurrent Engineering > Merge.
If the Merge command does not appear on the shortcut menu, you have a conflict
between your claimed item and the design basis. You must resolve conflicts before the
Merge command appears.
2. On the Merge dialog box, select the objects to merge and then click OK.
Select the Collapse All check box to hide the details of the selected objects.
A dialog box displays confirming the successful merge.
3. Set your scope to the appropriate plant.
4. Click Find or Query on the object to verify your changes appear at the plant level.

Merge a complete configuration

1. In the Tree pane, right-click the plant into which you want to merge a configuration, then
click Show Projects.
2. Right-click the project, then click Concurrent Engineering > Merge on the shortcut menu.
3. A message appears to confirm that you wish to perform the merge. Click OK to continue.
Administrators can configure this message box. Refer to How to Configure

Concurrent Engineering Guide for more information.
A dialog box appears confirming the successful merge.
Unclaim an object
The Unclaim command allows you to release objects from the control of a project.
1. Right-click a claimed object, then click Concurrent Engineering > Unclaim.
2. On the Unclaim dialog box, click OK.
Subscribe to claim notifications

In SmartPlant Foundation, you can register your interest in specific events related to changes to
the design basis or parallel claims on an item.
For more information about subscribing to receive notifications, see Change Notifications (on
page 311).
Resolve conflicts and generate reports

No item or document can be merged into the plant if its design basis has been superseded by a
merge from another project or a change has been made at the plant level. Conflicts must be
resolved before a merge is allowed. Conflicts can be resolved by comparing an object or
document revision with the object or document at the plant level to show differences and
updates to data compared to its parent design basis.
Object Compare dialog box

Displays an ad-hoc report that shows the changes in the project, or lower configuration,
compared to the as-built data in the plant.
Name - Displays the name of the object being compared to the as-built data and its interface
definitions.
Class Def - Displays the class definition for the objects.
High config value - Displays the value of the object for the as-built plant.

Low config value - Displays the value of the object for the project, or lower configuration.
Value as Claimed - Displays the value of the object at the time it was claimed.
Status - Displays the current status of the object and in which configuration it was changed.
Resolve Conflicts dialog box

Allows you to select the changes in the project, or lower configuration, that you want to merge to
the as-built data in the plant.
Name - Displays the name of the object being compared to the as-built data and its interface
definitions.
Class Def - Displays the class definition for the objects.
High config value - Displays the value of the object for the as-built plant.
Low config value - Displays the value of the object for the project, or lower configuration.
Value as Claimed - Displays the value of the object at the time it was claimed. This value can
be different than the as-built value if the object was claimed and modified in another project, but
not yet merged back to the plant.
Status - Displays the current status of the object and in which configuration it was changed.
Accept All Objects - Selects the check box beside the name of each object but does not select
check boxes by specific properties.
Accept All - Selects all objects and relationships to resolve for merging to the as-built data in
the plant.
Clear All - Clears all objects and relationships.

 Compare object to a higher configuration (on page 476)
 Resolve conflicts (on page 477)
 Generate a configuration report (on page 478)
 Generate a future changes report (on page 478)
 Generate a merge validation report (on page 478)
Compare object to a higher configuration

The Compare Object to a Higher Configuration command generates an ad-hoc report that
shows the changes in the project, or lower configuration, compared to the as-built data in the
plant.
 Right-click the claimed object, then click Concurrent Engineering > Compare Object to a
Higher Configuration.

The Object Compare dialog box displays showing the differences between the object
claimed at the project level and the object as-built at the plant level.
Resolve conflicts
1. Right-click the object that has a conflict with the design basis, then click Concurrent
Engineering > Resolve Conflicts on the shortcut menu.
A conflict exists if the design basis has been updated since the object was claimed. A
conflict also exists if the item was claimed into a parallel configuration, modified, then
merged back into the design basis.
2. On the Resolve Conflicts dialog box, select the check boxes beside properties for which
you want to replace the current project value with the values at the higher configuration, or
plant. Clear check boxes for properties where you want to keep the current value in the
lower configuration, or project.
 Accept All selects all the check boxes.

 Clear All clears all the check boxes.
 Accept All Objects selects the check boxes beside the names of objects in the list but
does not select the check boxes beside any specific properties. As a result, those
properties will keep the value from the project level.
3. Click OK to apply the changes and resolve the conflicts.

After you resolve the conflicts for an object, you can merge it from the project to the plant.
For more information, see Merge a claimed object into the plant (on page 474).

Generate a configuration report

The View Configuration Report command generates an ad-hoc report that provides
information about the selected configuration.
1. In the Tree pane, select the project, or lower configuration, for which you want to generate a
report.
2. Right-click the project, and click View Configuration Report.
Generate a future changes report

The View Future Changes Report command generates an ad-hoc report that provides
information about objects that can be merged into the plant configuration from any project, or
lower configuration.
1. In the Tree pane, select the plant, or higher configuration, for which you want to generate a
report.
2. Right-click the plant, and click View Future Changes Report.
Generate a merge validation report

The View Conflicts Report command generates an ad-hoc report that shows all objects for
which conflicts have not been resolved.
1. In the Tree pane, select the project, or lower configuration, for which you want to generate a
report.
2. Right-click the project or plant, and click View Conflicts Report.


SECTION 21
Progress
Progress allows lead engineers, planners, project managers, and document controllers to plan
and report on the development of time-critical activities related to a project. It provides the
functionality to track the development of deliverables, such as documents or drawings, against a
project plan, indicating any deviations from the original plan.
Reporting functionality built into Progress allows you to report on man-hour budgets and the
man hours necessary to complete the deliverable, and to view progress at varying levels within
the project hierarchy.
When deliverables are registered with the progress functionality, they are assigned to a
workpack, which is a group of deliverables that share project information and steps within their
lifecycle. Workpacks are based on a hierarchy defined for the progress project, and deliverables
are matched with a workpack based on that hierarchy.
View Progress dialog box

Displays detailed progress calculations for historical rollups initiated manually and project cut-off
dates. Dates are organized by the last date when a rollup was run (Most Recent), defined cut-off
dates for the project, and other dates when a rollup was run manually. Expand a category in the
tree to view the dates for which progress details were calculated. Expand a date to see detailed
information calculated at that time. The details can be viewed at the project level, or you can
view details at each level of hierarchy by specifying design or activity progress. Select the node
that represents the level at which you want to view the data, and then use the View Progress
command on the shortcut menu to view the details.
Progress Rollup S-Curve dialog box

Shows a graphical representation of the progress information, including the planned, actual, and
forecast data, when applicable. Cut-off dates make up the x-axis, and percent complete makes
up the vertical axis.

 Calculate progress (on page 482)
 Report progress (on page 482)
 Configure the progress model (on page 483)
 Find an existing design workpack or design workpack template (on page 483)
 Find an existing activity (on page 484)
 Find an existing set of progress options (on page 484)
 Freeze plan dates (on page 484)
 Redistribute man hours (on page 484)
 View progress data (on page 485)
 View progress data graphically (on page 485)
 Export progress data to Excel (on page 485)

Progress
Calculate progress
Progress is calculated at every level of the hierarchy, which means that at any time, you can
calculate the percentage complete of any deliverable and the workpack to which it is assigned.
However, by using a system of weighting values, you can see what the progress of each
deliverable means to the entire project, or any individual level in the hierarchy.
The lifecycle of each deliverable is broken down into individual, defined steps, and each step
has a weighting that indicates how much of the work of completing the deliverable that step
represents -- how close to completion the deliverable is when that step is complete.
The same weighting system is used at every level of the hierarchy, so you can see also what
portion of the workpack each deliverable represents.
Report progress
Progress is calculated on a schedule you define using cut-off dates throughout the length of the
project. On each cut-off date, the progress of each deliverable and each workpack is calculated
and stored. This information is then available for viewing or reporting. In addition to these
official, scheduled cut-off dates, you can run manual roll ups at any time. Manual rollups create
non-official cut-off dates that can be used or ignored in official reporting.
Progress example
The following example is just one basic way to use the Progress functionality.
Five SmartPlant P&ID drawings are created and ready to be tracked with Progress. The planner
creates a workpack for that package of P&IDs. The workpack defines the basic steps that each
P&ID drawing must complete before the drawing is finished. The completion of each drawing
has four steps: Start, Issue for Review, Issue for Construction, and Issue to As-Built. Each of
these steps is assigned a weighting, as shown below:
Step Weighting
Start 0%
Issue for Review 20%
Issue for Construction 50%
Issue to As-Built 30%
These weightings indicate that when a document has been issued for review, that document is
20% complete (the sum of all completed steps). When it has been issued for construction, it is
70% complete (0% + 20% + 50%), and it is finished once it has been issued to As- Built. The
Start step has no weighting, so when it is completed, no progress has been made; however, it
does allow you to indicate that work on that deliverable has begun. The sum of the weights
assigned to all steps should be 100 to represent the document is 100% complete.
Similarly, each deliverable in the workpack is given a weighting that indicates how much of the
workpack task it represents. See the table below:
Deliverable Weighting
Doc-001 5%

Progress
Deliverable Weighting
Doc-002 5%
Doc-003 20%
Doc-004 30%
Doc-005 40%
These weightings indicate that much more work is involved in completing documents Doc-003,
Doc-004, and Doc-005 than Doc-001 and Doc-002. Therefore when you view progress data for
the entire workpack, the completion of the first two documents does not weigh as heavily as the
progress of the last three.
The following table shows the progress data for this workpack over the first five cut-off dates
defined for the project. The table provides the percentage complete for each deliverable,
according to which steps have been completed, and the bottom row reflects the percentage of
the entire workpack that is complete, using the completion percentages for each deliverable and
its weighting in the workpack.
Configure the progress model

Refer to the How to Configure the Progress Model guide for details about configuring and
administering progress functionality for design and activity deliverables in SmartPlant
Foundation.
Find an existing design workpack or design workpack

template
1. Click Find > Progress > Design Workpack or Find > Progress > Design Workpack
Template.
2. On the Find dialog box that displays, type the name of the object for which you want to
search.
You can enter the entire name, part of the name, a wildcard (%, *, or ?), or a
If you want to create a more detailed search or to search by hierarchy, select one of the
options on the Query > Progress menu and provide specific details for the search.

Progress
Find an existing activity

1. Click Find > Progress > Activity.
2. On the Find dialog box, type the name of the activity for which you want to search.
If you want to create a more detailed search or to search by hierarchy, select one of the
options on the Query > Progress menu and provide specific details for the search.
Find an existing set of progress options

1. Click Find > Progress > Progress Options.
2. On the Find dialog box, type the name of the option set for which you want to search.
If you want to view the current values for a set of progress options, right-click the
progress options object, and click Details.
Freeze plan dates

You can prohibit updates to the plan dates of a workpack by using the Freeze Plan Dates
command. Right-click a workpack in the List View and select Freeze Plan Dates from the
shortcut menu to freeze the plan dates of a workpack. When the plan dates of a workpack are
frozen, they are set to read-only, and users cannot change the plan dates when they update
progress for the deliverables.
To allow plan date updates to the deliverables of a workpack that has been frozen, right-click a
workpack with read-only dates in the List View and select Unfreeze Plan Dates.
Redistribute man hours

Man hours assigned to a workpack are shared among the deliverables, based on the weighting
of each deliverable. However, if you update the workpack by, for example, adding a deliverable,
it may be necessary to recalculate the distribution of man hours among the deliverables.
Use the Redistribute Man-hours command, available from the shortcut menu of a workpack, to
update the allocation of workpack man hours among the deliverables.
For example, WorkpackA is assigned 1000 man hours and has two deliverables registered to it:
Deliverable1, which has a weighting of 40, and Deliverable2, which has a weighting of 60.
Deliverable1 is allocated 400 man hours, and Deliverable2 is allocated 600 man hours. Another
deliverable, Deliverable3 is registered to the workpack. Deliverable3 has a weighting of 100. The
addition of Deliverable3 changes the allocated weighting of the workpack. Deliverable1 and
Deliverable2 should now get a smaller share of the budgeted man hours; Deliverable1 gets 200
man hours, Deliverable2 gets 200 man hours, and Deliverable3 gets 500 man hours. This does
not happen automatically for all workpacks. You must use the Redistribute Man-hours
command to recalculate the latest deliverable man hours.
If one or both of the Progress options Workpack weighting redistribution or
Deliverable weighting redistribution is set to True, it is unnecessary to manually redistribute

Progress
the man hours for a workpack. These options indicate that the redistribution of man hours
happens automatically when the weightings of the workpack or its deliverables are updated.
View progress data

The Progress > View Progress command opens the View Progress window where you can
view the status of historical rollups and project cut-off dates.
1. Click Progress > View Progress.
2. In the tree on the left side of the window, browse through the dates to the node of data you
want to view.
3. Right-click the node, and click Show Progress on the shortcut menu.
You can view the most recent progress information, or you can view the progress
information calculated on any of the official project cut-off dates or any date on which a manual
rollup was calculated.
Export progress data to Excel

1. Click Progress > View Progress.
2. Open the File menu on the View Progress window, and click Extract to Excel.
This command exports all the progress data into an Excel spreadsheet that you can sort
and modify for reporting purposes.
View progress data graphically

The Progress > View Progress S-Curve command opens the Progress Rollup window where
you can view a chart that graphs the planned, actual, and forecasted progress over time, using
the official cut-off dates.
 Click Progress > View Progress S-Curve. The Progress Rollup dialog box appears.

Progress

SECTION 22
Loader
The Loader allows you to use Extensible Markup files (XML), delimited text files (.NLF or .TXT
files), or Microsoft Excel files to import data, relationships, and configuration information into the
System administrators use the Loader to perform the following tasks:
 Import the SmartPlant schema into the SmartPlant Foundation system administration
database when the SmartPlant schema changes.
 Export the data in the SmartPlant schema to an .XML file in preparation for reloading the
schema.
 Delete everything specific to the SmartPlant schema from the system administration
database tables in preparation for reloading the schema. However, deleting the SmartPlant
schema does not delete users, methods, and so on that are not loaded with the SmartPlant
schema.
The Loader command allows you to process XML and text load files in order to add objects and
relationships to the SmartPlant Foundation database. After the load files have been processed,
you can view your load results and exceptions report from the Load Results window.
The Loader connects with the data warehouse, administers the load, applies lifecycle
information, performs error handling, and creates reload files. This utility acts as a middle tier
between various data sources and the calling program objects. Loader reduces the number of
load programs by reusing the calling program objects directly.
The Loader interface contains the following areas: the Directory area where you can browse
and select your files to load; the Selected load files area with up and down arrows to allow you
to control the load order; and the Processed load files area where you can view information
about the processed load files.
Loader Dialog Box

Allows you to load data into SmartPlant Foundation using structured files containing the input
data.
Directory - Allows you to select the files for processing. Click to browse to the files to load.
Selected Load files - Lists the names of the files to be loaded.

Loader
Move Selected Item Up - Moves the selected file up one position. Click to move the
selected file.
Move Selected Item Down - Moves the selected file down one position. Click to move the
selected file.
Process Load Files

Name - Displays the name of the load file
Container - Displays the container to which objects are related.
Created objects - Displays the number of objects created.
Updated objects - Displays the number of objects updated
Processed instructions - Displays the number of process instructions executed.
Unchanged objects - Displays the number of objects that are unchanged.
Failed objects - Displays the number of objects that failed to load
Process Time - Displays the amount of time to load the file.
Put objects in new items window - Displays new objects in the New Items window.
Process - Processes all files in the Selected load files list.
Load Results - Displays the results of the processed load files in the Load Results tree view.

 Create a load file (on page 488)
 Process a load file (on page 489)
 View and edit XML load files (on page 490)
 Load offline data sheets and data lists (on page 250)
Create a load file

There are several methods for creating load files:
 Manually, using a text editor such as Notepad or PFE
 Manually, using an XML editor such as PSPad
 Automatically, using the Export commands

Loader
Process a load file

1. Click Browse next to the Directory box, and then select the file or files you want to
load.
2. Click or in the Selected load files list to change the processing order.
3. Select the Put object in new items window option.

4. Click Process.
Results of the load appear in the Processed load files list.
5. Click Load Results to view the load process details.

Loader
A hierarchical view of the changes made during processing appears.
View and edit XML load files

You can view and edit the XML load file from the Processed Load Files list.
1. Right-click on the file you want to edit, click Edit.

Loader
2. The XML file appears in an Internet browser. Right-click the code, click View Source. The
file opens in a text editor.
3. Edit, save, or print the code from the text editor.
Load offline datasheets and data lists

Changes made in data sheets and data lists offline can be loaded into SmartPlant Foundation
using the File > Loader command in Desktop Client. The availability of this command depends
on your user role.
1. In the Desktop Client, select the appropriate user roles and configuration.
2. Click File > Loader.
3. Browse to the directory where the offline data sheets or data lists are stored.
4. Select the files to load (either the .xls or .xml version of the offline data sheet), and then click
Open. The files appear in the Selected load files pane.
If the data associated with this data sheet in the SmartPlant Foundation
database has been updated since this offline data sheet was generated, the software will
not load the data. The loader will provide an exception message that warns you that the
data you are trying to load is out-of-date.

Loader
5. Click Process. The Processed load files pane displays information about the load process
for each file.
6. Click Load Results to view load process details.
7. Click OK, and then click Close.

Loader
XML Format
The Loader supports XML files to create and update object and relationship data in SmartPlant
Foundation and to perform certain SmartPlant Foundation instructions.
The source of the SmartPlant Foundation model is defined in XML format files. These files
contain a header identifying the scope, component schema and container ID of its contents. It
uses standard XML format for defining objects, properties and relationships.
For example:
<Container CompSchema=''SPFReferenceComponent" Scope="Data"
ContainerID="Plant.Admin">
<FunctionalUnit>
<IObject UID="UNT_PlantA_U101" Name="U101" Description="Unit 101" />
<IFunctionalUnit />
<IPBSItemCollection />
<IPBSItem />
<IPlannedFacility />
</FunctionalUnit>
<Rel>
<IObject UID="UNT_PlantA_U101-DDCM_PlantA_C056-KV-P-XC-2002-01" />
<IRel DefUID="FunctionalUnitDeliverable"
UID2="DDCM_PlantA_C056-KV-P-XC-2002-01-42" OrderValue="0"
UID1="UNT_PlantA_U101" IsRequired="False" />
</Rel>
</Container>
XML Instructions
In addition to being able to create and update object and relationship data, the XML can be
constructed to perform certain SmartPlant Foundation instructions. SmartPlant Foundation
supports the following instructions:
 DeleteInstruction
 InsertInstruction
 UpdateInstruction
 SPFAttachWorkflow
 SPFClaimInstruction
 SPFUnClaimInstruction
 SPFGenerateFormInstruction
 SPFMergeInstruction
 SPFPrgRegisterInstruction
 SPFReclassifyInstruction
 SPFReviseInstruction
 SPFSignOffInstruction
An example of each instruction follows.
Delete Instruction
<DeleteInstruction>
<IObject UID="{f3edefd3-3a00-4360-a434-b19c4a825d5a}"
Name="Delete_SPFAuthSignature" />

Loader
<IRefObject RefClass="PropertyDef" RefUID="SPFAuthSignature"

RefName="SPFAuthSignature" />
<IDeleteInstruction DeleteTransition="Deleted" />
<IInstruction />
</DeleteInstruction>
A Delete instruction can also be used for terminate by substituting the DeleteTransition
parameter with the value Terminated.
<DeleteInstruction>
<IDeleteInstruction DeleteTransition="Terminated" />
<IInstruction />
Insert Instruction
<InsertInstruction>
<IObject UID="{349c5957-e5a5-42b1-959f-8313155ca0dc}"
Name="Insert_ISPFFTRItem" />
<IRefObject RefClass="InterfaceDef" RefUID="ISPFFTRItem"
RefName="ISPFFTRItem" />
<IPropValues
PropValues="IObject\%UID\%ISPFFTRItem\%IObject\%Name\%ISPFFTRItem
\%IObject\%Description\%Interface to support
FTR\%ISchemaObj\%DisplayName\%ISPFFTRItem"
AddedInterfaces="IObject~IInterfaceDef~IInterfaceRole~IPropCategory~IEn
umMetadata~ISchemaObj~IInterfaceDefExt" />
<IInsertInstruction />
<IInstruction />
</InsertInstruction>
Update Instruction
<UpdateInstruction>
<IObject UID="Update_UID" Name="Update_UID" />
<IRefObject RefClass="PropertyDef" RefUID="UID" RefName="UID" />
<IPropValues PropValues="IPropertyDefExt\%HistoryNotRetained\%True"
AddedInterfaces="IPropertyDefExt" />
<IInstruction />
<IUpdateInstruction />
</UpdateInstruction>
Progress Register Instruction

<SPFPrgRegisterInstruction>
<IObject UID="Delete_ISPFAdhocReport.MTH_CopyIfOwner"
Name="Delete_ISPFAdhocReport.MTH_CopyIfOwner" />
<IRefObject RefClass="Rel"
RefUID="ISPFAdhocReport.MTH_CopyIfOwner"
RefName="ISPFAdhocReport.MTH_CopyIfOwner" />
<ISPFPrgRegisterInstruction
SPFPrgInstructionTimestring="T1"
SPFPrgInstructionPlannedDate="20/04/2007"/>

Loader
<IInstruction />
</SPFPrgRegisterInstruction>
Revise Instruction
<SPFReviseInstruction>
<IObject UID="Revise_001" Name="Revise_001" />
<IRefObject RefClass="SPFDesignDocRevision"
RefUID="{68Y69856458GGKH}" RefName="DocABC" />
<ISPFReviseInstruction SPFReviseInstRevScheme="01A"
SPFReviseInstMajorRevision="01"
SPFReviseInstMinorRevision="B" etc ..../>
<IInstruction />
</SPFReviseInstruction>
SignOff Instruction
<SPFSignOffInstruction>
<IObject UID="SignOff_001" Name="SignOff_001" />
<ISPFSignOffInstruction
SignOffInstructionComment="All is OK"
SignOffInstructionAllowWorkingRefs="True" />
<IInstruction />
</SPFSignOffInstruction>
Reclassify Instruction
<SPFReclassifyInstruction>
<IObject UID="Reclassify_FLD-001" Name="Reclassify_FLD-001" />
<IRefObject RefClass="SPFFolder"
RefUID="FLD-001"
<ISPFReclassifyInstruction SPFNewClassificationUID="MyFolder" />
<IInstruction />
</SPFReclassifyInstruction>
Generate Form Instruction

This instruction is used to generate a default form definition for the class definition, relationship
definition named, or all class definitions associated with a specific component schema.
<SPFGenerateFormInstruction>
<IObject UID="Instruction_GenForm-PBSAuthoringComponent"
Name="GenForm-PBSAuthoringComponent" />
<IRefObject RefClass="CompSchema" RefUID="PBSAuthoringComponent" />
<IInstruction />
<ISPFGenerateFormInstruction />
</SPFGenerateFormInstruction>
Claim Instruction
<SPFClaimInstruction>
<IObject UID="Claim_Tag001" Name="Claim_Tag001" />
<IRefObject RefClass="DEVTag" RefUID="{4687889FDT98760L}"
RefName="Tag001" />

Loader
<ISPFClaimInstruction />
<IInstruction />
</SPFClaimInstruction>
UnClaim Instruction
<Container Scope="Data" IObject_Config="PR_Project1">
<SPFUnClaimInstruction>
<IObject UID="Test" />
<IInstruction />
<ISPFUnClaimInstruction />
<IRefObject RefName="Tag1" RefClass="DEVTag" RefUID="UID" />
</SPFUnClaimInstruction>
</Container>
Attach Workflow Instruction

<SPFAttachWorkflowInstruction>
<IObject UID="AWF_Tag001" Name="AWF_Tag001" />
RefName="Tag001" />
<ISPFAttachWorkflowInstruction
SPFWorkflowTemplateUID="TagWorkflow001" />
<IInstruction />
</SPFAttachWorkflowInstruction>
Merge Instruction
<SPFMergeInstruction>
<IObject UID="Merge_Tag001" Name="Merge_Tag001" />
RefName="Tag001" />
/S <ISPFMergeInstruction SPFMergeInstructionComment="External object
claim" />
<IInstruction />
XML Load Formats for Documents

To make it easier for XML to load documents, users can either fully define the document by
specifying each class that makes up a document, or they can define the document in a
shorthand format where only the document master is fully defined. This has special tags that
make it easier to create the revision and version objects.
<SPFTemplateMaster> </SPFTemplateMaster>
<SPFTemplateRevision> </SPFTemplateRevision>
<SPFTemplateVersion> </SPFTemplateVersion>
If a revision or version property is detected on the document master class instance, then the
revision and version are referenced automatically.
The name and description of the revision and version objects are the same as the document
master.
The following XML creates a master:
<SPFTemplateMaster>
<IObject Description="Instrument List Template"
Name="Instrument List Template"

Loader
UID="InstrumentListTemplateMaster" />
<ISPFDocumentMaster />
<ISPFNonPublishedDocMaster />
<ISPFTemplateMaster />
<ISPFDocument SPFDocCategory="e1TemplateDocuments"
SPFDocType="e1DatasheetTemplate" SPFTitle=""
SPFDocState="RESERVED"/>
</SPFTemplateMaster>
The following XML creates a revision:
<SPFTemplateRevision>
UID="InstrumentListTemplateRevision" />
<ISPFDocumentRevision SPFExternalRevision="A1"
SPFMajorRevision="A" SPFMinorRevision="1" SPFRevState="WORKING"
SPFRevUnderChangeInSameConfig="False" SPFSignoffComments="" />
<ISPFNonPublishedDocRevision />
<ISPFTemplateRevision />
<ISPFWorkflowItem SPFTargetWorkflowName="" />
</SPFTemplateRevision>
The following XML creates a version:
<SPFTemplateVersion>
UID="InstrumentListTemplateVersion" />
<ISPFDocumentVersion SPFDocVersion="1"
SPFIsDocVersionCheckedOut="False"
SPFIsDocVersionSuperseded="False" />
<ISPFFileComposition />
<ISPFNonPublishedDocVersion />
<ISPFTemplateVersion />
</SPFTemplateVersion>
Attaching Files (XML)

A reference must be made to the object when a file is being attached. There are two different
types of files that you can attach to two different documents:
1. <SPFTemplateFile> to an <SPFTemplateVersion>
2. <SPFDesignFile> to an <SPFDesignDocVersion>
Several XML statements are required to upload and attach a file:
 The upload instruction to move the physical file from the local host to a server.
 The file object created representing the meta-data that gets created in the database.
 The relationship that an object references from the file being attached.
Upload Instruction
Template File
<SPFUploadInstruction>
<ISPFUploadInstruction FilePath="Instrument List Template.xls"
RemoveLocalFileInd="False"/>

Loader
<IRefObject RefClass="SPFTemplateFile"
RefUID="InstrumentListTemplateFile"
RefName="InstrumentListTemplateFile" />
</SPFUploadInstruction>
Design File
<SPFUploadInstruction>
<ISPFUploadInstruction FilePath="PID1.pid" RemoveLocalFileInd="False"/>
<IRefObject RefClass="SPFDesignFile" RefUID="PID1File"
RefName="PID1.pid" />
</SPFUploadInstruction>
 The Upload Instruction references the associated file in order for the transfer to be
successful.
 The "RefUID" in the Upload Instruction needs to match the "UID" in the File Object
Statement.
 The interface ISPFDBFile needs to be referenced in the File Object Statement for files that
end up in the database.
 The vault needs to be related to the file object for files that end up in the vault.
 Intergraph recommends that you remove the interface requirement and allow the system to
determine if the file is added to the database.
 If the full path to an attaching file is specified in the SPFLocalFilename property, the Loader
only looks for the file in the full path.
 If a relative path is specified in the SPFLocalFilename property, the Loader first looks for the
attaching file in the relative path where the load file resides. If the attaching file is not found,
then the Loader looks for it under the directory specified for the SPFLocalDirectory property.
File Object Statement

Template File
<SPFTemplateFile>
<IObject Description="Instrument List Template File" Name="Instrument List
Template File" UID="Instrument List Template File" />
<ISPFAlternateRenditionComposition />
<ISPFFile SPFLocalHostName="localhost" SPFLocalDirectory="C:\"
SPFLocalFileName="Instrument List template.xls" />
<ISPFBusinessFile SPFEditInd="True" SPFViewInd="True"
SPFIsFileCheckedOut="False" />
<ISPFNavigationFileComposition />
<ISPFRefFile />
<ISPFTemplateFile />
<ISPFDBFile />
</SPFTemplateFile>
Design File
<SPFDesignFile>

Loader
<IObject Description="Type is PID" Name="PID1.pid" UID="PID1File" />

<ISPFFile SPFLocalHostName="localhost" SPFLocalDirectory="C:\"
SPFLocalFileName="PID1.pid" />
<ISPFBusinessFile SPFEditInd="True" SPFViewInd="True"
SPFIsFileCheckedOut="False" />
<ISPFMarkupComposition />
<ISPFDesignFile />
<ISPFOwnedObj />
<ISPFRefFileComposition />
<ISPFFTRItem />
<ISPFSubscribableItem />
<ISPFRefFile />
</SPFDesignFile>
<Rel>
<IObject UID="PID1File.SPF40" Name="" Description="" ContainerID=""
/>
<ISPFClaimableItem" />
<IREL UID2="VLT SPF40Vault" UID1="PID1File" DefUID="SPFFileVault" />
</Rel>
Relationship to attach a file to an Object

All files must be related to an object that has an ISPFFileComposition interface definition,
typically Document Versions and Transmittals.
Template File
<Rel>
<IObject
UID="InstrumentListTemplateFile.InstrumentListTemplateVersion" />
<IRel DefUID="SPFFileComposition"
UID2="InstrumentListTemplateVersion" UID1="InstrumentListTemplateFile"
/>
</Rel>
Design File
<Rel>
<IObject UID="PID1File.PID1DesignDocVersion" />
<IRel DefUID="SPFFileComposition" UID2="PID1DesignDocVersion"
UID1="PID1File" />
</Rel>
If no relationship is given for a specific file type then SmartPlant Foundation allocates
one.

Loader
NLF Format
The Loader supports the NLF format to support backwards compatibility and an external load
format where UIDs are unknown. During pre-processing, load files in NLF format are sent to the
server and parsed. The software determines the UIDs of the object and constructs an XML load
file. The XML generated from the NLF file is then submitted to the same methods as XML load
files, making sure that all load operations parse through the same code. Because the NLF
format requires this extra step to parse the data, the operation takes slightly longer than
submitting XML directly.
The following load file example creates tag CW501 in NLF format and relates it to document
DocABC:
.DEVTag
..Name|CW501
..Description|NLF Tag Create
..DEVTagCategory|Process equipment
..DEVTagType|Process vessel
..DEVOverallHeight|900|mm
..DEVOverallWidth|3.2|m
..DEVOverallLength|4.1|m
.DEVDocumentTag
..Name1|DocABC
..Name2|CW501
Format Description Example

.Class_Type Defines the classdef of the object. . DEVTag
..Name|Value Defines the name of the object ..Name| CW501
instance in the database.
..UID|Value Defines the UID of the object ..UID|UID-U101
..Description|Value Defines the description of the ..Description|NLF Tag
business object instance in the Create
database.
..PropertDef|value|UOM|Type Defines the value of the given ..DEVOverallLength|10|
property name. If the property is of m
type UoMListType, the third field
includes the name of UOM.

Loader

..ClassDef| Defines the internal name of the ..SPFTemplateRevision
Value|ReldefName related object such as Area, |DocABCD|DEVDocum
Discipline, or System. Argument 1 is entTag_21
used to define the name of the object
while argument 2 names the edge
relationship definition.
A relationship edge is the
name of the relationship def with
either "_12" or "_21" appended to
the name depending on the direction
from the defined object.
..InterfaceDef|Value Allows an option interface to be ..IDEVEquip
added to the object
..Action|Value(s) See NLF Load Format for
Documents (on page 504) for details.
Alternatively, the generation of the object and the relationship to the deliverable can be done at
the same time:
.DEVTag
..Name|CW501
..Description|NLF Tag Create
..DEVTagCategory|Process equipment
..DEVTagType|Process vessel
..DEVOverallHeight|900|mm
..DEVOverallWidth|3.2|m
..DEVOverallLength|4.1|m
..SPFTemplateRevision|DocABC|DEVDocumentTag_21
The | character in NLF is converted into a space in XML. If you want to pass the |
character through to XML, you must preface it with the \ character. For example, the string
Arg1|Arg2 will be converted to Arg1 Arg2, whereas Arg1\|Arg2 will be converted to
Arg1|Arg2.
NLF Instructions
NLF also supports a subset of SmartPlant Foundation instructions. These can be triggered by
defining the object that exists in the database followed by the keyword Action and then one of
the defined actions as listed below.
An example NLF file with an instruction follows
.DEVTag
..Name|CW506
..Action|Terminate

Loader

..Action|Delete If set generates a DeleteInstruction ..Action|Delete
for the named object and sets the
argument DeleteTransition to Delete.
The object is deleted, along with its
relationships and any associated
object that is defined using the
delete_12 and delete_21 flags on the
reldef
..Action| ProgressRegister| If set, generates a ..Action|ProgressRegist
TimeString|PlannedDate SPFPrgRegisterInstruction and er|ComplexDrg|22/06/2
submit arg1 as the 007
SPFPrgInstructionTimestring and
arg2 as
SPFPrgInstructionPlannedDate. The
date format is dd/mm/yyyy. The
instruction registers the name object
and associates it with a workpack.
..Action|Revise|RevScheme| This action works on Document ..Action|Revise|Rev01A
MajorRevision|MinorRevision|C objects only. If set generates a |01|A|False
opyFilesOnRevise SPFReviseInstruction and submits
arg1 as the
SPFReviseInstRevScheme, arg2 as
SPFReviseInstMajorRevision and
arg3 as
SPFReviseInstMinorRevision. The
instruction will validate that the
document can be revised before
performing the revise function. If the
CopyFilesOnRevise argument (ar4)
is omitted or set to any value but
False, files are carried to the next
revision.
..Action|SignOff| This action works on Document ..Action|SignOff|Docum
objects only. If set generates a ent checked by client
SPFSignOffInstruction and submit
arg1 as the
SignOffInstructionComment, and
arg2 as
SignOffInstructionAllowWorkingRefs.
The instruction validates that the
document can be signed off before
performing the signoff function.

Loader

..Action|Terminate If set generates a DeleteInstruction ..ActionTerminate
for the named object and set the
argument DeleteTransition to
Terminated. The object is
terminated, along with its
relationships and any associated
object that is defined using the
delete_12 and delete_21 flags on the
reldef
..Action|Reclassify| If set generates a ..Action|Reclassify|SPF
New class definition SPFReclassifyInstruction for the CentrifugalPump
named object. The new class
definition supplied as arg 1 is
checked to see if it belongs in the
same shared object group as the
existing class definition of the object.
If so reclassification takes place.
..Action|Claim If set generates a ..Action|Claim
SPFClaimInstruction for the named
object. As a result the object is
claimed, along with its relationships
and any associated object that is
defined using the claim_12 and
claim_21 flags on the reldef
..Action|AttachWorkflow|Workflo This action generates a ..Action|attachWorkflow
wUID SPFAttachWorkflowInstruction for |TagWorkflow001
the named object and sets the
Workflow UID to the value specified
by arg1. The name workflow is
attached to the object if it is valid to
do so.
..Action|Merge|Comments This action generates a ..Action|Merge|Merge
SPFMergeInstruction for the named set CX4514
object and sets the
SPFMergeComment to the value
specified by arg1.
..Action|CreateNewVersionIfExi This action is specific for files and
sts automatically creates the next
version of the document if there is
one already.

Loader
NLF Load Format for Documents

In order to make it easier for NLF to load documents, users can either fully define the document
by specifying each class and all the relationships that make up a document, or they can define
the document in a shorthand format in which only the document master is fully defined. This has
special keywords that make it easier to create the revision and version objects.
.SPFTemplateMaster
..Name|DocABC
..Description|NLF Document ABC
..SPFDocCategory|e1TemplateDocuments
..SPFDocType|e1XSLReportTemplate
..SPFTitle|Test
..SPFDocState|RESERVED
..SPFMajorRevision|01 Note: This parameter is a Revision parameter.
..SPFMinorRevision|A Note: This parameter is a Revision parameter.
If a revision, version property or the keyword Action is detected on the document master class
instance, then the revision, version and the associated relationships are referenced or
generated automatically.
The way in which this is achieved is by first finding out the associated revision and version class
definition. This is done by expanding up the SPFIncludes relationship from the specified
document master class definition.
The name and description of the revision and version objects will be the same as the document
master.

.DocumentMasterClass_Type Defines the classdef of the document . SPFTemplateMaster
master.
..Name|Value Defines the name of the object ..Name|DocABC
..Description|Value Defines the description of the object ..Description|NLF
instance in the database. Document ABC
..PropertDef|value|UOM|Type Defines the value of the given ..SPFDocumentCategory|
property name. If the property is of e1TemplateDocuments
type UoMListType, the third field
includes the name of UOM.
For each property found the
associated class definition is
determined by looking at the realizes
and exposes relationships, and then
the property is added to the correct
object.
In order to update a property on a document master, revision, or version, update it as a single
class update.
For example, the following NLF updates the master document only:
.SPFTemplateMaster
..Name|DocABC
..SPFTitle|Test Update capability
The following NLF example signs off a document:

Loader
.SPFTemplateMaster
..Name|DocABC
..Action|SignOff|NLF Loadfile signoff
The following NLF revises a document:
.SPFTemplateMaster
..Name|DocABC
..Action|Revise|Rev01A|01|C
Attaching Files
To upload and attach a file, two NLF statements are required. The first is an upload instruction
to move the physical file from the local host to a server. The second is the file object itself, which
represents the meta-data that is created in the database.
.UploadInstruction
..RefClass|SPFAuthAdapterFile
..RefName|ToolMapSchema_PBSFile
..RemoveLocalFileInd|False
.SPFAuthAdapterFile
..Name|ToolMapSchema_PBSFile
..SPFLocalDirectory|C:\
..SPFLocalFileName|ToolMapSchema_PBS.xml
..ISPFDBFile
The upload instruction needs to reference the associated file in order for the transfer to be
successful. For files that end up in the database, the interface ISPFDBFile needs to be
referenced; if it is a file that ends up in the vault, then a vault needs to be referenced.
Intergraph recommends that you remove the interface requirement and allow the
system to determine if the file is added to the database.
 If the full path to an attached file is specified in the SPFLocalFilename property, the Loader
looks for the file only in the full path.
 If a relative path is specified in the SPFLocalFilename property, the Loader first looks for the
attached file in the relative path where the load file resides. If the attached file is not found,
then the Loader looks in the directory specified for the SPFLocalDirectory property.
To automatically create the next version and attach the document to this instead, use the
instruction CreateNewVersionIfExists as shown in the following example:
.SPFTemplateFile
..Name|XLS_Tag_Data_1
..SPFLocalDirectory|C:\
..SPFLocalFileName|XLS Tag Data 2.xls
..ISPFDBFile
..SPFTemplateVersion|XLS_Tag_Data|SPFFileComposition_12
..Action|CreateNewVersionIfExists

Loader
Field Types for NLF

If the first field of the data is not a keyword (Name, Description, or Classification) and it is not
found in the list of related objects (System, Area, Discipline), then the Loader assumes the field
is a property.
Unlike previous versions (3.x), there is no longer a requirement to append the property type as
input because 4.x determines the type from the property definition stored in the database.
Relations for NLF

In order to load relationship data into SmartPlant Foundation, the relationship definition edge
name is used as the Relation Type when defining the object type. Relationship data uses
specific keywords to define each object.
.DEVDocumentTag
..Name1|DocABC
..Name2|CW503
..OrderValue|9
..IsRequired|True
..DomainUID1|Value1
..DomainUID2|Value2
If the end objects of the relationship exist in multiple domains, then you must specify the
DomainUID and the Name to relate to the specific domain object.

DomainUID|Value The DomainUID must be ..DomainUID|SPF
specified with the Name to
get to the specific domain
object.
.RelDef Name Defines the name of the ..DEVDocumentTag
relationship definition. the direction of the relationship should
always be specified.
..Name1|value Defines the name of the ..Name1| DocABC
left (first) object. There is a
special case for
relationship relations that
is defined below.
..Name2|value Defines the name of the ..Name2| CW503
right (second) object.
..<propertyName>|Value Define any other property ..OrderValue|9
that belongs on the
relationship
..UniqueKey1|Value As an alternative to ..UniqueKey1|DM_DocABC_A_1_1
Name1 the unique key can
be specified
..UniqueKey2|Value As an alternative to ..UniqueKey2|TG_CW503
Name2 the unique key can
be specified

Loader

UID1|Value As an alternative to ..UID1|{4fytj1664x56)
Name1 the UID1 can be
specified
UID2|Value As an alternative to ..UID2|{45516dyyt66)
Name2 the UID2 can be
specified
..Action|Value|Arg1 See NLF Load Format for ..Action|Terminate
Documents (on page 504)
for details.
..<interface name> Defines an optional ..SPFClaimableItem
interface that can be
added onto the
relationship
..<Classdef>|Name|reldef Defines a relationship ..SPFCondition|IsConfigMerged|SPFClas
relation. If the cardinality is sDefAccessGroupCondition_12
set to max =1 and the
object is being updated
then the existing rel is
terminated.
For a relationship the following instructions are supported:
 Terminate
 Delete
 Claim
 Merge
The following example demonstrates terminating a relation:
.DEVDocumentTag
..Name1|DocABC
..Name2|CW503
..Action|Terminate
Supporting Relationship Relations

You can generate relationships that relate other relationships to objects, such as conditions that
are associated with the relationship between a class definition and an access group.
Example NLF definition with a relationship relation defined:
.SPFClassDefAccessGroup
..Name1|DEVTag
..Name2|VIEWONLY
..SPFCondition|IsConfigMerged|SPFClassDefAccessGroupCondition_12
Alternatively the relationship can be defined as follows:
.SPFClassDefAccessGroupCondition
..Name1|Rel|SPFClassDefAccessGroup|DEVTag|VIEWONLY
..Name2|IsConfigMerged
Where Name1 is used to determine the relation with which to link:
Name1.Arg2 = "Rel" keyword to search for a Rel
Name1.Arg3 = <DefUID> of relationship to relate to

Loader
Name1.Arg4 = Name1 of associated relationship

Name1.Arg5 = Name2 of associated relationship
Data Lists in NLF Format

In addition to being able to create and update objects using the class definition or rel definition
name NLF supports a third object format: data list definitions. The advantage of this format is
that the user does not need to specify relationship definitions and the code works out associated
UIDs and determines whether these need to be terminated or not. This format is particularly
useful for submitting list data such as the Excel import data in which a view and data list
definition have been defined.
.XLS_Tags
..DataListItem|5
..RelatedDocumentName|XLS_Tag_Data|DEVRelatedTag
..Tag_Name|CW811
..Tag_Desc|NLF Tag Create
..Tag_Category|Process equipment
..Tag_Type|Process vessel
..Overall_Height|10|m
..Overall_Width|7.6|m
..Overall_Length|8.2|m
..System_Name|10
..Document_Name|DocABCDE
.XLS_Tags
..DataListItem|6
..RelatedDocumentName|XLS_Tag_Data|DEVRelatedTag
..Tag_Name|CW812
..Tag_Desc|NLF Tag Create
..Tag_Category|Process equipment
..Tag_Type|Process vessel
..Overall_Height|6.78|m
..Overall_Width|4.6|m
..Overall_Length|5.2|m
..System_Name|10
..Document_Name|DocABCDE
Format Description
.DataList_Name Defines the name of a data list item
..TargetViewDef|NameOfViewdef If the data list supports multiple view
definitions then the Target View definition
must be named in order for the property
display values to match up with the correct
view definition. If only one view definition is
associated with the data list definition then
there is no need to specify this field.

Loader
Format Description
..DataListItem|Value This is a special keyword used with the NLF
data list type in order for a compare
operation to detect which data line was used
to submit the data. The field is for reference
only and never ends up in the database, but,
it is returned as a reference in any compare
results that are returned.
..RelatedDocumentName|DocumentName|RelDe This is a special keyword used within NLF in
f order for relationships between the named
document and all objects (those with a target
class def) to be established.
The code assumes that the attached
document is on side 1.
..PropertyDisplayName|Value Defines the property display name within the
associated view definition.
If the property display name has
spaces in it then these need to be replaced
with the underscore "_" character. The value
(including the UOM if it is present) should
follow.
Object Mode in NLF Format

To allow users to import objects with the same name through NLF, the Loader supports a
keyword called ObjectMode that has two values in a NLF package: AllowDuplicates or
DoNotAllowDuplicates. DoNotAllowDuplicates is the default if the keyword is not specified.
This allows objects such as nozzles and files to be created with the same name as objects
already in the system.
For example, if you have a CURRENT and WORKING version of a document named
SPE-121-XC-2205M and a file attached to the Current version named 77-D-G-006.txt, you can
run the following script in NLF to create a duplicate file on both versions by setting the value of
the ObjectMode keyword to AllowDuplicates:
.BeginContainer
.UploadInstruction
..RefClass|SPFDesignFile
..RefName|77-D-G-006.txt
.SPFDesignFile
..Name|77-D-G-006.txt
..SPFDesignDocVersion|SPE-121-XC-2205M|SPFFileComposition_12
..SPFLocalDirectory|C:\K_Drive\Data\PID
..SPFLocalFileName|77-D-G-006.txt
..SPFVault|SPF40Vault|SPFFileVault_12
..SPFEditInd|True
..SPFViewInd|True

Loader
..ObjectMode|AllowDuplicates
.EndContainer
NLF Load File Date Examples

The following is an example of NLF Load file - where the date is set in Server format:
Server Format - specific to using the server, where DEVDateTime is scoped by DateTimeType
YYYY/mm/dd-hh:mm:ss:sss:
.DEVTag
..Name|DEVTAG-001
..Description|
..ContainerID|
..DEVProp_EngWriteOthersRead|False
..DevUnitForTag|
..DEVProp_EngOnly|False
..SPFNeedsIndexing|True
..DEVTagCategory|{239410D8-4DDC-41B2-9116-0F9856921CBE}
..DEVDateTime|2012/01/27-16:41:54:192
Local Format - this is specific to your local computer, so the date format would be dd:mm:yy or
mm:dd:yy. If no time is specified, the local date is converted to the server format in the load file
and the time string 00:00:00 (indicating midnight local time) is appended.
See Also
Date Time Handling (on page 511)
Transaction Handling
To allow for data to be loaded in discrete transactions, we can specify the data in containers and
the Loader pushes all the contents to the server to be processed in one transaction. Containers
are delineated by the statements BeginContainer and EndContainer. If any part of the container
fails to load, the whole container is rolled back.
In NLF format, if no container statements are included, then each object is treated as a separate
container.
NLF format
.BeginContainer
.SPFFunctionalUnit
..Name|U101
.SPFFunctionalUnit
..Name|U102
.EndContainer
.BeginContainer
.SPFFunctionalUnit
..Name|U103
.EndContainer
U101 and U102 are loaded in one transaction and U103 in its own transaction.

Loader
XML format
<Containers>
ContainerID="PBS.Data">
<FunctionalUnit>
<IObject Name="U101" />
<IFunctionalUnit />
</FunctionalUnit>
<FunctionalUnit>
<IFunctionalUnit />
</FunctionalUnit>
</Container>
ContainerID="PBS.Data">
<FunctionalUnit>
<IFunctionalUnit />
</FunctionalUnit>
</Container>
</Containers>
Date Time Handling

The Loader supports 2 types of date/time formats, Server and Local.
 Server format is: yyyy/mm/dd-hh:mm:ss:mmm. The Server format supports this format
whether the time is specified or not. If a time is specified, then the time is adjusted using
regional time settings. If no time is specified, then the string 00:00:00 (indicating midnight
local time) is appended. This time string is then converted to GMT time using regional
settings.
 Local format is different because the date is entered based on the local date format
specified in the Control Panel Settings. For example, May 31, 2012 could be entered as
05/31/2012 or 31/05/2012 depending on your location. The local time format is: hh:mm:ss
and does not support milliseconds. If a date and time are specified, the "-" separator is used
as shown in the Server format. If no time is specified, then the local date is converted to the
server format and the time string 00:00:00 (indicating midnight local time) is appended. This
time string is then converted to GMT time using regional settings. All conversions are done
before sending the date and time to the server.
CreateConfig Setting
It is possible to override the Create configuration that is set in the client when loading load files.
If this is not set then the data is loaded using the client's current Create configuration.
Configuration independent classes ignore this setting.
NLF
.SetConfiguration
..Configuration|EFPLANT-SC-1

Loader
XML
<Container CompSchema='' IObject_config="EFPLANT-SC1">
</Container>
Modes for Load Files

The Loader can operate in three modes: Create, Update, and Merge. The mode can be set once
per load file and should be the first active statement in the load file.
 Create mode creates new objects. If any data collisions are detected and an error occurs,
you are informed that the object is not loaded.
 Update mode updates existing objects. If any objects to be updated are not found and an
error occurs, you are informed that the object is not loaded.
 Merge mode updates an existing object or creates the object if it does not already exist.
The following are example syntaxes:
NLF Format
Method|Create
Method|Update
Method|Merge
XML Format
Type='Create' specifies that only new <Container CompSchema='SPFComponent'
objects are created. If they exist, an error is config='PlantA' Type = 'Create'>
raised and the transaction is rolled back.
Type='Update' specifies that this container <Container CompSchema='SPFComponent'
can only update existing objects. If any config='PlantA' Type = 'Update'>
objects to be updated are not found, an
error is raised and the transaction is rolled
back.
If you do not specify a type, the 'Merge' <Container CompSchema='SPFComponent'
mode is assumed. If an object exists, config='PlantA' >
update it. If the object does not exist,
create it.
ContainerID
The containerID tag allows all objects that are created to be stamped with the value defined in
argument 1.
NLF
ContainerID|MyLoadedData

Loader
XML
<Container CompSchema="SPFComponent" IObject_Config="PlantA" Type =
'Create' ContainerID="MyTestData">
SuppressENS
Suppress ENS is a flag that can be applied to load files. The purpose of this flag is to allow data
to be loaded respecting the property values given in the load file rather than applying the ENS
definition that is configured for the classdef of this object. This would typically be used to load
historical data with specified properties, for example, name, rather than having ENS define the
property. When data is created interactively or through the loader without this setting, the
configured ENS is still applied to the object.
NLF
The following example shows the SuppressENS flag used with containers. In the first container,
ENS is turned off. When the server encounters the next container, it turns ENS back on.
Containers must be used to turn ENS suppression on or off.
.BeginContainer
SuppressENS|True
.SPFFolder
..Name|FLD-00402
..Description|Test from nlf file 402
..ContainerID|
..SPFActiveWorkflowCount|0
..SPFActiveWorkflowStatus|
.EndContainer
.BeginContainer
SuppressENS|False
.SPFFolder
..Name|FLD-00502
..ContainerID|
.EndContainer
In the following example, both folders have the ENS functionality disabled. The properties in the
load file are used instead of generating them with ENS.
SuppressENS|True
.SPFFolder
..Name|FLD-00402
..ContainerID|

Loader
.SPFFolder
..Name|FLD-00502
..ContainerID|
XML
When the server encounters the new container property, it switches off the ENS functionality for
every item in the load file.
<Container SuppressENS="True" >
<SPFFolder>
<IObject Name="FLD-00100" Description="Test from file 2" />
<ISPFWorkflowItem SPFActiveWorkflowCount="0"
SPFActiveWorkflowStatus="" />
<ISPFFTRItem />
<ISPFOwnedObj />
<ISPFSupportItem />
<ISPFFolder />
<ISPFExportableItem />
<ISPFSubscribableItem />
</SPFFolder>
</Container>
Load Errors and Reloading Files

Using the Loader, you can view errors in the Loader, reload files, and view exception reports.
Viewing Errors in the Loader

You can either view the results of all loaded files, or view the results for one file.
 To view the results for all loaded files, click Load Results.
 To view the results for a single loaded file, right-click a processed file and select Load
Results.

Loader
The software displays the results in the Load Results dialog box.
Reload Files
Reload files contain load file entries that have failed in NLF format so that they can be fixed and
then reloaded. The reload file contains failed containers.
The name contains the original load file name, a date/time stamp, and the word Reload. For
example:
ABC.dwh generates a reload file named ABC_ 200105095938 Reload.dwh. Similarly for an
XML file, ABC.xml generates a reload file named .ABC_ 200105095938 Reload.xml

Loader
Exception Reports
An exception report consists of an XML file that contains exception reporting information and an
XSL file to control formatting of the exception report. Both of these files are placed in the Output
directory.
If an exception report is created, the resulting file can be viewed by selecting Show Exception
Report on the short-cut menu on the file node in the Load Results dialog box.
This displays the generated exception reporting information in a browser window.

Exception report files are given a name that contains the original load file's name, a date/time
stamp, and the word Exceptions (<source>_Exceptions.xml). For example, processing a file
named ABC.xml may produce an exceptions file named: ABC_100903103027_Exceptions.xml

Loader
The following is an example of an exceptions report generated when an error loading a file
occurs.
See Also
View Exception Reports (on page 517)
View Exception Reports for Individual Load Errors (on page 518)
View Exception Reports

When a load fails, you can view the errors that occurred during the load process.
1. Right-click the failed load file, and click Load Results.
2. In the Load Results list, right-click the file and click Show Exception Report.

Loader
View Exception Reports for Individual Load Errors

When a load fails, you can view and save exception reports for individual load errors.
1. Click on the load file and click Load Results. Or, right-click the load file, and click Load
Results.
2. In the Load Results, right click on an individual error, and click Show Exception.

Loader
The Loader generates an explanation of an error that occurred during a load. An example of
an error message follows.
3. Click Save to save the error message information.

4. Select Show More Information to view details about the error. The following is an
example of a detailed explanation of the error.
5. Click Save to save the error message.

Expand the error in the left frame and move the pointer over the error for a detailed
explanation of the error, as seen in the following graphic.
Command Line Usage for the Loader

You must run the command line loader from the directory where the Loader exists.
The loader is typically in C:\Program
The command line options for the Loader are very similar to the command line options for the
Desktop Client; they are as follows:
"/U" user
"/P" password
"/PLANT" – plant
"/PROJECT" - project
"/S" - Server (you do not need the following two options with this)
"/H" – host (this option needs the following option as well)
"/W" – web directory

Loader
"/F" – file name

"/UI" – Display loader window. User required to start load process manually
"/secure" - Secure site. Boolean indicating a secure site
The code first tries to log in from the command line. If not enough information is present to log in
and find the requested file, it will remember the information it does have and prompt the user for
the rest.
spfdataloader.exe /U adminuser /P /S Server /F "c:\temp\Vault and Host.xml"
 If no argument is provided to specify a configuration (plant or project), the loader will use
the last create scope set for the user in the SmartPlant Foundation Desktop Client.
Configuration information provided in the load file will take precedence over information
provided in the command line argument or previous SmartPlant Foundation Desktop
Client settings.
 When a load fails, output files are generated in the same way, whether the files were
loaded through the Desktop Client or the command line.
 The command line loader does not honor the permissions set for the SmartPlant
Foundation users. For example, a SmartPlant Foundation user without the permission to
load files and create objects can use the command line loader to upload files and create
objects in the SmartPlant Foundation database.
Loader Directory Poller

The Loader Directory Poller helps automate load file processing by monitoring specified folders
and submitting any load files placed in those folders to the Loader for processing. When
running, the Directory Poller automatically checks for files at a user-defined interval. You can
also check for files or pause the Poller at any time from within the Directory Poller interface.
If the Directory Poller encounters a load file in a specified folder, the Directory Poller submits the
file to the Loader in silent mode, either automatically at the end of a polling interval or
interactively when you click Poll Now in the interface. Afer it has submitted all the load files in
the specified folders, the Directory Poller restarts the polling timer and sleeps until the polling
interval expires again, or until you click Pause or Poll Now.
Run the Loader Directory Poller

1. In the SmartPlant Foundation installation folder, double-click
SPF<version_number>LoaderDirPoll.exe.

Loader
2. In the Loader Directory Poller dialog box, click Add Directory to add a folder to be
monitored.
When the poll interval expires, the Directory Poller checks the specified folders for load files
and sends the load files to SmartPlant Foundation Loader for processing.
 Click Pause to suspend the poll timer.

 Click Poll Now to check the specified folders immediately.
Load File Examples

This section contains several example load files for creating data and performing instructions in
SmartPlant Foundation using the Desktop Client Loader.
 These load files are intended as samples only.

 The configuration information in these samples is based on the default model delivered with
SmartPlant Foundation. If you intend to copy and paste these examples in order to load data
into your SmartPlant installation, you must make sure that the configuration information in
your load files matches your actual configuration information.

Loader
Data Creation
The following is a sample XML load file used to create data:
<Container CompSchema=''SPFReferenceComponent” Scope=”Data”
ContainerID=”Plant.Admin”>
<FunctionalUnit>
<IObject UID="UNT_PlantA_U101" Name=”U101” Description="Unit
101" />
<IFunctionalUnit />
<IPBSItemCollection />
<IPBSItem />
<IPlannedFacility />
</FunctionalUnit>
<Rel>
<IObject
UID="UNT_PlantA_U101-DDCM_PlantA_C056-KV-P-XC-2002-01" />
<IRel DefUID="FunctionalUnitDeliverable"
UID2="DDCM_PlantA_C056-KV-P-XC-2002-01-42"
OrderValue="0" UID1="UNT_PlantA_U101" IsRequired="False" />
</Rel>
</Container>
Perform SmartPlant Foundation Instructions

Delete Instruction
<DeleteInstruction>
<IDeleteInstruction DeleteTransition="Deleted" />
<IInstruction />
A delete instruction can also be used to terminate by substituting the DeleteTransition

parameter with the value Terminated.
<DeleteInstruction>
<IInstruction />
Insert Instruction
<InsertInstruction>
<IObject UID="{349c5957-e5a5-42b1-959f-8313155ca0dc}"
Name="Insert_ISPFFTRItem" />

Loader
<IRefObject RefClass="InterfaceDef" RefUID="ISPFFTRItem"

RefName="ISPFFTRItem" />
<IPropValues
PropValues="IObject\%UID\%ISPFFTRItem\%IObject\%Name\%ISPFFTRItem\%IObj
ect\%Description\%Interface to support
FTR\%ISchemaObj\%DisplayName\%ISPFFTRItem"
AddedInterfaces="IObject~IInterfaceDef~IInterfaceRole~IPropCategory~IEn
umMetadata~ISchemaObj~IInterfaceDefExt" />
<IInsertInstruction />
<IInstruction />
</InsertInstruction>
Update Instruction
<UpdateInstruction>
<IObject UID="Update_UID" Name="Update_UID" />
<IRefObject RefClass="PropertyDef" RefUID="UID" RefName="UID" />
<IPropValues PropValues="IPropertyDefExt\%HistoryNotRetained\%True"
AddedInterfaces="IPropertyDefExt" />
<IInstruction />
<IUpdateInstruction />
</UpdateInstruction>
Progress Register Instruction

<SPFPrgRegisterInstruction>
<IObject UID="Delete_ISPFAdhocReport.MTH_CopyIfOwner"
Name="Delete_ISPFAdhocReport.MTH_CopyIfOwner" />
<IRefObject RefClass="Rel"
RefUID="ISPFAdhocReport.MTH_CopyIfOwner"
<ISPFPrgRegisterInstruction
SPFPrgInstructionTimestring="T1"
SPFPrgInstructionPlannedDate="20/04/2007"/>
<IInstruction />
</SPFPrgRegisterInstruction>
Revise Instruction
<SPFReviseInstruction>
<IObject UID="Revise_001" Name="Revise_001" />
<ISPFReviseInstruction SPFReviseInstRevScheme="01A"
SPFReviseInstMajorRevision="01"
SPFReviseInstMinorRevision="B" etc ..../>
<IInstruction />
</SPFReviseInstruction>
SignOff Instruction
<SPFSignOffInstruction>
<IObject UID="SignOff_001" Name="SignOff_001" />
<ISPFSignOffInstruction

Loader
SignOffInstructionComment="All is OK"
SignOffInstructionAllowWorkingRefs="True" />
<IInstruction />
</SPFSignOffInstruction>
Reclassify Instruction
<SPFReclassifyInstruction>
<IObject UID="Reclassify_FLD-001" Name="Reclassify_FLD-001" />
<IRefObject RefClass="SPFFolder"
RefUID="FLD-001"
<ISPFReclassifyInstruction SPFNewClassificationUID="MyFolder" />
<IInstruction />
</SPFReclassifyInstruction>
Generate Form Instruction

This instruction is used to generate a default form definition for the class definition, relationship
definition name, or all class definitions associated with a specific component schema.
<SPFGenerateFormInstruction>
<IObject UID="Instruction_GenForm-PBSAuthoringComponent"
Name="GenForm-PBSAuthoringComponent" />
<IRefObject RefClass="CompSchema" RefUID="PBSAuthoringComponent" />
<IInstruction />
<ISPFGenerateFormInstruction />
</SPFGenerateFormInstruction>
Claim Instruction
<SPFClaimInstruction>
<IObject UID="Claim_Tag001" Name="Claim_Tag001" />
RefName="Tag001" />
<ISPFClaimInstruction SPFClaimInstructionComment="External object
claim" />
<IInstruction />
</SPFClaimInstruction>
Attach Workflow Instruction

<SPFAttachWorkflowInstruction>
<IObject UID="AWF_Tag001" Name="AWF_Tag001" />
RefName="Tag001" />
<ISPFAttachWorkflowInstruction
SPFWorkflowTemplateUID="TagWorkflow001" />
<IInstruction />
</SPFAttachWorkflowInstruction>
Merge Instruction
<IObject UID="Merge_Tag001" Name="Merge_Tag001" />
RefName="Tag001" />

Loader
<ISPFMergeInstruction SPFMergeInstructionComment="External object

claim" />
<IInstruction />
</SPFMergeInstruction>
Design Document Creation

The following load file is an example of creating a design document.
NLF Example
.BeginContainer
.SetConfiguration
..Configuration|PlantA
.SPFDesignDocMaster
..Name|77-D-G-006
..Description|Main Air Blowers P&ID
..SPFDataAccessGroup|ENGINEER|SPFItemOwningGroup_12
..SPFDocumentClass|Utility P&ID|SPFPrimaryClassification_21
..SPFTitle|77-D-G-006
..SPFRevisionScheme|RevA1|SPFDocRevisionRevisionScheme_12
..SPFMajorRevision|A
..SPFMinorRevision|1
..SPFRevState|WORKING
..SPFDocVersion|1
..SPFPrgWeighting|100
..SPFFunctionalArea|02|SPFADocumentMasterArea_12
..SPFFunctionalUnit|U201|SPFADocumentMasterUnit_12
..SPFContract|CN-001003|SPFADocumentMasterContract_12
.EndContainer
XML Example
For an example of using a fully qualified XML-based load file with this operation, please refer to
the model build file <installation directory>:\Program
Files\SmartPlant\Foundation\2009\Models\Core\DTC – LoadFiles\DATA_Reports.xml.
This file loads template documents and their files which use the SPFTemplateFile ClassDef for
the file. For design documents and similar documents, use the SPFDesignFile ClassDef.
SPFDesignFile ClassDef does not use the ISPFDBFile InterfaceDef. Swap
SPFTemplateFile for SPFDesignFile in the example file and remove the line containing
ISPFDBFile.

Loader
Relationship Examples
Creating and Terminating Relationships
NLF Examples
The following is an example of creating a RelDefAccessGroup relationshi:-
.SPFRelDefAccessGroup
..Name1|SPFDocRevisionLabel
..Name2|SystemAdmin
..ContainerID|DEVAuthoring.NLF
The following is an example of terminating the relationship created above.
..Name2|SystemAdmin
..Action|Terminate
The following is an example of creating a relationship with relationship properties and
relationships. This example configures the RelDefAccessGroup relationship with all its
properties, such as Manage Access Groups.
..Name2|SystemAdmin
..SPFRelDragDrop1on2|True
..SPFRelDragDrop2on1|True
..SPFRelExpand1to2|True
..SPFRelExpand2to1|True
..SPFCondition|CND_IsObj1WORKING|SPFRelDefAccessGroupDDCondition_12
Creating a Relationship to an Existing Relationship

The following load file is an example of creating a condition relationship.
# Create the drag drop condition relationship on the relDefAccessgrouop
relationship
.SPFRelDefAccessGroupDDCondition
..Name1|Rel|SPFRelDefAccessGroup|SPFDocRevisionLabel|DocumentUpdate
..Name2|IsObj1WORKING
XML Example
The following is an example of using a fully qualified XML-based load file with this operation.
This excerpt was taken from the model build file <installation directory>:\Program
Files\SmartPlant\Foundation\2009\Models\Core\ADMIN_DocMgt.xml
To relate the access group to the RelDef, do the following:
<Rel>
<IObject UID="SPFDocRevisionLabel.DocumentUpdate" Name=""
Description="" ContainerID="Core.DocMgt" />
<IRel UID2="MAG_DocumentUpdate" DefUID="SPFRelDefAccessGroup"
UID1="SPFDocRevisionLabel" OrderValue="0" IsRequired="False" />
<ISPFRelDefAccessGroup SPFRelTerminate="True"
SPFRelDragDrop2on1="True" />
</Rel>

Loader
To create the relationship between the RelDef-access group relationship and the condition, do
the following:
<Rel>
<IObject UID="SPFDocRevisionLabel.DocumentUpdate.CND_IsObj1WORKING"
Name="" Description="" ContainerID="" />
<IRel UID2="CND_IsObj1WORKING"
DefUID="SPFRelDefAccessGroupDDCondition"
UID1="SPFDocRevisionLabel.DocumentUpdate" OrderValue="0"
IsRequired="False" />
</Rel>
Terminating a Relationship to Relationship

NLF Example
The following load file is an example of terminating a relationship.
# Terminate the drag drop condition relationship on the relDefAccessgrouop
relationship
.SPFRelDefAccessGroupDDCondition
..Name1|Rel|SPFRelDefAccessGroup|SPFDocRevisionLabel|DocumentUpdate
..Name2|IsObj1WORKING
..Action|Terminate
XML Example
The following is an example of using a fully qualified XML-based load file with this operation.
This excerpt was taken from the model build file <installation directory>:\Program
Files\SmartPlant\Foundation\2009\Models\Core\ADMIN_DocMgt.xml
<DeleteInstruction>
<IObject
UID="Delete_SPFLLALineListRecordDocumentVersion.ISPFAuthPublishableDocu
mentVersion"
Name="Delete_SPFLLALineListRecordDocumentVersion.ISPFAuthPublishableDoc
umentVersion" />
<IRefObject RefClass=""
RefUID="SPFLLALineListRecordDocumentVersion.ISPFAuthPublishableDocument
Version" RefName="" />
<IInstruction />
Attaching a File to an Object

NLF Example
The following load file is an example of attaching a file to an object. In this case, a transmittal is
being attached.
.BeginContainer
.UploadInstruction
..RefClass|SPFDesignFile
..RefName|file2.txt
.SPFDesignFile

Loader
..Name|file2.txt
..SPFCExternalTransmittal|JK1|SPFFileComposition_12
..SPFLocalDirectory|D:\Products\SPF40\SPF40_JK\XmtlFileAttach
..SPFLocalFileName|file2.txt
..SPFVault|SPF40Vault|SPFFileVault_12
..SPFEditInd|True
..SPFViewInd|True
.EndContainer
XML Example
For an XML example of attaching a file to an object, see Design Document Creation (on page
525).
Attaching a Document to a Workflow

NLF Example
The following is an example of loading a document and attaching it to a workflow. The
workflow instruction must be in a new container.
.BeginContainer
.SPFDesignDocMaster
..Name|DocABC5
..Description|NLF Document ABC
..SPFDocCategory|3DDocuments
..SPFDocType|Civil
..SPFTitle|Testing loader
..SPFMajorRevision|01
..SPFMinorRevision|A
..SPFRevisionScheme|Rev01A|SPFDocRevisionRevisionScheme_12
.EndContainer
.BeginContainer
.SPFDesignDocRevision
..Name|DocABC5
..Action|AttachWorkflow|Document_Review_And_Sign_Off
.EndContainer

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.

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
 To take responsibility for a step in a SmartPlant Foundation workflow.
 To identify the scope of a project by adding items to the project from a drawing or a 3-D
model. When authoring tools are integrated, SmartPlant P&ID claims items that are shared
among tools. Other authoring tools, such as SmartPlant Instrumentation and SmartPlant 3D,
claim items that they create and modify that are not shared.
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.

Glossary
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.
correlation
The relationship between items that represent the same object in multiple authoring tools.

Glossary
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.
data sheet template

An Excel file that defines the layout of a data sheet.
database
Collection of files of comprehensive information that have predefined structure and organization;
a specific program can communicate, interpret, or process these files.
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.

Glossary
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.
downstream forecasting
A feature that uses timestring information and actual dates when steps were completed to
provide an estimated completion date for subsequent steps.

Glossary
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.

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.

Glossary
graphic report
A filtered view of a drawing or model, displayed graphically in SmartPlant Foundation.
graphic report definition

A set of rules defined to display a drawing or model as a graphic report. The report definition is
saved and is also available for use with any number of drawings or models 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.

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.

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.
Plant Breakdown Structure (PBS)

The composition of the plant based on the grouping of physical objects by their function in the
plant. The plant usually occupies the top level of the hierarchy and is typically followed by areas
and units.
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.

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.
Reason For Issue (RFI)

The reason a document is released as part of a transmittal.
Reason For Receipt (RFR)

The reason why a specific recipient was included on a transmittal or workflow step.

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.

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.

Glossary
server
A computer that stores or processes files.
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.

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.

Glossary
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.
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.

Glossary
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.
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.
unit of measure list

A collection of different units that measure the same property in SmartPlant Foundation.
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.

Glossary
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.
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.

Glossary
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 *
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.

Glossary

Index
3 C
3D Navigation Controls • 119 cache • 530
3D Navigation Tips • 128 Cache 3D model files • 108
Cache file types to the SmartPlant
A Foundation server • 108
Calculate progress • 482
Access load queues • 380 Cancel a check out • 184
Acknowledge an information step • 365 Cancel a transmittal • 338
Activate a reserved vendor document • 169 cases • 530
active scope • 529 Change auto-focus options for comparison
adapter • 529 results • 210, 419
Add an object subscription • 312 Change colors for comparison results • 210,
Add objects to the New Items window • 56 419
Add or remove relationships for composite Change default containerIDs for new
3D documents • 461 objects • 93
Ad-hoc reports • 285 Change display indicators for comparison
Administration • 24, 25, 26, 28, 30, 32 results • 210, 419
Allow users to publish documents to a Change general user preferences • 88
default workflow • 450 change notification • 530
API • 529 Change Notifications • 311
Apply a graphic report to a model • 309 Change the display of data in the List View •
Approve a step in a workflow • 368 59
Archive and purge • 214 Change the duration for a workflow step •
Archive files • 215 370
as-built • 529 Change the effective date • 82
Assign documents to an issue request • 335 Change the owning group for an object •
Attach a document to a transmittal • 335 154
Attach a file to a document • 177 Change the Properties window view • 58
Attach a label to a document • 225 Change user • 81
Attach a watermark to a document • 224 Change user password • 80
Attach a workflow • 349 Change user preferences • 83
Attach the list to an existing document • 227 Change user preferences for 3D viewing •
Attaching a Document to a Workflow • 528 93
Attaching a File to an Object • 527 Change user preferences for a claim • 471
Attaching Files • 505 Change user preferences for APIs • 92
Attaching Files (XML) • 497 Change user preferences for claiming
attribute • 529 objects • 92
authoring tools • 529 Change user preferences for expansion •
Automatically hide a window • 49 91
Change user preferences for windows • 90
B Change windows options • 47
Batch print attached files • 388 Check in a document • 188
batch printing • 529 Check in and check out a document • 179
brownfield • 530 check out • 530
Build display sets • 144 Check out a document • 183
Check out and edit a document in an
authoring application • 185
Check published document status • 381

Index
Checking Hardware Acceleration Settings - Copy the latest revision of a document •

Microsoft Vista/Windows 7 Instructions • 173
132 Correlate items automatically during publish
Checking Hardware Acceleration Settings - • 429
Microsoft Windows XP Instructions • 135 Correlate items from a new tool • 430
checklist • 530 Correlate items from PDS or AVEVA PDMS
claim • 530 • 432
Claim a step in a workflow • 365 Correlate items manually after publish • 429
Claim an issued document • 474 Correlating items • 427
Claim an object • 471 correlation • 531
Clear the New Items window • 57 Create a contract • 326
client API • 530 Create a data sheet document • 257
Clip volumes • 137 Create a line list document snapshot • 228,
Collapse sections on forms • 53 283
Command Line Usage for the Loader • 519 Create a line list record document • 282
common UI • 531 Create a list document snapshot • 227
compare • 531 Create a load file • 488
Compare data sheet snapshots • 259 Create a new design document • 162
Compare design basis documents to the Create a new graphic report • 302
design • 426 Create a new label • 225
Compare design basis objects to the design Create a new list document • 227
• 425 Create a new object in the List Edit window
Compare document versions • 206, 415 • 68
Compare object to a higher configuration • Create a new object using the Create dialog
476 box • 152
Compare published items and work process Create a new object using the Create
considerations • 424 wizard • 148
Compare with design • 427 Create a new report • 288
Comparing documents • 201, 410 Create a new template document • 179
Comparing published documents • 423 Create a new vendor document • 165
Complete a step in a workflow • 366 Create a new watermark • 223
component • 531 Create a process case • 245
component schema • 531 Create a snapshot of a data sheet
Components of the document model • 156 document • 257
Components of the Line List application • Create a snapshot of a document version •
273 199
Concurrent Engineering • 469 Create a supplier for transmittals • 325
condition • 531 Create a template from Microsoft Excel •
configuration tree • 531 408
Configure export template • 407 Create a template from the Desktop Client •
Configure the list in the List Edit window • 409
65 Create a transmittal from a template • 336
Configure the progress model • 483 Create an external company • 325
Configure the Shortcut toolbar • 54 Create an external department or office for
container • 531 transmittals • 325
ContainerID • 512 Create an external transmittal • 332
contract • 531 Create an external transmittal for a set of
Convert files for navigation • 118 documents • 334
Copy a document • 170 Create an internal department or office •
Copy a transmittal • 336 324
Copy an object • 153 Create an internal transmittal • 330
Copy and paste in the List Edit window • 69 Create an internal transmittal for a set of
Copy attached files • 178 documents • 333

Index
Create and manage documents in Distribution matrices • 321

SmartPlant Foundation • 159 distribution matrix • 533
Create and manage objects in a data list • Dock a floating window • 50
270 document • 533
Create and manage transmittals • 326 Document life cycle • 155
Create and Modify Objects • 145 Document Management • 155
Create line lists interactively • 281 document master • 533
create scope • 532 document revision • 533
Create tab windows from multiple windows • Document status icons • 158
52 Document types for retrieval • 463
Create the 3D composite model manually • Document-Managed Data Sheets • 256
459 domain • 533
Create, edit, or delete related items in a list downstream forecasting • 533
edit window • 232 Drag objects to create relationships • 231
CreateConfig Setting • 511 dump file • 534
Creating line lists from SmartPlant P&ID
data • 276 E
current document • 532
cut-off date • 532 edge definition • 534
Edit a graphic report definition • 304
Edit a list associated with a list document •
D 227
Data Creation • 522 Edit a previous query • 100
Data handling after retrieval • 463 Edit Microsoft Excel security settings for
data list • 532 data sheets and data lists • 241
Data Lists • 264 Edit the properties of an object in the List
Data Lists in NLF Format • 508 Edit window • 66
data sheet • 532 effectivity date • 534
data sheet template • 532 e-mail digest • 534
Data Sheets • 242 Enable the Shortcut toolbar • 54
Data Sheets and Data Lists • 241 Enhanced Mechanical Equipment Data
database • 532 Sheets • 261
Date Time Handling • 511 Enter Fly Mode • 126
Define filter criteria for an ad hoc report • enumerated entry • 534
292 enumerated list • 534
Delete a document • 175 Exception Reports • 516
Delete a document revision • 200 Exploring the Desktop Client User Interface
Delete a saved query • 101 • 35
Delete an attached workflow • 349 Export a transmittal • 336
Delete an object • 153 Export list to Excel • 66
Delete an object in the List View window • Export progress data to Excel • 485
69 Export the contents of a List View to a text
design basis • 532 file • 60
Design basis • 465 Export the contents of a List View to Excel •
Design Document Creation • 525 60, 401
design file • 533 Export the contents of a List View to the
digest • 533 default template • 59, 401
Display an object in a new window • 53 Export the contents of a List View to the
Display details for an object • 154 selected template • 59, 401
display item • 533 exposes • 534
Display objects in a separate window by Extended view of the Properties window •
configuration • 91 44
Display or hide a window • 49
Display the history of an object • 154

Index
F Graphic Reports • 298

Graphical Navigation • 107
Field Types for NLF • 506
Graphics Card Information • 129
file server • 535
greenfield • 536
file type • 535
Filter items to display • 65
Find a change in the Comparison Results H
table • 211, 420 hierarchy • 536
Find a selected change in compared host • 536
drawings • 211, 420 hotspot • 536
Find an existing activity • 484
Find an existing design workpack or design I
workpack template • 483
Find an existing set of progress options • implies • 536
484 Import data from Microsoft Excel • 397
Find an object • 99 Import data from Microsoft Excel and
Find an object using an FTR search • 102 compare • 398
Find data sheet documents • 258 Indicate a step cannot be completed • 367
Find published documents • 379 Insert a historical revision • 198
Find registered tools • 238 Integrated line lists • 275
Fit • 213, 422 integration • 536
Fit to Object(s) • 127 Integration • 391
folder • 535 interface definition • 537
form • 535 issue • 537
Freeze a column • 66 issue request • 537
Freeze plan dates • 484
FTR • 535 L
Full-Text Retrieval (FTR) • 104 Launch SmartPlant Foundation from a
command prompt • 392
G Launch SmartPlant Foundation in an
Generate a configuration report • 478 integrated environment • 392
Generate a data list from a related object • Launch SmartPlant Review from
268 SmartPlant Foundation • 143
Generate a document revision report for a Learn about data list templates • 265
document • 200 Learn about instrument data sheet
Generate a future changes report • 478 templates • 244
Generate a merge validation report • 478 Learn about publish workflows • 450
Generate and edit a data sheet offline • 248 Learn about the Consolidated Data
Generate and edit an instrument data list Warehouse • 394
offline • 267 Learn about the SmartPlant Foundation
Generate and edit an instrument data list Desktop Client user profile • 47
online • 265 Learn more about file types for reference
Generate and edit an Instrument data sheet files • 219
(IPD) online • 246 Learn more about mechanical equipment
Generate PDF copies • 175 data sheet options and functionality • 262
Generate view renditions • 175 Learn more about publishing in an
Get to know keyboard shortcuts • 72 integrated environment • 453
Get to know the Desktop Client user Learn more about publishing large 3D
interface • 39 models to SmartPlant Foundation • 458
governing case • 535 Learn more about reporting output styles •
graph definition • 535 296
graphic report • 536 Learn more about retrieving documents in
graphic report definition • 536 an integrated environment • 462

Index
Learn more about revising documents • 440 Menu bar • 40

Learn more about searching for objects in Merge a claimed object into the plant • 474
SmartPlant Foundation • 102 Merge a complete configuration • 475
Learn more about setting the active scope • meta schema • 537
78 method • 537
Learn more about the View and Compare Modes for Load Files • 512
window • 212, 421 Modify line list records • 282
Learn more about Transmittals • 317 Modify the symbology of a graphic report •
Learn more about workflows • 341 305
Learn more about working in an integrated Move • 126
environment • 391
Learn revision scheme behavior through N
scenarios • 444
Line list • 274 Navigate queries • 101
Line list document • 274 Navigate the Tree view • 55
Line list record • 274 Navigating queries • 103
Line Lists • 273 New Items window • 42
Line segment • 274 NLF Format • 500
List documents • 226 NLF Instructions • 501
List Edit window • 45 NLF Load File Date Examples • 510
List list icons • 275 NLF Load Format for Documents • 504
List view • 44
Load Errors and Reloading Files • 514 O
Load File Examples • 521 Object Mode in NLF Format • 509
Load offline data sheets and data lists • 250 Open the List Edit window • 63
Load offline datasheets and data lists • 491 owning group • 537
Load Queue Management • 377
Load the template file into the Desktop
Client • 409
P
Loader • 487 Pan • 213, 422
Loader Directory Poller • 520 Partially mapped data sheets • 255
Lock a Markup file • 117 Perform SmartPlant Foundation Instructions
Look ahead for associations • 81 • 522
Look Around • 126 Personalize status code colors • 69
picklist • 538
Place a published P&ID in a 3D model • 116
M plant • 538
Maintain relationships for an object • 233 Plant and Project Data in SmartPlant
Maintain versions of the composite Foundation • 80
document in SmartPlant Foundation • Plant Breakdown Structure (PBS) • 538
458 Preface • 17
Manage class subscriptions • 315 Print a 3D model • 117
Manage object subscriptions • 312 Print a document with a label • 226
Manage process cases • 244 Print a document with a watermark • 225
Manage responses to workflow steps for Print a List View window • 388
users • 351 Print files to a local printer • 389
Manage the load queue • 382 print server • 538
Manage transmittal responses for e-mail Print the contents of a dialog box • 388
and paper users • 339 Print the contents of a List View window •
Manage windows and forms in SmartPlant 388
Foundation • 46 Printing in the Desktop Client • 385
Map file for equipment data sheets • 264 Process a load file • 489
master file • 537 process cases • 538
Maximize a window • 52

Index
profile • 538 R
progress • 538
realizes • 539
Progress • 481
Reason For Issue (RFI) • 539
Progress example • 482
Reason For Receipt (RFR) • 539
project • 538
Reasons to publish • 455
Properties window • 43
Reassign a step to another user or role •
property • 538
369
property definition • 539
Redistribute man hours • 484
publish • 539
reference file • 540
Publish a data sheet • 251
Reference files • 216
Publish a data sheet snapshot • 260
Refresh the To Do List • 363
Publish a line list document snapshot to the
register • 540
data warehouse • 283
Register SmartPlant Foundation • 238
Publish data from Microsoft Excel • 402
Register SmartPlant Foundation (EQD) •
Publish data from Microsoft Excel and
263
compare • 404
Register SmartPlant Foundation as a Tool •
Publish data sheets • 263
237
Publish documents • 378
Reject a step in a workflow • 369
Publish SmartPlant Foundation data • 446
Reject an attached workflow • 350
Publish the 3D model in PDS • 459
Relations for NLF • 506
Publish the 3D model in SmartPlant 3D or
relationship • 540
SmartMarine 3D • 459
relationship definition • 540
Publish the 3D model to AVEVA PDMS •
Relationship Examples • 526
459
Relationship Management • 229
Published document statuses • 381
Reload Files • 515
Publishing documents • 455
Remove an object subscription • 314
Publishing files without data • 457
Report progress • 482
Publishing in an integrated environment •
Reports • 285
445
Reserve a vendor document • 168
Publishing large 3D models in SmartPlant
Reset the Tree view • 56
Foundation • 457
Reset user profile • 47, 82
punchlist • 539
Resolve conflicts • 477
Purchase and install enhanced mechanical
Resolve conflicts and generate reports •
equipment data sheets for SmartPlant
475
Foundation • 262
Resolve conflicts in the List Edit window •
Purge superseded versions for a document
70
• 200
resurrected object • 540
Put an attached workflow on hold • 349
retrieve • 540
Retrieve a data sheet • 253
Q Retrieve and restore • 465
Queries • 102 Retrieve data into the line list application •
query • 539 278
Query for a 3D composite document in Retrieve in SmartPlant Foundation • 465
SmartPlant Foundation • 459 Retrieving in an integrated environment •
Query for a published document • 448 462
Query for a published document by queue • Retry a failed task • 377
380 Retry failed document • 382
Query for an object • 99 Return to Default View • 125
Query for data sheet documents • 259 Review the archive document and archive
Query for scheduled tasks • 376 information files within Desktop Client •
Query published documents • 379 216
query scope • 539 Revise a document • 196, 440
Quick finds • 103 Revise a document in SmartPlant 3D • 442

Index
Revising document • 438 Set view options • 212, 421

revision • 540 shared object definition • 542
revision scheme • 541 sharing • 542
Revisions and versions • 194 Shortcut toolbar • 41
Revisions and versions of publishing Show all revisions for a document • 198
documents • 457 Show all versions for a document • 198
role • 541 Show items related to a workflow step • 363
Roll up a line segment • 280 Show nested reference files • 221
Roll up and consolidate line lists • 278 Show or hide the checklist preview pane in
rollup • 541 the To Do List • 364
Run a report as a scheduled task • 295 Show or hide the New Items window • 56
Run a saved query • 100 Show or hide the Properties window • 57
Run an existing report • 292 Show or hide the To Do List • 363
Run the Desktop Client from a UNC share • Show or hide the Tree view • 55
38 SI • 542
Run the Desktop Client from a URL • 39 sign off • 542
Run the Loader Directory Poller • 520 Sign off a document • 191
Sign off a document with comments • 193
S Sign off on a document • 189
site • 542
Save a query • 100 SmartPlant Basic Integrator • 392
Save a transmittal as a template • 339 SmartPlant Enterprise • 542
Save alternate renditions • 176 SmartPlant Enterprise integration methods •
Save lists as documents • 72 392
Scheduler • 375 SmartPlant Registration Wizard • 238
Schedulers and Queue Management • 375 SmartPlant Review with SmartPlant
schema • 541 Foundation • 143
Schema Component • 541 SmartPlant schema • 542
scoped by • 541 Sort columns in the List Edit window • 65
Search for Objects • 95 Start the Desktop Client • 35
Search results • 104 Start the Desktop Client from the command
Searching for objects in the SmartPlant line • 36
Foundation Desktop Client • 95 status • 543
section • 541 Status bar • 40
Select • 213, 422 Status Codes • 45
Select a graphic report to run • 308 step • 543
Select a standard isometric or orthographic Stop or start a scheduler • 376
view • 115 Stop or start load queue • 383
Select an Object • 127 subscribe • 543
Select the layout for the Compare window • Subscribe to claim notifications • 475
208, 417 superseded • 543
server • 542 Supporting Relationship Relations • 507
Service Pack 1 • 24 SuppressENS • 513
Set a clipping volume • 141 Symbol and special character searches •
Set the active configuration by roles • 79 104
Set the controlling recipient for a transmittal symbology • 543
• 338
Set the date and time in the List Edit
window • 64 T
Set the planned date for a transmittal • 337 Take an attached workflow off hold • 350
Set the refresh interval for the To Do List • TEF • 543
363 terminate • 543
Set up transmittals • 322 Terminate a document revision • 201
Set user options • 75 Terminate a report • 296

Index
Terminate a transmittal • 338 Update workflow • 371

Terminate a transmittal section • 338 Use 3D model relationships • 116
Terminate an attached workflow • 350 Use concurrent engineering • 469
Terminate an object • 154 Use Keyboard-Only 3D Navigation • 120
Terminate relationships • 235 Use load options • 436
timestring • 543 Use minor revisions in SmartPlant P&ID •
title block • 544 443
To Do List • 359, 544 Use Mouse Only or Mouse + Keyboard
token • 544 Combinations (Fly Mode) • 122
tombstone • 544 Use SmartPlant Foundation as an
tool • 544 Authoring Tool • 237
tool adapter • 544 Use the 3D Navigator • 124
tool schema • 544 Use the List Edit window • 61
tool signature • 545 Use the List view • 58
Toolbar • 40 Use the New Items window • 56
Transaction Handling • 510 Use the Properties window • 57
transmittal • 545 Use the Shortcut toolbar • 54
Transmittal icons • 318 Use the Tree view • 54
Transmittal life cycle • 320 user • 545
Transmittal project roles • 319 User • 24, 25, 27, 29, 30
Transmittal structure • 321 User Options • 75
Transmittals • 317 user profile • 545
Tree view • 41 Using line lists • 277
Troubleshoot 3D Navigation • 130 Using SmartPlant Materials to modify data •
Turn off Auto-Hide mode • 50 277
Turn off volume clipping • 142 Using the SmartPlant Foundation Desktop
Client • 23
U
Unclaim an object • 475 V
Understand Load, Consolidated, and vault • 546
MergeDelta tasks • 451 version • 546
Undock a tabbed window • 52 Version 2009 • 30
Undock a window • 51 Version 2009 R3 SP2 • 27
unit • 545 Version 2009 R3 SP3 • 25
unit of measure list • 545 Version 2009 R4 • 24
Unlock a Markup file • 118 Version 2009 R4 Service Packs • 24
UoM • 545 Version 2009 SP1 • 29
Update a workflow • 352 View a 2D file • 114
Update an object • 153 View a 3D model • 114
Update an object subscription • 314 View a connected drawing • 116
Update Maintain Relations properties on View a model in SmartPlant Review • 144
reference files • 220 View a report of overdue workflow steps •
Update reference relationships • 221 357
Update relationship data for an object • 232 View a successfully published document •
Update saved queries • 100 380
Update the checklist for a workflow step • View a transmittal structure • 338
364 View a transmittal summary report • 339
Update the data sheet template for partially View a workflow • 352
mapped data sheets • 255 View a workflow details report for a
Update the description for a workflow step • document • 357
370 View alternate files • 118
Update transmittal recipients • 337 View an existing graphic report • 307
Update users in the Assignment list • 355 View an existing report • 291

Index
View an item in a drawing • 115 Work Breakdown Structure (WBS) • 547

View an item in a model • 115 workflow • 547
View an item in SmartPlant Review • 144 Workflow example • 342
View and annotate files • 109 Workflow status • 345
View and compare document versions • Workflow templates • 345
205, 414 Workflows • 341
View and edit XML load files • 490 working document • 547
View and mark up files • 107 Working with Microsoft Excel • 394
View and Markup • 214, 423 Working with workflows • 346
View authoring tools registered with the
current plant • 437 X
view definition • 546
View document history • 435 XML • 547
View documents in a queue • 378, 435 XML Format • 493
View documents in load queues • 436 XML Instructions • 493
View drawing items in a published XML Load Formats for Documents • 496
document • 449
View Exception Reports • 517 Z
View Exception Reports for Individual Load Zoom area • 213, 422
Errors • 518 Zoom in • 212, 421
View items in SmartPlant Foundation Zoom out • 212, 421
Desktop Client • 108
View progress data • 485
View progress data graphically • 485
View published document information • 380
View reference files for a document revision
• 222
View relationship objects • 373
View relationships • 232
View shared objects • 434
View the 3D model in SmartPlant
Foundation • 459
View the transmittal history for a document •
339
View with native application • 118
View workflow • 373
View workflow details • 374
View workflow details for a document • 357
View workflow history for a document • 357
Viewing Errors in the Loader • 514
Viewing status and history • 435
virtual directory • 546
W
Watermarks and labels • 222
Web Portal • 546
weighting • 546
Welcome to SmartPlant Foundation
Desktop Client • 23
What's New in SmartPlant Foundation
Desktop Client? • 24
wildcard • 547
Wildcards • 103

SPFDesktop Client

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SPFDesktop Client

Uploaded by

Copyright:

Available Formats

SmartPlant Foundation

Version 2009 R4 and Service Packs

August 2012/March 2013

Welcome to SmartPlant Foundation Desktop Client ............................................................................. 23

Exploring the Desktop Client User Interface .......................................................................................... 35

SmartPlant Foundation Desktop Client User's Guide 5

Use the Tree view ................................................................................................................................. 54

User Options .............................................................................................................................................. 75

6 SmartPlant Foundation Desktop Client User's Guide

Search for Objects ..................................................................................................................................... 95

Graphical Navigation ............................................................................................................................... 107

SmartPlant Foundation Desktop Client User's Guide 7

Turn off volume clipping ............................................................................................................... 142

Create and Modify Objects ..................................................................................................................... 145

Document Management .......................................................................................................................... 155

8 SmartPlant Foundation Desktop Client User's Guide

Delete a document revision .......................................................................................................... 200

Relationship Management ...................................................................................................................... 229

Use SmartPlant Foundation as an Authoring Tool .............................................................................. 237

Data Sheets and Data Lists .................................................................................................................... 241

SmartPlant Foundation Desktop Client User's Guide 9

Data Sheets ........................................................................................................................................ 242

Line Lists .................................................................................................................................................. 273

10 SmartPlant Foundation Desktop Client User's Guide

Reports ..................................................................................................................................................... 285

Change Notifications ............................................................................................................................... 311

Transmittals ............................................................................................................................................. 317

SmartPlant Foundation Desktop Client User's Guide 11

Terminate a transmittal section .................................................................................................... 338

To Do List ................................................................................................................................................. 359

Schedulers and Queue Management .................................................................................................... 375

12 SmartPlant Foundation Desktop Client User's Guide

Stop or start a scheduler .............................................................................................................. 376

Printing in the Desktop Client ................................................................................................................ 385

Integration ................................................................................................................................................ 391

SmartPlant Foundation Desktop Client User's Guide 13

Compare design basis objects to the design ............................................................................... 425

Concurrent Engineering ......................................................................................................................... 469

14 SmartPlant Foundation Desktop Client User's Guide

Merge a complete configuration ................................................................................................... 475

Progress ................................................................................................................................................... 481

Loader ....................................................................................................................................................... 487

SmartPlant Foundation Desktop Client User's Guide 15

Exception Reports ........................................................................................................................ 516

Glossary ................................................................................................................................................... 529

Index ......................................................................................................................................................... 549

16 SmartPlant Foundation Desktop Client User's Guide

SmartPlant Foundation Product Documentation

Installation and Overviews

SmartPlant Foundation Desktop Client User's Guide 17

 Integration: A Gentle Introduction to the SmartPlant Schema - Provides an introduction to

18 SmartPlant Foundation Desktop Client User's Guide

Model Configuration Guides

SmartPlant Foundation Desktop Client User's Guide 19

20 SmartPlant Foundation Desktop Client User's Guide

Intergraph Work Process Guides

SmartPlant Foundation Desktop Client User's Guide 21

 SmartPlant Enterprise SmartPlant Adapter for SmartPlant Electrical - Describes the

22 SmartPlant Foundation Desktop Client User's Guide

Welcome to SmartPlant Foundation

Using the SmartPlant Foundation Desktop Client

SmartPlant Foundation Desktop Client User's Guide 23

What's New in SmartPlant Foundation Desktop