Schem SPPID Engineering

SmartPlant P&ID Engineering
User's Guide
Version 2014 R1 (7.1)
March 2015
DPID2-PE-200029C
Copyright
Copyright © 2012-2015 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
305 Intergraph Way
Madison, AL 35758
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
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 and Documentation. 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.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. 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, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. 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.
2 SmartPlant P&ID Engineering User's Guide

Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN,
Sapphire, 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.
SmartPlant P&ID Engineering User's Guide 3

Contents
SmartPlant P&ID Engineering .................................................................................................................. 13
SmartPlant P&ID Program Group ......................................................................................................... 14
Additional Documentation ..................................................................................................................... 15
SmartPlant P&ID Engineering Help Command (Help Menu) ......................................................... 15
Printable Guides Command (Help Menu) ...................................................................................... 15
SmartPlant P&ID Technical User Forum Command (Help Menu) ................................................. 16
About SmartPlant P&ID Engineering Command (Help Menu) ....................................................... 16
Display Help for Programming with SmartPlant P&ID Engineering ............................................... 16
Navigating in the Software ....................................................................................................................... 17

Using Shortcut Keys ............................................................................................................................. 18
Shortcuts with Catalog Explorer ..................................................................................................... 18
Working with the Design Window ......................................................................................................... 20
Show Command ............................................................................................................................. 22
Options Command (Tools Menu) ................................................................................................... 22
View Menu ...................................................................................................................................... 25
Window Menu ................................................................................................................................. 33
Navigating in the Engineering Data Editor ............................................................................................ 35
Customizing the Display of the Engineering Data Editor ............................................................... 36
Editing Item Properties in the Engineering Data Editor .................................................................. 40
Plant Editing ................................................................................................................................... 43
Display > Engineering Data Editor Command (View Menu) .......................................................... 47
Actions Menu (Engineering Data Editor) ........................................................................................ 49
Edit Menu (Engineering Data Editor) .............................................................................................. 50
View Menu (Engineering Data Editor) ............................................................................................ 51
Engineering Data Editor Shortcut Menu ......................................................................................... 59
Using Catalog Explorer ......................................................................................................................... 59
Catalog Explorer Command (View > Display Menu) ...................................................................... 60
Catalog Menu ................................................................................................................................. 61
View Menu ...................................................................................................................................... 65
Navigation Menu ............................................................................................................................. 66
Customizing Catalog Explorer ........................................................................................................ 68
Navigating in the Properties Window .................................................................................................... 69
Working with the Properties Window.............................................................................................. 69
Properties Window Command (View Menu) .................................................................................. 70
Customizing the Software ..................................................................................................................... 74
Customize Command (Tools Menu) ............................................................................................... 75
Custom Commands Command ...................................................................................................... 80
Working with Drawings ............................................................................................................................. 85

Open Command (File Menu) ................................................................................................................ 86
Open Dialog Box ............................................................................................................................ 86
Open Plant Structure Dialog Box ................................................................................................... 87
Filter Dialog Box ............................................................................................................................. 88
Customize Current View Dialog Box .............................................................................................. 88
Open an Existing Drawing .............................................................................................................. 89

Contents
Open a Drawing in a Different Database........................................................................................ 89

Customize the Open Dialog Box .................................................................................................... 89
Recent Drawings Command (File Menu) .............................................................................................. 90
Access a Recently Open Drawing .................................................................................................. 90
Switch to Another Open Drawing or View ...................................................................................... 90
Properties Command (File Menu) ......................................................................................................... 90
File Properties Dialog Box .............................................................................................................. 91
View Document Properties ............................................................................................................. 93
Set Document Properties ............................................................................................................... 93
Close Command (File Menu) ................................................................................................................ 93
Close an Active Drawing ................................................................................................................ 94
Exit Command (File Menu) ................................................................................................................... 94
Close the Program .......................................................................................................................... 94
Saving Drawings ................................................................................................................................... 94
Save Command (File Menu) .......................................................................................................... 95
Save a Drawing in a Different Format ............................................................................................ 95
Configuration File Settings for AutoCAD Translation ..................................................................... 97
Configuration File Settings for MicroStation Translation .............................................................. 106
Save As Command (File Menu) ................................................................................................... 114
Save As Dialog Box ...................................................................................................................... 114
Save a Drawing as a PDF File ..................................................................................................... 114
Save as PDF Command (File Menu) ........................................................................................... 114
Save as PDF Dialog Box .............................................................................................................. 115
Re-creating Drawings ......................................................................................................................... 115
Re-create a Drawing ..................................................................................................................... 117
Using Filters ........................................................................................................................................ 118
Working with P&IDs in SmartPlant P&ID Engineering ........................................................................ 119

Understanding Database Constraints ................................................................................................. 119
Selecting Drawing Items ..................................................................................................................... 120
Select Tool Command .................................................................................................................. 121
Select Tool Ribbon ....................................................................................................................... 121
Polygon Fence Locate Command ................................................................................................ 121
Polygon Fence Ribbon ................................................................................................................. 121
Configuration (QuickPick) Tool ..................................................................................................... 122
Select an Item ............................................................................................................................... 122
Select an Item Using the Configuration (QuickPick) Tool ............................................................ 123
Select a Polygon-Shaped Area of a Drawing ............................................................................... 124
Define Locate Filter Dialog Box .................................................................................................... 124
Assigning Heat Tracing and Jacketing ............................................................................................... 124
Create a New Heat Tracing Medium ............................................................................................ 126
Define Heat Tracing Graphics for an Item .................................................................................... 127
Modify the Offset Distance of Heat Trace Lines ........................................................................... 128
Assign Heat Tracing to an Item .................................................................................................... 132
Define Heat Trace Media as Pipe Jacketing ................................................................................ 133
Define Jacketing Graphics for an Item ......................................................................................... 134
Create a New Jacketed Property for Pipe Runs .......................................................................... 135
Assign a Jacketed Heat Trace to an Item .................................................................................... 136
Using Piping Components .................................................................................................................. 137
Using the Piping Specification Utility ............................................................................................ 137

Contents
Working with Instruments and Loops .................................................................................................. 141

Loop Tag Dialog Box .................................................................................................................... 142
Add Instruments to a Loop ........................................................................................................... 142
Update Associated Instruments with Loop Properties Dialog Box ............................................... 143
Remove an Instrument from a Loop ............................................................................................. 143
Using Implied Items ............................................................................................................................ 144
Calling Item Tag Validation ................................................................................................................. 144
Item Tag Validation Scope ........................................................................................................... 146
Labeling ............................................................................................................................................... 147
Using Off-Page and Utility Connectors......................................................................................... 148
Adding Design Elements ..................................................................................................................... 152
Place a Package........................................................................................................................... 152
Place a Safety Class .................................................................................................................... 153
Place a Test System..................................................................................................................... 153
Place a Hydro Test Package ........................................................................................................ 154
Defining Test System Relationships ............................................................................................. 155
Place a Contract Package ............................................................................................................ 156
Modifying Items in SmartPlant P&ID Engineering .............................................................................. 156
Undo Command (Edit Menu) ........................................................................................................ 157
Move Command (Edit Menu) ....................................................................................................... 158
Move to Drawing Command (Edit Menu) ..................................................................................... 158
Finding Drawing Items .................................................................................................................. 158
Mirror Command (Edit Menu) ....................................................................................................... 163
Rotate Command (Edit Menu) ...................................................................................................... 163
Cut Command (Edit Menu) ........................................................................................................... 163
Paste Command (Edit Menu) ....................................................................................................... 164
Paste Special Command (Edit Menu) .......................................................................................... 164
Select All Command (Edit Menu) ................................................................................................. 164
Delete to Stockpile Commands (Edit Menu) ................................................................................ 164
Delete from Model Command (Edit Menu) ................................................................................... 164
Copying Items............................................................................................................................... 165
Selecting Connected Items .......................................................................................................... 165
Modifying Item Properties ............................................................................................................. 167
Moving Stockpile Items ....................................................................................................................... 170
Move to Different Stockpile Dialog Box ........................................................................................ 171
Move a Stockpile Item to the Stockpile of Another Drawing ........................................................ 171
Using Reports to Import Items into the Stockpile ......................................................................... 172
Populate the Stockpile from a Spreadsheet ................................................................................. 173
Create a New Pump by Importing a SmartPlant P&ID Report into the Stockpile ........................ 173
Typicals ............................................................................................................................................... 174
Typicals Common Tasks .............................................................................................................. 174
Create Typical Command (Edit Menu) ......................................................................................... 175
Select a View ................................................................................................................................ 175
Move to Primary Command (Edit Menu) ...................................................................................... 176
Move to Typical Command (Edit Menu) ....................................................................................... 176
Print a Typical View ...................................................................................................................... 176
Gapping Lines ..................................................................................................................................... 177
AutoGap Command (Tools Menu) ............................................................................................... 177
Gap Now Command (Tools Menu) ............................................................................................... 177

Contents
System Editing .................................................................................................................................... 177

System Editing and Consistency Checking .................................................................................. 179
System Editing and Projects ........................................................................................................ 180
System Editing Command (Tools Menu) ...................................................................................... 180
Enable System Editing ................................................................................................................. 180
Using Filters to Create and Apply Display Sets .................................................................................. 180
Apply Display Set Command (View Menu) .................................................................................. 180
Clear Display Set Command (View Menu) ................................................................................... 180
Apply Display Set Dialog Box ....................................................................................................... 181
Define a Display Set ..................................................................................................................... 183
Apply a Display Set ...................................................................................................................... 184
Asking Filters Dialog Box.............................................................................................................. 186
Update Symbology Command (Tools Menu) ...................................................................................... 186
Linking and Embedding Objects ......................................................................................................... 186
Insert > Image Command (Edit Menu) ......................................................................................... 187
Insert > Object Command (Edit Menu) ......................................................................................... 187
Links Command (Edit Menu) ........................................................................................................ 187
Check Symbol Paths .................................................................................................................... 187
Working with Assemblies .................................................................................................................... 187
Save as Assembly Command (File Menu) ................................................................................... 188
Create an Assembly ..................................................................................................................... 188
Working with Drawings in Projects ....................................................................................................... 191

Working with Off-Site Projects ............................................................................................................ 192
Claiming Items .................................................................................................................................... 192
Claim Command ........................................................................................................................... 194
Release Claim Command............................................................................................................. 197
Claim Status Command................................................................................................................ 198
Show Claims Command (View Menu) .......................................................................................... 199
Comparing and Refreshing Versions .................................................................................................. 199
Compare and Refresh Command (Tools Menu) .......................................................................... 201
Compare With Dialog Box ............................................................................................................ 201
Compare and Refresh Dialog Box ................................................................................................ 201
Compare and Refresh Drawing Versions ..................................................................................... 206
Compare and Refresh Examples ................................................................................................. 208
Consistency Checking ............................................................................................................................ 211

Consistency Checking and Break Labels ........................................................................................... 211
Show Inconsistencies Command (View Menu) .................................................................................. 212
Show Inconsistencies ................................................................................................................... 212
Consistency Check Command (Edit Menu) ........................................................................................ 212
Consistency Check Dialog Box ........................................................................................................... 212
Inconsistencies Tab (Consistency Check Dialog Box) ................................................................. 213
Consistency Criteria Tab (Consistency Check Dialog Box) ......................................................... 215
Review an Inconsistency .................................................................................................................... 217
Resolve an Inconsistency ................................................................................................................... 218
Find Redundant Breaks Command (View Menu) ............................................................................... 219
Find Redundant Breaks ................................................................................................................ 219

Contents
Importing Drawing Data .......................................................................................................................... 221

Data File Command (File > Import Menu) .......................................................................................... 221
Import Log Dialog Box .................................................................................................................. 221
Import > SmartSketch Command (File Menu) .................................................................................... 221
Importing Aspen Basic Engineering Stream Data .............................................................................. 221
Import Aspen Basic Engineering Stream Data ............................................................................. 222
Generating Reports ................................................................................................................................. 223

Generate a Report for an Active Drawing ........................................................................................... 224
Generate a Report for the Plant .......................................................................................................... 225
Generate Reports for Selected Drawings ........................................................................................... 226
Plant Reports Command (Reports Menu) .......................................................................................... 227
Plant Reports Dialog Box .................................................................................................................... 227
My Reports Command (Reports Menu) .............................................................................................. 228
My Reports Dialog Box ....................................................................................................................... 228
Creating and Editing Report Templates .............................................................................................. 229
Improve the Performance of Custom Reports .............................................................................. 229
Tabular Format Report ................................................................................................................. 231
Fixed Format Report ..................................................................................................................... 233
Composite Format Report ............................................................................................................ 233
New Command ............................................................................................................................. 234
Edit Command .............................................................................................................................. 237
Delete Command.......................................................................................................................... 239
SmartPlant Reports Toolbar ......................................................................................................... 240
Printing Drawings .................................................................................................................................... 249

Print Command (File Menu) ................................................................................................................ 250
Print Dialog Box ............................................................................................................................ 250
Settings Dialog Box ...................................................................................................................... 251
Print a Drawing ............................................................................................................................. 252
Print a Selected Area.................................................................................................................... 253
Set Print Options .......................................................................................................................... 253
Change Printer Properties ............................................................................................................ 255
Print to a File ................................................................................................................................ 255
Page Setup Command (File Menu) .................................................................................................... 255
Working with SmartPlant Integration .................................................................................................... 257

Tool Requirements for Integrating SmartPlant P&ID .......................................................................... 258
General Integration Requirements ............................................................................................... 258
Working with SmartPlant Instrumentation .................................................................................... 259
Working with Smart 3D ................................................................................................................. 260
Working with Aspen Basic Engineering........................................................................................ 261
Using Workshare in an Integrated Environment .......................................................................... 261
Using the Catalog Index in SmartPlant P&ID and SmartPlant Integration ................................... 261
Upgrade Schema Command (SmartPlant Menu) ............................................................................... 262
The SmartPlant Adapter and Tool Schema ........................................................................................ 262
Publish .......................................................................................................................................... 262
Retrieve ........................................................................................................................................ 263
SmartPlant P&ID Mapping Rules and Limitations ........................................................................ 264
Tool Schema Location .................................................................................................................. 265
The Tool Schema Data Model ...................................................................................................... 265

Contents
Property Conversions ................................................................................................................... 272

Hierarchical Enumerated Lists ..................................................................................................... 274
Catalog Index ............................................................................................................................... 275
Drawing ........................................................................................................................................ 275
Equipment .................................................................................................................................... 275
Instrument ..................................................................................................................................... 276
PipeRun ........................................................................................................................................ 276
PipeLine ........................................................................................................................................ 277
Special SmartPlant P&ID Mapping Procedures .................................................................................. 277
Publish with Instrument Expansion .............................................................................................. 278
Retrieve Expanded Instruments ................................................................................................... 281
Define Mapping Relationships as 'For Documentation Only' ....................................................... 282
Publish the 'OwnsComponentOcc' Relation ................................................................................. 284
Suppress Generation of Tasks on Retrieve ................................................................................. 286
SmartPlant P&ID Mapping Examples ................................................................................................. 290
SmartPlant P&ID Example: Mapping a New String Property Starting in the Tool........................ 290
SmartPlant P&ID Example: Mapping a New Complex Property Starting in the Tool ................... 297
SmartPlant P&ID Example: Mapping Equipment Classes to Publish Process Data ................... 307
SmartPlant P&ID Example: Define Mapping to Publish Variable Frequency Drives ................... 311
SmartPlant P&ID Example: Mapping New Enumerated List Entries Starting in the
SmartPlant Schema...................................................................................................................... 314
Pre-Publishing Automation from SmartPlant P&ID ............................................................................. 325
Create the Plug-in......................................................................................................................... 325
EFCustomProcess Reference ...................................................................................................... 326
Registering Tools ................................................................................................................................ 331
Accessing the SmartPlant Foundation Web Client ............................................................................. 331
Access the SmartPlant Foundation Web Client ........................................................................... 332
Browser Command (SmartPlant Menu) ....................................................................................... 332
Publishing Documents ........................................................................................................................ 332
Publishing from SmartPlant P&ID - Work Process ....................................................................... 334
Publish Documents from SmartPlant P&ID .................................................................................. 335
Publish a Report ........................................................................................................................... 336
Publish Workflows ........................................................................................................................ 336
Issue Request Documents from SmartPlant P&ID ....................................................................... 338
Publish Command (SmartPlant Menu) ......................................................................................... 339
Publish Dialog Box ....................................................................................................................... 339
Advanced Publish Options Dialog Box ......................................................................................... 343
Find Documents to Publish from SmartPlant P&ID ...................................................................... 344
Find Documents to Publish Command (SmartPlant Menu) ......................................................... 345
Compare with Published Version Command (SmartPlant Menu) ................................................ 345
Find Documents to Publish Dialog Box ........................................................................................ 345
Find Documents to Publish dialog box - Document Types .......................................................... 346
Revising Documents ........................................................................................................................... 346
Retrieving Documents ......................................................................................................................... 347
Retrieving to SmartPlant P&ID - Work Process ........................................................................... 349
Retrieve Documents to SmartPlant P&ID..................................................................................... 349
Retrieve Command (SmartPlant Menu) ....................................................................................... 350
Retrieve Dialog Box ...................................................................................................................... 350
Correlation........................................................................................................................................... 351
Correlate Pipe Runs with Streams ............................................................................................... 353
Remove the Correlation Between Pipe Runs and Streams ......................................................... 353
Correlate Command (SmartPlant Menu) ...................................................................................... 353
Correlate Dialog Box .................................................................................................................... 354

Contents
Uncorrelate Items ......................................................................................................................... 354

Uncorrelate Command (SmartPlant Menu) .................................................................................. 355
Uncorrelate Dialog Box................................................................................................................. 355
Using the To Do List ........................................................................................................................... 355
Open the To Do List ..................................................................................................................... 356
Modify To Do List Task Properties ............................................................................................... 357
Run Tasks from the To Do List ..................................................................................................... 357
Example of Completed with Warning Status ................................................................................ 358
Define Filtering by Task Assignment for the To Do List ............................................................... 359
Filter To Do List Tasks.................................................................................................................. 360
Sort To Do List Tasks ................................................................................................................... 361
Defer Tasks from the To Do List .................................................................................................. 361
Remove Tasks from the To Do List .............................................................................................. 361
Display Deleted To Do List Tasks ................................................................................................ 361
Ignore To Do List Tasks ............................................................................................................... 361
Perform Manual Correlation ......................................................................................................... 362
Uncorrelate Items from the To Do List ......................................................................................... 362
Ignore Task Properties ................................................................................................................. 363
Display Ignored To Do List Tasks ................................................................................................ 363
Update the To Do List Display ...................................................................................................... 363
To Do List Task Commands and Controls ................................................................................... 364
Comparing SmartPlant P&ID with PDS ................................................................................................. 371

Comparing Code Lists and Select Lists .............................................................................................. 372
Setting Construction Status ................................................................................................................ 372
Comparing Consistency Check to Propagation .................................................................................. 372
Comparing System Editing to Propagation ......................................................................................... 373
Comparing Graphics and Text in PDS 2D and SmartPlant P&ID ....................................................... 374
Troubleshooting ...................................................................................................................................... 375
Glossary ................................................................................................................................................... 377
Index ......................................................................................................................................................... 391

Contents

SECTION 1

SmartPlant P&ID creates intelligent P&IDs by populating the database with relevant plant
data. This method provides valuable information throughout the plant life cycle. As a
data-centric, rule-based solution for the P&ID life cycle, SmartPlant P&ID helps users improve
design quality, data consistency, and standards compliance. With quick access to supporting
engineering data, SmartPlant P&ID significantly cuts design and modification time and increases
accuracy with its exclusive data-centric approach and use of design rules and automatic checks.
SmartPlant P&ID is vastly different from graphic-driven P&ID solutions of today. All data from
the P&ID is stored in the plant database and adheres to plant standards. The graphical
representation of the P&ID is a view or a report of the data. The strong data import and export
facilities of SmartPlant P&ID allow users to populate the system with relevant plant data, such
as process data from process simulation databases based on Aspen Basic Engineering from
Aspen Technologies, Inc. or equipment and line lists. The user can use the import to either
update data on existing items in the plant database or to create new items in the SmartPlant
P&ID Stockpile to use for designing the P&ID.
The rule-based and automation capabilities of SmartPlant P&ID also differentiate it from other
P&ID systems. SmartPlant P&ID features a comprehensive, user-definable rule-based system
that assists the engineer during the design phase of the plant and subsequent life cycle
phases. Data is entered directly into the database; rules are executed; and feedback is
immediate. The design rule-base confirms data consistency and compliance with plant and
engineering standards, allowing faster, more efficient design with less iteration.
SmartPlant P&ID incorporates the latest Microsoft technologies, such as OLE automation, to
provide integration with existing data and other systems. Running on various Microsoft
Windows operating system platforms, SmartPlant P&ID does not require a traditional, expensive
CAD engine for P&ID creation. The open architecture of SmartPlant P&ID permits integration
with other systems, such as Intergraph PDS, SmartPlant Instrumentation, and Aspen Basic
Engineering, all of which allow users to share data with third-party software.
In SmartPlant P&ID Engineering, users may not alter drawing graphics. The only changes users
are allowed to make are related to properties of items in the drawing or stockpiles. In addition,
the following restrictions apply:
 It is not possible to add or delete items (such as plant items, labels, OPCs, annotations,
notes, and so forth) on the drawing sheet.
 It is not possible place items from the plant or drawing stockpiles into the drawing.
 It is not possible to move items on the drawing sheet even if doing so does not impact the
connectivity of items (including labels and annotations).
The following menu commands are disabled:
 New Template Command (File Menu)
 Page Setup Command (File Menu)
 Import SmartSketch Command (File > Import Menu)
 Cut Command (Edit Menu)

 Paste Command (Edit Menu)

 Paste Special Command (Edit Menu)
 Delete from Model Command (Edit Menu)
 Delete to Stockpile > Plant Command (Edit Menu)
 Delete to Stockpile > Drawing Command (Edit Menu)
 Move Command (Edit Menu)
 Move to Drawing Command (Edit Menu)
 Rotate Command (Edit Menu)
 Mirror Command (Edit Menu)
 Replace Command (Edit Menu)
 Move to Typical Command (Edit Menu)
 Move to Primary Command (Edit Menu)
 Create Typical Command (Edit Menu)
 Links Command (Edit Menu)
 Insert > Image Command (Edit Menu)
 Insert > Object Command (Edit Menu)
 Insert > Auxiliary Graphics Command (Edit Menu)
 Replace Mode Command (Tools Menu)
 AutoGap Command (Tools Menu)
 Gap Now Command (Tools Menu)
 Update Symbology Command (Tools Menu)
 SmartSketch Settings Command (Tools Menu)
 Compare and Refresh Command (Tools Menu) — this command is enabled, allowing you to
compare differences between drawings; however, it is not possible to refresh the display.
SmartPlant P&ID Program Group

SmartPlant P&ID provides multiple views of a central, unified data structure that represents the
plant model. A view is a visual presentation of the data in the plant model and can be a
schematic drawing or a table. The plant model is the computer representation of the conceptual
design, including all plant components and their relationships. By manipulating model views,
you can organize the information within the plant model to better understand and maintain the
data.
SmartPlant P&ID has several programs and utilities for running and managing your plant data.

SmartPlant P&ID Engineering allows you to view

SmartPlant P&ID drawings and to edit data in those
drawings.
SmartPlant P&ID Drawing Manager allows you to create

and delete drawings, manage drawing versions, and print
multiple drawings. Drawing Manager also allows you to
perform Workshare and project-specific commands.
SmartPlant P&ID Insulation Specification Manager

allows you to create and modify lookup tables for
insulation specifications and thicknesses.
SmartPlant P&ID Options Manager defines plant-wide

graphic standards for symbology, gapping, heat tracing,
and formats. Options Manager also defines paths to
SmartPlant P&ID files and directories.
SmartPlant P&ID Rule Manager defines rules for

placement and property copying on placement.
SmartPlant Engineering Manager performs higher-level data management tasks, such as

specifying user permissions, designing plant hierarchies, and so forth. For more information
about SmartPlant Engineering Manager, see the SmartPlant Engineering Manager User's Guide
and the appropriate sections of this guide.
Additional Documentation
SmartPlant P&ID Engineering Help Command (Help Menu)
Opens the Help viewer where you can read topics about commands, procedures, dialog boxes,
and so forth.
Printable Guides Command (Help Menu)

Opens a page in your default browser that includes links to the user guides in portable
document format. Click a link, and the guide opens in the appropriate application. You can print
it if necessary. The user guides contain the same information as the online Help.

SmartPlant P&ID Technical User Forum Command (Help

Menu)
Activates your web browser and opens the SmartPlant P&ID Technical User Forum page. On
this page, you can participate in online discussions and share information.
About SmartPlant P&ID Engineering Command (Help Menu)

Displays information about your copy of the software, including the version number and the
copyright, legal, and licensing notices.
Display Help for Programming with SmartPlant P&ID

Engineering
On your desktop, click Start > Programs > Intergraph SmartPlant P&ID > Programming
Help.
Programming with SmartPlant P&ID allows you to use the Automation layer to customize
the software to meet your own particular requirements. This documentation consists of a
programmer's guide and a reference guide for the logical model.

SECTION 2
Navigating in the Software

The drawing interface is divided into four distinct parts: the Design window, the Catalog
Explorer, the Engineering Data Editor, and the Properties window. Each part provides
specific features that you need to create drawings in the software.
Design Window
The Design window displays Drawing views and the Engineering Data Editor. Each of these
views provides a way for you to enter information for the plant model into the database. The two
views also provide a way for you to view information in the database in different ways. In the
Drawing view, you can see the traditional diagram of a plant containing equipment,
instrumentation, and piping in a graphical representation. The Engineering Data Editor allows
you to see the same information in a tabular format, and it can also display items in the plant
and drawing stockpiles. For more information, see Working with the Design Window.
Engineering Data Editor

The Engineering Data Editor is a modification of the stockpile display. This view is exactly the
same tabular view that you can display in the Design window, with the same capabilities for
modifying the display, editing properties, and organizing data. For more information, see
Navigating in the Engineering Data Editor (on page 35).
Catalog Explorer
The Catalog Explorer displays all available catalog items. The Catalog Explorer contains a
hierarchical representation of the selected catalog. You can navigate through the nodes in a
catalog by clicking the + or – icons by the selected node. In addition, you can double-click nodes
in the tree view to open them. For more information, see Using Catalog Explorer (on page 59).
Properties Window
When you select an item in a plant model, you can enter, view and modify the properties
associated with that item in the Properties window. Your system administrator defines
customized properties and their defaults for each item in Data Dictionary Manager. For more
information, see Working with the Properties Window (on page 69).
See Also
Add an Item to the Stockpile from Catalog Explorer (on page 61)
Navigate the Catalog Explorer Tree View (on page 60)

Using Shortcut Keys

Shortcuts with Catalog Explorer
Navigation menu in Catalog Explorer
To Press
Start the Add Button command A
Start the Remove Button command R
Turn the Show Buttons command on or S

off
Find dialog box in Catalog Explorer

To Press
Select in the Named list ALT + N
Select the Close button ALT + C
Select the Look In box ALT + L
Select the Find Now button ALT + I
Select the Stop button ALT + P
Select the New Search button ALT + W
Select the Browse button ALT + B
Browse for Folder dialog box in Catalog Explorer

To Press
Select the Look In box ALT + L
Select the OK button ALT + O
Select the Cancel button ALT + C
File menu (list view) in Catalog Explorer

To Press
Start the Delete command D

File menu (tree view) in Catalog Explorer

To Press
Start the Find command F
Start the Delete command N
Start the Rename command M
Start the Close command C
View menu in Catalog Explorer

To Press
Turn Large Icons command on or off G
Turn Small Icons command on or off M
Turn List command on or off L
Turn Details command on or off D
Shortcuts with the View menu

To Press
Open the Toolbars dialog box to let you display or ALT + V + T

hide selected toolbars
Open the Properties command ALT + V + P
Start Show grid command to turn on or off the ALT + V + D

display of drawing grid
Start the Grip snap command to turn on or off the ALT + V + S

snap-to-grid behavior for component placement
Turn on or off the display of the Catalog Explorer ALT + V + C

window
Turn on or off the display of the Properties window ALT + V + G
Turn on or off the Show Inconsistencies command ALT + V + W

and the display of inconsistency indicators in the
active view
Turn on or off the display of the Stockpile window ALT + V + S

Miscellaneous shortcuts
To Press
Cancel a command ESC
Cancel items in a fence CTRL or SHIFT
Clear a select set ESC
Close a dialog box ESC
Open context-sensitive Help for the active F1

command
Select items with Select Tool in a fence CTRL or SHIFT
Stop repainting an item while using a View ESC

command
Turn off relationships ALT
Update the window F5
Working with the Design Window

The Design window, or Modeler, consists of several parts and displays the model information
for a design in a Drawing or Engineering Data Editor view. You can open as many windows
as needed to support a design. Each window has its own independent set of properties
defining view range, display properties, and so forth.
You can define one or more Engineering Data Editors for a drawing. The Engineering Data
Editor displays drawing information in a table, much like a Properties window. In the
Engineering Data Editor, you can specify filters and layouts to define the table information and
edit some item properties.

By using commands on the Window menu, you can cascade or tile views to more easily
navigate among them.
 (A) Drawing view — A graphical representation of the plant model. This view displays the
common idea of a model: a diagram containing items such as equipment, piping, and
instrumentation.
 (B) Engineering Data Editor — A tabular view that presents the plant data in a tabular
format. For more information, see Navigating in the Engineering Data Editor (on page 35).
 (C) Properties window — A list of properties shown for a selected item or a select set of
multiple items.
SmartPlant P&ID provides multiple views of a central, unified data structure that represents the
plant model. A view is a visual presentation of the data that composes the plant model and can
be a schematic drawing or a table. The plant model is the computer representation of the
conceptual design in its entirety, including all plant components and their relationships. By
manipulating model views, you can organize the information within the plant model to better
understand and maintain the data.
The software continually updates the database as you edit a drawing; however, the
software does not update the drawing file until you actually save the file (when you click File >
Save or when you quit the program and save). Occasionally, the software can end in an
abnormal way (for example, due to power outage). As a result, the database is updated with
changes that you posted to the drawing, but the drawing file reflects the status when you last
saved the drawing. When you re-open the drawing, the software recognizes that the drawing
file is different from the database and displays a message: One or more items in this drawing
are inconsistent with the database. Click OK to re-create the drawing from the database.
For more information about the data model, refer to the Properties Glossary.

See Also
Define a New Engineering Data Editor View (on page 55)
Define a New Filter for an Engineering Data Editor View (on page 55)
Define a New Layout for the Engineering Data Editor (on page 56)
Open a New Drawing View (on page 34)
Open an Existing Drawing (on page 89)
Show Command
Available on the Drawing View shortcut menu, the Show command allows you to choose to
display drawing elements such as notes, labels and grids.
Options Command (Tools Menu)

Changes settings that control recently used files, screen appearance, placement information,
export formats, and so forth. Opens the Options dialog box.
Options Dialog Box

Sets options for the current drawing. For example, you can set the number of recently used files
that appear on the File menu. Open this dialog box by clicking Tools > Options on the main
menu bar. The Options dialog box has four tabs:
General Tab (on page 22)
Colors Tab (on page 23)
Placement Tab (on page 23)
Files Tab (on page 24)
General Tab
Used to set options for updating links in the drawing and displaying the drawing, the status bar,
and recently used files.
Update links automatically at open — Updates links automatically when a drawing is opened.
For more information about linking, see Related Topics.
Recently used files list — Sets the number of entries for the recently used files list on the File
menu.
Display as printed — Displays the drawing as it appears when you print it.
Show status bar — Displays the status bar at the bottom of the main window. When you point
at the command button on the toolbar, the description appears in the status bar at the bottom of
the window. Also, the status bar displays prompts that explain what to do at each step of the
command, as well as messages about the operations the software is performing.

Colors Tab
Allows you to select options for the background, highlight, selection, and handle colors in the
drawing.
Background — Sets the default background color for all Drawing views in the active drawing.
Highlight — Sets the highlight color.
Selected items — Sets the color of selected items. The connect points in the drawing appear in
this color, too.
Handles — Sets the color of handles when an item is selected.
Use Defaults — Sets all the colors listed above to the default display value.
Placement Tab
Used to set the default construction status for the active drawing, and tolerances for locating
items in the drawing.
Default construction status — Assigns the selected construction status to all placed items.
This list contains the following options: New, Existing, and Future. The plant administrator sets
the plant-wide default at setup, but this option allows you to change the default on a
drawing-by-drawing basis. The construction status for an item appears in the Properties
window when the item is selected. Also, the construction status can be set for individual drawing
items by changing its value in the Properties window.
For SmartPlant P&ID Engineering, the settings for this option only apply to new items
sent to the stockpile.
Locate — Specifies the range, called the locate zone, at which a candidate item is highlighted
when another item approaches. If you are selecting drawing items, the locate tolerance defines
how close the pointer must approach in order to select the item.
Break-away — Sets the number of pixels at which an item disconnects from its parent item.
For SmartPlant P&ID Engineering, placement is not allowed; therefore the settings for
this option do not affect the software behavior.
Place Partner OPC in Stockpile — Indicates that when a new off-page connector (OPC) is
placed, the partner OPC is automatically stored in the Stockpile. If you clear this option, the Set
Stockpile Location of Partner OPC dialog box appears after you place a new OPC.

Files Tab
Used to set the location for storing report templates.
Scale reference files — Sets a scale option for importing a drawing.
Coincident (1:1) — Imports a reference file, also known as an inserted object, at full scale (1:1).
Select Scale — Sets the drawing scale to a standard ratio.
Custom Scale — Sets the scale for a drawing that you insert.
My Reports — Specifies the folder where your user-defined, or personal, report templates are
stored.
Browse — Opens the Browse dialog box, which allows you to select a local or network folder to
store your user-defined report templates (My Reports).
Browse Dialog Box

Allows you to select a folder that contains your reports. Open this dialog box by clicking Tools >
Options > Files Tab > Browse.
Look in — Displays the currently selected folder and the available folders in the active drive.
Drives — Lists the drives that are currently active on your computer. Select a different drive in
order to see directories that reside on that drive in the Look in box.
Customize the Software with the Options Command

1. Click Tools > Options.
2. On the Options dialog box, click the tab containing the information that you want to
customize:
 General Tab (on page 22)
 Colors Tab (on page 23)
 Placement Tab (on page 23)
 Files Tab (on page 24)
3. Select options on each dialog box to make the appropriate changes.

View Menu
Topics
Previous Command (View Menu) .................................................. 25
Zoom Area Command ................................................................... 25
Zoom In Command ........................................................................ 26
Zoom Out Command ..................................................................... 26
Fit Command (View Menu) ............................................................ 27
Pan Command (View Menu).......................................................... 27
Display Command (View Menu) .................................................... 28
Toolbars Command (View Menu) .................................................. 28
Properties Command (View Menu)................................................ 29
Previous Command (View Menu)

Restores the previous view. For example, if you zoom in and then click View > Previous, the
view changes to the view displayed before you zoomed. This command is available only when a
Drawing view is active, and the software does not remember more than one view.
Restore a Drawing View

 Click View > Previous.
 To stop repainting items in the window, press ESC. This action is convenient for large
drawings.
 To refresh the window, press F5.
Zoom Area Command
Enlarges the display of an area in the active window by allowing you to draw a fence around that
arbitrary area of the drawing. This command is available only when a Drawing view is active.
Zoom In on an Area
1. On the main toolbar, click Zoom Area .
2. On the Drawing view, use the pointer to fence the area on which you want to zoom. The
selection fills the view.
 To go back to the previous view, click View > Previous.

drawings.

 To cancel the command, right-click or press ESC.
Zoom In Command
Enlarges the display of items around a specified point in the active window. This command is
available only when a Drawing view is active.
Zoom In
1. On the Main toolbar, click Zoom In .

2. Click the view.
 You can drag the mouse to dynamically zoom in to the view.

 When you roll the Microsoft IntelliMouse wheel forward, the view zooms in at the current
pointer location.
 To go back to the previous view, click View > Previous or ALT + F5.
 To exit the command, right-click or press ESC.
See Also
Zoom Area Command (on page 25)
Zoom Out Command (on page 26)
Zoom In Command (on page 26)
Zoom Out Command
Reduces the display of items around a specified point in the active window. This command is
available only when a Drawing view is active.
Zoom Out
1. On the main toolbar, click Zoom Out .
2. Click the Drawing view at the center of the area from which you want to zoom.
 To go back to the previous view, click View > Previous or ALT + F5.
drawings.
 To quit the command, right-click or press ESC.

See Also
Zoom Area Command (on page 25)
Zoom Out Command (on page 26)
Zoom In Command (on page 26)
Fit Command (View Menu)
Fits all items in the active view if no items are currently selected. However, if any items are
selected in the drawing or if you select a row in the Engineering Data Editor representing an
item, the command fits only the selected items in the active view. If only one item is selected in
the drawing, the command zooms to the selected item. This command is available only when a
Drawing view is active.
If no selection is defined, you can right-click to access Fit from the shortcut menu.
Fit All Items in the Active Drawing View
 On the Main toolbar, click Fit .
Pan Command (View Menu)
Allows you to move the display in any direction from a specific point in a drawing to see other
areas of the drawing by dragging the pointer across the view. This command is available only
when a Drawing view is active.
Pan a Drawing View

1. On the Main toolbar, click Pan .
2. Click in the view you want to pan.
3. Click in the view again to define how far you want to pan.
 You can also click and drag the hand pointer to pan the view.
 To go back to the previous view, click View > Previous.
drawings.
 To cancel the command, press ESC or right-click in the Drawing view.

Display Command (View Menu)

Allows you to specify the windows you want to see in your design session:
 Catalog Explorer. For details, see Using Catalog Explorer (on page 59).
 Properties Window. For details, see Working with the Properties Window (on page 69).
 Engineering Data Editor. For details, see Navigating in the Engineering Data Editor (on
page 35).
Toolbars Command (View Menu)

Opens the Toolbars dialog box, which allows you to create new toolbars and display or hide
selected toolbars. You can change toolbar color schemes and button sizes, too.
Toolbars Dialog Box

Sets options for displaying, hiding, or changing toolbars. Open this dialog box by clicking View >
Toolbars on the main menu bar.
Toolbars — Lists the available toolbars. You can select the box next to the toolbar that you
want to display, hide, or change.
Toolbar Name — Displays the name of the toolbar that you have selected.
New — Accesses the New Toolbar dialog box.
Customize — Adds buttons to or removes buttons from built- in toolbars with the Customize
dialog box.
Reset — Returns the toolbar to the state that it was in at the beginning of your current design
session.
Color Buttons — Adds color to the toolbar buttons. Clearing this option causes toolbar buttons
to appear in black and white.
Large Buttons — Enlarges toolbar buttons so that they are easier to see.
Show ToolTips — Displays on-screen descriptions of a toolbar button when the pointer pauses
over one of them.
New Toolbar Dialog Box

Creates a new toolbar. Open this dialog box from the main menu bar by clicking View >
Toolbars > New.
Toolbar Name — Type the name of the new toolbar in the box. You cannot choose a name for
your new toolbar that is already used for another toolbar.

Create a New Toolbar

1. Click View > Toolbars.
2. On the Toolbars dialog box, click New.
3. On the New Toolbar dialog box, type the name of the new toolbar.
4. Click OK.
5. Click Tools > Customize.
6. On the Toolbars tab of the Customize dialog box, click the category that contains the
command that you want to add.
7. Drag the command button from the Buttons display area to the new toolbar.
Add a Button to a Toolbar

1. Click Tools > Customize on the main menu bar.
2. On the Toolbars tab, click the category that contains the command that you want to add.
3. Drag the command button from the Buttons area to the toolbar.
Remove a Button from a Toolbar

1. On the main menu bar, click Tools > Customize.
2. On the Toolbars tab, drag the button that you want to remove from the toolbar into the
Buttons area.
Restore a Customized Toolbar to Its Default Settings

1. Click View > Toolbars.
2. On the Toolbars dialog box, select the toolbar that you want to restore.
3. Click the Reset button.
If you create a new toolbar, you cannot reset it.
Properties Command (View Menu)

Displays the View Properties dialog box which lets you define and control settings for the active
view.

View Properties Dialog Box

Controls the display of information in the Drawing view. Open this dialog box by clicking View >
Properties.
Display Tab (on page 30)
Grid Tab (on page 31)
Inconsistency Indicators Tab (on page 32)
Claims Tab (on page 32)
You can access the View Properties dialog box by right-clicking in space in your drawing
and selecting Properties from the shortcut menu.
General Tab
Displays miscellaneous information about a Drawing view, including the name, description, and
view type.
View name — Allows you to name the Drawing view.
Description — Allows you to enter a description of the Drawing view.
View type — Displays the type of view. This information is read-only.
Display Tab
Controls the display of items in a Drawing view. Items that you can display include labels,
drawing borders, grids, notes, and inconsistency indicators. When you select the check box, the
display toggles on for that item.
Do not show labels for filtered items — Select this option to prevent the display of labels
when a display set definition hides model items for which the labels apply. Clearing this check
box results in the label displaying also when the model item is hidden.
 This option is available only when the Labels check box is selected.
 This option only behaves as described above when, for the filter definition on the Filter
Properties dialog box, the Filter for value is equal to Label: Model Item. If the Filter for
value is equal to Label: Catalog Item, the behavior of each label follows the filter setting for
the model item, including displaying and hiding, regardless of the setting for this option.
Show
Lists options for objects you want to appear in your Drawing view.
Labels — Toggles the display of all labels on or off, in any view. If the display of labels is turned
off here, then the Do not show labels for filtered items option is not available since all labels
are no longer displayed regardless of the view tab that you are using.
Drawing borders — Toggles the display of the drawing border on or off.
Grids — Turns the grid display on or off.

Notes — Turns the display of notes on or off. Notes can contain links to a file, for example, a
Microsoft Word file. Also, Auxiliary Graphics are turned on and off with notes.
Inconsistency indicators — Turns the display of inconsistency indicators on or off.
Claims — Turns on the display of the options selected on the Claims tab.
Select — Includes other options for the selection of items in your drawing.
Prevent selection of inserted objects — Makes inserted foreign data non-locatable in a
drawing. Inserted data appears gray in the drawing.
For SmartPlant P&ID Engineering, this option is selected by default and cannot be
changed.
Retain Auxiliary Graphics colors — This option is available only if Prevent selection of
inserted objects is selected. If the drawing includes Auxiliary Graphics, selecting this option
displays the Auxiliary Graphics in their original colors and when printing the drawing, prints them
in those colors. Choosing this option has no effect on other inserted objects. When this check
box is cleared, Auxiliary Graphics appear as gray in the drawing and when printed.
Grid Tab
Controls the behavior of the grid in the view.
View — Turns the grid display and grid snapping on or off. You do not have to display the grid in
order to snap items to it.
Show grid — Turns the grid display on or off.
Snap grid — Turns the snap-to-grid feature on or off. When you select this option, items always
align with the grid lines or nearest intersection of the grid lines. Grid lines are not printed.
Style — Specifies either Static or Dynamic grid style. A static grid displays solid grid lines that
do not move as you zoom in or out. When you zoom in or out, the grid lines for a dynamic grid
change with the level of magnification. A dynamic grid displays index lines that intersect with the
darker, solid grid lines. The choice of grid style affects the option that is available in the Spacing
or Density box and the availability of the Index options, too.
Spacing — Allows you to specify the space between the grid lines when you choose the Static
grid style from the Style list.
Density — Allows you to specify fine, medium, or coarse levels when you choose the Dynamic
grid style from the Style list. For a dynamic grid display the number of index lines varies
depending on the zoom level, and so you cannot change the Index list when using the Dynamic
grid style.
Index — Specifies the grid index, which is the number of minor grid lines. This option is
available only with the Static grid style.

Inconsistency Indicators Tab

Controls the display of inconsistency indicators, which signify the suitability of design work that
you perform while creating the drawing. The software verifies in real-time if the composition of a
drawing and the underlying data model satisfy rules defined in Rule Manager. Choose the
indicators and severities that you want to view in your drawing. Open the View Properties
dialog box by clicking View > Properties.
Show — Lists options for objects you want to appear in your Drawing view.
Errors above severity — Turns the display of errors on or off. You can specify the severity
level. For example, if you specify a severity level of five, all errors with severity of five or above
appear. Errors are marked with a .
Warnings above severity — Turns the display of warnings on or off. Again, you can specify the
severity level and control the warnings that you see. Warnings are marked with a .
Approved warnings — Turns the display of approved warnings on or off. Approved warnings
are marked with .
Claims Tab
Sets options for the display of items in the Drawing view according to their claim states. This tab
is part of the View Properties dialog box, which appears when you click View > Properties.
Status — Displays the possible claim states and combination of claim states for drawing items.
Invalid claims — Specifies the display of invalidly claimed items in the Drawing view. Invalidly
claimed items are items which differ from the Plant items and which you cannot modify and
check into the Plant without first establishing a valid claim. Invalid claiming can happen only for
Plants that support shared claiming of database items. If you specify a special display for
invalidly claimed items in the Drawing view, then these display options override all other options
designated in the Claim area of this dialog box.
Claim — Displays the possible claim states for all items except invalidly claimed items.
Not claimed — Specifies the special display of drawing items that are not claimed at all.
Claimed only by others — Specifies the special display of drawing items that are claimed
solely by other projects or the Plant.
Claimed only by this project — Specifies the special display of drawing items to which this
project has the sole claim.
Shared claims — Specifies the special display of drawing items when the active project shares
a claim on with another project or the Plant. If your Plant is configured so that it honors only
exclusive claiming, then these display options will have no effect in the Drawing view.
Colors — Allows you to select a color for items with the corresponding claim state.
Widths — Allows you to select a line width for items with the corresponding claim state.
See Also
Claim a Drawing Item (on page 194)

Change the Properties of a Drawing View

1. Click View > Properties.
2. On the View Properties dialog box, select the General tab, and enter a view name and
description. The View type box is read-only.
3. On the Display tab, select the items you want to display in the view. You can select any of
the Labels, Filter labels, Drawing borders, Grids, Notes, and Inconsistency indicators
options.
4. Select the Prevent selection of inserted objects option if you want to prohibit the selection
of linked or embedded objects in the drawing.
When you select this option, all linked or embedded objects, including Auxiliary
Graphics, appear gray in the drawing or when printing. For SmartPlant P&ID Engineering,
this option is selected by default and cannot be changed. To display and print Auxiliary
Graphics in their original colors, select the Retain Auxiliary Graphics colors option.
5. On the Grid tab, choose the Show grid or Snap grid option, and the properties of the grid,
if needed, in the Style, Density, and Index options.
6. On the Inconsistency Indicator tab, you can select from any of the Errors, Warnings, and
Approved warnings options. For errors and warnings, you can specify the severity level of
the displayed inconsistencies. For example, when you specify 5, errors with severity level of
5 or greater are displayed.
7. On the Claims tab, choose special display colors for drawing items according to their claim
status.
Claiming items is governed by projects, project status, and options specified in
SmartPlant Engineering Manager and SmartPlant P&ID Drawing Manager.
If the active view is the Engineering Data Editor, then clicking View > Properties
opens the Edit View dialog box.
Window Menu
Topics
New Command (Window Menu) .................................................... 34
Cascade Command ....................................................................... 35
Tile Horizontally Command (Window Menu) ................................. 35
Tile Vertically Command (Window Menu) ..................................... 35
Active Window List ......................................................................... 35

New Command (Window Menu)

Allows you to open a new Drawing or Engineering Data Editor window within the Design
window.
New > Drawing Window Command (Windows Menu)

Creates a new Drawing view within the active drawing. This command copies the contents of
the active Drawing view into a new window and displays the contents as graphical items. The
new view has the same filters as the previous Drawing view. You can change the view features
for the new Drawing window using the commands on the View menu.
 If only the Engineering Data Editor view of a drawing is open, the graphical Drawing view
is opened on top of the Engineering Data Editor when you select Window > New >
Drawing.
 Creating a new Drawing or Engineering Data Editor view of a drawing does not create a
new copy or version of the drawing. The same drawing data simply displays in the different
views.
New > Engineering Data Editor Command (Window Menu)

Opens the Engineering Data Editor in the Design window and allows you to view and edit
model data for a drawing in a tabular format.
Open a New Drawing View

1. Click Window > New > Drawing.
A new Drawing view is not the same as a new drawing. You create new drawings in
SmartPlant P&ID Drawing Manager. For more information, see SmartPlant P&ID Drawing
Manager Help, which you can access from the Help > Printable Guides command.
2. Edit the drawing as needed.
 You can have as many Drawing views open for a drawing as needed.
 Drawing views are named according to the name of the drawing file. For example, the first
drawing view created for the Pipeline.pid file is named Pipeline.pid:1. Each subsequent
drawing view is assigned the next consecutive number.
 If the software gives indications that a drawing is in use when it is not, quit all SmartPlant
applications, and then open the Windows Task Manager. In Task Manager, search for an
extra draft.exe process. Select it and click End Task. For more information on the Windows
Task Manager, see Microsoft Windows Help.

Cascade Command
Overlaps windows diagonally across in the Design window.
Tile Horizontally Command (Window Menu)

Arranges windows to fit horizontally in the Design window. All the windows are placed an even
distance from each other on the screen.
Tile Vertically Command (Window Menu)

Arranges windows to fit vertically in the Design window. All the windows are placed an even
distance from each other on the screen.
Active Window List

Displays an alphabetical list of open document windows below the commands on the Window
menu. You can access another open document by clicking one of the window names on the list.
Navigating in the Engineering Data Editor

The Engineering Data Editor (EDE) uses a grid or tabular format to display the query results
for the database. The Engineering Data Editor is automatically displayed in the lower left of
the main window, and you can also open the Engineering Data Editor to appear in the Design
window.
The Engineering Data Editor Toolbar

At the top of the Engineering Data Editor is the toolbar, which contains the following menu
buttons:
 Actions — Includes commands that allow you to delete stockpile items or move items
between stockpiles.
 Edit — Includes commands that allow you to copy and paste data and to claim items or
release claimed items.
 View — Includes commands that allow you to edit, save, or delete Engineering Data
Editor views, to filter or refresh the display, to generate reports, and to specify display
settings for the views.
Click the down-arrow next to the menu button to expose the available commands.
The list on the toolbar contains filters that query the database and display the corresponding
items in the Engineering Data Editor. If you want to list all items select Plant Item from the list.
You can also filter the display by using the buttons that correspond to different stockpiles and
drawings (by default, initially only the Active Drawing and Active Drawing Stockpile buttons
are selected):

 Active Drawing — Displays properties of the items that belong to the drawing you are
currently viewing. This includes properties of implied items, which do not appear on the
drawing sheet.
 Active Drawing Stockpile — Displays items existing in the data model that have not
been placed in the graphic drawing.
 Stockpile — Displays items for the plant existing in the data model that have not been
placed in the graphic drawing.
 Other Drawings — Displays properties of the items that appear in all drawings in the
plant other than the active drawing, including items in the stockpiles of other drawings.
The Asking Filter button displays the Filter tab of the Asking Filter dialog box, from which
you can quickly filter the Engineering Data Editor display by selecting a base filter and
properties appropriate for the selected item type. You can re-query and thereby refresh the
Engineering Data Editor display by clicking the Refresh button . Finally a summary box
displays a comparison between the number of items in the view and the total number of items,
of the type chosen in the list, that exist in the database.
In the Engineering Data Editor, it is possible to display a maximum of 350,000 cells. If
your database query results in more than this number, the Query Results dialog box opens.
You can then choose to refine your query in order to generate fewer items or to enter report-only
mode and run a report on your query results.
Customizing the Display of the Engineering Data Editor

You can change the content and layout of the Engineering Data Editor rather extensively.
Several methods to customize the look of the Engineering Data Editor exist.
By specifying the display settings, you can define the font that Stockpile items appear in, for
instance. By using the AutoFilter feature, you can quickly limit the number of items that are
displayed in the Engineering Data Editor. You can clarify the cells that are read-only and the
cells that allow you to enter new property information or modify existing information. You can
create your own filters to narrowly define the contents of the view, and you can create unique
layouts with exactly the properties that you want to see, in exactly the order that you want to see
them. You can control the scrolling of the Engineering Data Editor with the Freeze Panes
command, too.
Once you have defined and edited a view, you can save it and also delete it later, if necessary.
Customize the Display of the Engineering Data Editor

1. Click View > Display Settings on the Engineering Data Editor toolbar.
2. On the Display Settings dialog box, choose large or small icons.
3. Choose an item type in the Item list, and the specify font, style, and color that you want
these items to be displayed in.
You can specify this display information for each of the four types of items in the Item
list.
4. Specify a special background color for read-only properties.

5. Specify a special background color for read/write properties, too, if you want.
 You can also customize the Engineering Data Editor by using the AutoFilter feature. For
more information, see Use AutoFilter in the Engineering Data Editor (on page 38)
 You can use the Freeze Panes feature, too. To do so, follow these steps:
a. To freeze the top horizontal pane, select the row below where you want the split to
appear. To freeze the left vertical pane, select the column to the right of where you want
the split to appear. To freeze both the upper and left panes, click the cell below and to
the right of where you want the split to appear.
b. Click View > Freeze Panes on the Engineering Data Editor toolbar.
c. Click View > Edit View on the Engineering Data Editor toolbar to totally redefine the
content and layout of the Engineering Data Editor. For more information, see Modify
the Properties of an Existing Engineering Data Editor View (on page 57).
AutoFilter Command
Engineering Data Editor > View > AutoFilter
Allows you to filter the items displayed in the Engineering Data Editor. When you click
AutoFilter, arrows appear at the top of each column. Click the arrow at the top of the column
that contains the data that you want to filter on and choose the value from the list that appears.
For instance, if the Engineering Data Editor displays Equipment: Vessels, but you want to
see only vertical drums, use the AutoFilter command (click the arrow at the top of the Eq
Subclass column and choose vertical drums).
For columns with units of measure, the values are sorted in ascending numeric order
regardless of the units, for example: 2.000 in, 3.0 cm, 3.5 mm, 4.0 in. Where several identical
numeric values exist with the same units of measure, the values are sorted in ascending order
according to the number of decimal places, for example: 2.0 in, 2.000 in; if the values are
identical but have different units of measure, they are sorted in ascending alphabetical order of
the units (with symbols preceding letters of the alphabet), for example: 3.0", 3.0 cm, 3.0 in, 3.0
mil, 3.0 mm. All other data values are sorted alphabetically.
To create more elaborate filters and displays, you need to use the Edit View command and
enter options on the Edit View dialog box and the Advanced View Properties dialog box.
Select this command again to deactivate it.
Custom AutoFilter Dialog Box

Sets options for the behavior of the AutoFilter as it controls the display of items in the
Engineering Data Editor. This dialog box opens when the AutoFilter is active and you click an
arrow at the top of one of the columns in the EDE and select (Custom).
Comparison operator — Lists the available comparisons: for example, equals, does not equal,
is greater than, begins with, and so forth.
Value — Lists the available values currently stored in the column. For columns with units of
measure, the values are sorted in ascending numeric order regardless of the units, for example:
2.000 in, 3.0 cm, 3.5 mm, 4.0 in. Where several identical numeric values exist with the same
units of measure, the values are sorted in ascending order according to the number of decimal
places, for example: 2.0 in, 2.000 in; if the values are identical but have different units of

measure, they are sorted in ascending alphabetical order of the units (with symbols preceding
letters of the alphabet), for example: 3.0", 3.0 cm, 3.0 in, 3.0 mil, 3.0 mm. All other data values
are sorted alphabetically.
And — Allows you to add another comparison using the Boolean operator sense of And: this
means all criteria must be met.
Or — Allows you to add another comparison in the Boolean sense of Or: this means any one of
the criteria must be met. The Boolean Or is less restrictive than the And.
Use AutoFilter in the Engineering Data Editor

1. Turn AutoFilter on by clicking View > AutoFilter on the Engineering Data Editor toolbar.
Click View > AutoFilter again to turn the AutoFilter feature off.
2. Click the down-arrow at the top of the column you want to filter values for. Do one of the
following:
 To match a single value, choose that value from the list that is displayed.
 You can choose Blanks or NonBlanks from the list in order to display items that either
have no value in the column or do have a value in the column, respectively.
 To display rows that meet two conditions, choose Custom from the list. The Custom
AutoFilter dialog box opens. Enter the comparison operator and value that you want,
and then click the And button. In the second comparison operator and value boxes,
enter the operator and value that you want.
 To display rows that meet either one condition or another condition, enter the
comparison operator and value that you want, and then click the Or button on the
Custom AutoFilter dialog box. In the second comparison operator and value boxes,
enter the operator and value that you want.
When applying an AutoFilter, if the number of data records in the Engineering Data
Editor exceeds the maximum, the Query Results dialog box opens indicating the total number
of rows found before the AutoFilter was applied. If you choose to continue with the query in
order to generate a report, the Engineering Data Editor view does not show any headers or
records; instead, it displays the text 'Report only mode' and indicates the number of items
returned by the AutoFilter out of the total number of items available before the AutoFilter was
applied.
You can then generate a report based on the AutoFilter results. The AutoFilter is honored for the
report until another item type is selected in the list or the AutoFilter is turned off.

Freeze Panes Command

Engineering Data Editor > View > Freeze Panes
Allows you to scroll through the Engineering Data Editor while keeping the display of specified
rows and columns constant. For instance, the first column can contain the item tag, but you want
to always see the item tag as you scroll to the right end of the rows to view the supplier. You can
accomplish this layout by using the Freeze Panes command.
View > Display Settings Command (EDE)

Opens the Display Settings dialog box, which allows you to specify various display options for
the Engineering Data Editor. For example, you can choose the size of icon that is displayed
in the view, and you can specify the font that items in the Stockpile are listed in. You can
choose that read-only cells are filled with a special background color.
Display Settings Dialog Box

Sets options for the display of icons and rows and columns in the Engineering Data Editor.
Open this dialog box by clicking View > Display Settings in the EDE.
Icon size in table — Allows you to specify large or small icons for the display in the far left
column of the view.
Small — Causes small icons to appear in the view.
Large — Causes large icons to appear in the view.
Row — Contains settings that apply to rows in the view; that is, these settings apply to individual
items.
Item — Lists the different locations of items: Active Drawing, Active Drawing Stockpile,
Stockpile, or Other Drawings. When you select one of these options, the remaining options in
the Row area then pertain to that location. You can subsequently select another option from the
Item list and define fonts and colors for those items and so on until you have specified the
appearance for all locations in the Item list.
Font — Sets the font for the items selected from the Item list.
Color — Allows you to specify either the font color or background color, depending on
whether you are specifying this property in the Row area or the Column area, respectively.
Italic — Causes the font to be italicized for items selected from the Item list.
Bold — Causes the font to be bold for items selected from the Item list.
Column — Contains settings that apply to columns in the view; that is, these settings apply to
item properties.
Read-only properties — Allows you to choose a background color for read-only table cells.
Read/write properties — Allows you to choose a background color for the table cells that you
can edit in the Engineering Data Editor.

Editing Item Properties in the Engineering Data Editor

Item properties in the Engineering Data Editor can be edited much the same way as they are
in the Properties window; however, there are some differences:
 The software displays a different background color for read-only and read/write properties in
the Engineering Data Editor. These display options are configured on the Display
Settings dialog box. For details of how to configure the display settings, see Customize the
Display of the Engineering Data Editor (on page 36).
 The Engineering Data Editor can be configured to display properties that are not shown in
the Properties window. For details of how to display additional properties for a view in the
Engineering Data Editor, see Define a New Layout for the Engineering Data Editor (on
page 56).
 Properties of items in non-active drawings and non-active drawing stockpiles can be edited
in the Engineering Data Editor. For more details of how to edit properties on non-active
drawings see Perform Plant Editing (on page 43).
 When editing a select list property in the Properties window, it is possible to select the
property from the list or to type part or all of the value directly in the field. In the
Engineering Data Editor, it is also possible to select the property from the list; however
when selecting a value by typing, it is only possible to type the first letter of the property. If
several property values start with a particular letter, repeatedly typing that letter in an
Engineering Data Editor cell allows you to move through those values.
 It is possible to select multiple properties (cells) for an item (row), copy those properties, and
paste them to another item.
Using the CTRL key, it is possible to select multiple items (entire rows) in the
Engineering Data Editor, but not multiple cells or columns. The user is allowed to select
multiple rows, columns, or cells in the Engineering Data Editor using the Shift key.
 A list arrow (select list) and an ellipsis (calculation button) are displayed for a property in the
Engineering Data Editor much the same as in the Properties window except for the case
when both exist for the property. When both the list arrow and the ellipsis exist for a
property (for example, the Loop Tag property of a pipe run) they are both displayed in the
Properties window but only the list arrow is displayed in the Engineering Data Editor.
 In the Properties window, you can highlight a value that belongs to a select list and simply
delete its contents by pressing the Delete key. In the Engineering Data Editor, you must
first highlight the value inside the list before being able to delete it.
 All Plant Item Group associations are editable in both the Properties window and in the
Engineering Data Editor. One exception is the Hydraulic Circuit Item Tag property,
which is editable in the Properties window but is read-only in the Engineering Data Editor.
 If the selected item (row) in the Engineering Data Editor is in the active drawing, that item
is highlighted in the drawing and its properties are displayed in the Properties window as if it
had been selected in the drawing. If the selected item is in a non-active drawing, its
properties are not displayed in the Properties window.
 The Plant Group Name property is dependent on the Plant Group Type property and
therefore the Plant Group Name property cannot be assigned until the Plant Group Type
property is assigned. Both the Plant Group Type and Plant Group Name properties have
to be assigned for an item, therefore if the Plant Group Type property is assigned and the

Plant Group Name property is not assigned for an item, the software removes the Plant
Group Type value as follows:
 Active drawing:
Whether the change is made in the Properties window or in the Engineering Data
Editor, the Plant Group Type value is not removed while in the same drawing session.
Refreshing the Engineering Data Editor does not remove the Plant Group Type
value. Only closing the drawing removes the Plant Group Type value.
 Non-active drawing:
Refreshing the Engineering Data Editor removes the Plant Group Type value.
When copying and pasting data between cells in the Engineering Data Editor where
one property is dependent upon another, the higher dependent (parent) property must be
located in a column to the left of the dependency (child) property in the layout. For
example, if copying both Fluid System and Fluid Code property values from one row to
one or more other rows in the Engineering Data Editor, Fluid System must be located to
the left of Fluid Code in the layout. Likewise, if copying Plant Group Type and Plant
Group Name properties, Plant Group Type must be located to the left of Plant Group
Name in the layout.
Edit the Engineering Data Editor View

1. On the Engineering Data Editor toolbar, click the arrow beside the View menu icon
and from the menu list, click Edit View.
2. On the Edit View dialog box, define the items that you want to see in the Engineering Data
Editor. You can customize a filter and layout for the display on the Advanced View
Properties dialog box. For more details, see Modify the Properties of an Existing
Engineering Data Editor View (on page 57).
The software identifies read-only properties in the Engineering Data Editor visually by
using the display options that you set using the Display Settings command. For details of how
to configure the display settings, see Customize the Display of the Engineering Data Editor (on
page 36).

Edit Active Drawing Item Properties in the Engineering Data

Editor
1. In the Engineering Data Editor, choose an item type from the Engineering Data Editor
select list, for example, Pipe Run.
2. Ensure that Active Drawing is selected to display properties of the items that appear in
the drawing you are currently viewing.
You can also display or hide stockpile items by toggling the Active Drawing Stockpile
and Stockpile commands.
3. Edit the data in the field in accordance with the type of data by doing one of the following:
 For text, select the field and just type the desired value.
 For a list of values (or equivalent quantitative values with different units of measure),
double-click the field and select the desired value from the drop-down list that becomes
available.
 For a field with a calculation command (ellipsis), double-click the field and then click the
ellipsis to open a dialog box.
 You can copy the contents of cells to other cells if the cell contents are compatible.
 If the cell is populated by a read-only property or a property that is only automatically
generated by validation, you cannot edit that cell. Read-only and editable properties are
indicated by the column background colors as specified on the Display Settings dialog box.
 If an Engineering Data Editor view includes several item types (such as the Equipment,
Instrument, or Plant Item view) where certain properties do not apply to a particular item
type, those properties do not have values and are shown as read-only. In the example
below, the End 1 Flow Direction and End 1 Nominal Diameter properties only apply to the
control valve, while the Sig Point 1 Usage property only applies to the single solenoid and
DCS function instrument types.
 For properties of active drawing items, you can edit in the Engineering Data Editor or in
the Properties window. In the Engineering Data Editor, if you click the icon in the
left-most column of the table, the entire row is selected and the item's properties are
displayed in the Properties window.

 If you change a property value of an active drawing item in the Engineering Data Editor
and this causes other properties in the active drawing to be updated because System
Editing or validation is activated, the software automatically updates the Engineering Data
Editor display.
 If a property value in the Engineering Data Editor is changed by the user or as a result of
an automatic update and this property is used for sorting, the software does not update the
sort order of the data automatically if the values are no longer in the correct order. To
update the sort order, the user must refresh the Engineering Data Editor display manually.
 When editing the Plant Group Name property in the Engineering Data Editor or the
Properties window, if identical plant group names exist, holding the mouse pointer over a
selected value from the list displays a tool tip showing the plant group hierarchy path for that
value. Therefore if two units named U1 are available in the list, displaying the tool tip will
show the different paths for the names; for example \A1\U1 and \A2\U1.
Plant Editing
Plant Editing is the ability to use the Engineering Data Editor to manage data for all objects in
the plant. If System Editing is enabled, data that is edited will propagate according to the
System Editing rules defined for the plant.
Plant Editing of Objects in Non-Active Drawings

If a user edits an object in a non-active drawing, propagation of data takes place across
Off-Page Connectors (OPCs) to other non-active drawings when all the drawings involved are
not opened by a user.
Plant Editing of Objects in an Active Drawing

If a user edits an object in the active drawing, data will not propagate across OPCs beyond the
active drawing boundary. Since the active drawing opened by the user is in a locked state, any
data changes made in a non-active drawing will not propagate back across OPCs to the active
drawing.
Perform Plant Editing

1. In Options Manager, click Settings and set the value for the Enable Plant Editing setting to
Yes.
2. In the Engineering Data Editor, choose an item type from the Engineering Data Editor
select list, for example, Pipe Run.
3. If desired, ensure that Active Drawing is selected to display properties of the items that
appear in the drawing you are currently viewing.
4. Click Other Drawings to display properties of the items that appear in all the non-active
drawings in the plant.
Selecting this option also displays items in the drawing stockpiles of the other
drawings.
5. Edit the data in the field in accordance with the type of data by doing one of the following:
 For text, select the field and just type the desired value.

 For a list of values (or equivalent quantitative values with different units of measure),
double-click the field and select the desired value from the drop-down list that becomes
available.
 For a field with a calculation command (ellipsis), double-click the field and then click the
ellipsis to open a dialog box.
 The ability to perform Plant Editing for non-active drawings only applies to the default
Engineering Data Editor window. Editing item properties of non-active drawings is not
supported in a new Engineering Data Editor window that is opened using the Window >
New > Engineering Data Editor command.
 You can copy the contents of cells to other cells if the cell contents are compatible.
 If the cell is populated by a read-only property or a property that is only automatically
generated by validation, you cannot edit that cell. Read-only and editable properties are
indicated by the column background colors as specified on the Display Settings dialog box.
 If an Engineering Data Editor view includes several item types (such as the Equipment,
Instrument, or Plant Item view) where certain properties do not apply to a particular item
type, those properties do not have values and are shown as read-only. In the example
below, the End 1 Flow Direction and End 1 Nominal Diameter properties only apply to the
control valve, while the Sig Point 1 Usage property only applies to the single solenoid and
DCS function instrument types.
 While you are editing an item that belongs to another drawing, other users will only be able
to open that drawing in read-only mode. In this case, the other user will receive a message
that the drawing is open (in Drawing Manager, the Accessed By field for that drawing
shows the person who has the drawing open). To make the other drawing editable for other
users, you must move the cursor out of any Engineering Data Editor row representing an
item in the drawing. If the drawing is open as read-only, it will have to be re-opened in
order to be editable.
 When editing the Plant Group Name property in the Engineering Data Editor or the
Properties window, if identical plant group names exist, holding the mouse pointer over a
selected value from the list displays a tool tip showing the plant group hierarchy path for that
value. Therefore if two units named U1 are available in the list, displaying the tool tip will
show the different paths for the names; for example \A1\U1 and \A2\U1.
 In a project, you cannot perform Claim / Release Claim operations in the Engineering Data
Editor for items that belong to other drawings.
 Editing items from other drawings clears the Undo buffer for the active drawing.

 Editing items from other drawings creates out-of-date model items, which can be updated
using the Out-of-Date Drawings > Update command (for details of this command, see
Drawing Manager Online Help).
 If you use Plant Editing to change a property value in a non-active drawing, propagation
occurs according to the System Editing rules defined for the plant and the Engineering Data
Editor display is automatically updated. This includes propagation of data between
non-active drawings across Off-Page Connectors (OPCs) when both drawings involved are
not opened by a user. Propagation does not occur across OPCs between the active
drawing and a non-active drawing.
 In the OPC view in the Engineering Data Editor, it is not possible to edit OPC properties in
non-active drawings; however, OPC properties in the active drawing or in the plant or active
drawing stockpiles can be edited.
Certain restrictions exist for editing items in the Engineering Data Editor where those items
belong to other drawings. These restrictions are summarized in the following table.
Condition Appearance of Item in Notes

Drawing was already opened by Read-only according to the

another user or drawing file (.pid) user's Display Settings
does not exist
Another user opens a drawing or Normal read/write appearance If you attempt to edit an item, the software
drawing file (.pid) was deleted during displays a message that the item's information
the current session has changed. After you click OK on the
message box, the software refreshes the
Engineering Data Editor and items belonging
to that drawing will be displayed as read-only.
Drawing was deleted from the Normal read/write appearance If you attempt to edit an item, that row is
database or fetched version of a deleted from the Engineering Data Editor
drawing does not include an item display. If you refresh the display, all affected
displayed in the Engineering Data rows are deleted.
Editor
The items belong to a drawing in a Read-only according to the System Editing will not apply to those items
project and have not been claimed user's Display Settings
or have been only partially claimed
to the project scope
In a connected Workshare Read-only according to the

environment, the drawing’s status is user's Display Settings
Subscribe Access
User has opened multiple drawings Read-only according to the

and the item belongs to a non-active user's Display Settings
drawing for that user

Condition Appearance of Item in Notes

None of the above conditions apply, Read-only according to the As an example, in the Plant Item view for a
but a particular item property is user's Display Settings non-customized plant, the Item Tag property is
read-only not editable for pipe runs but it is editable for
piping components. Likewise, Insulation
properties are not editable for a jacketed pipe
run (until that pipe run is defined as jacketed
according to the setting for the plant).
See Also
Edit Active Drawing Item Properties in the Engineering Data Editor (on page 42)
Batch Copy Item Properties Using Plant Editing

This option applies where the cell contents are compatible.
1. On the Engineering Data Editor toolbar, choose an item type from the select list, for
example, Pipe Run.
2. Select the scope for the display of the data (Active Drawing, Other Drawings, stockpiles).
3. If desired, apply a filter to display only the data rows where you want to copy data.
4. Right-click in the field from which you want to copy data and on the shortcut menu, click
Copy.
5. Select the field to which you want to copy data, or hold down Shift while selecting several
consecutive fields in a column.
6. Right-click, and on the shortcut menu, click Paste.
Editor display is automatically updated. This includes propagation of data between
non-active drawings across Off-Page Connectors (OPCs) when both drawings involved are
not opened by a user. Propagation does not occur across OPCs between the active
drawing and a non-active drawing.

Batch Replace Units of Measure Using Plant Editing

This option applies where the cell contents have identical values and units of measure.
1. On the Engineering Data Editor toolbar, choose an item type from the select list, for
example, Pipe Run.
2. Select the scope for the display of the data (Active Drawing, Other Drawings, stockpiles).
3. If desired, apply a filter to display only the data rows with identical values and units of
measure.
4. Select a field with the desired value, and from the list, select an alternative format.
The value changes to the equivalent value in the new units of measure; for example, 50 psi
becomes 2.4 bar g.
You can also change to a different format for the same units of measure; for example,
where 50 psi becomes 50.254 psi.
5. Right-click in the field from which you want to copy data and on the shortcut menu, click
Copy.
6. Select the field to which you want to copy data, or hold down Shift while selecting several
consecutive fields in a column.
7. Right-click, and on the shortcut menu, click Paste.
 The software copies the equivalent value in the new units of measure to all the selected
fields.
 If you use Plant Editing to change a unit of measure value in a non-active drawing,
propagation occurs according to the System Editing rules defined for the plant and the
Engineering Data Editor display is automatically updated. This includes propagation of
data between non-active drawings across Off-Page Connectors (OPCs) when both drawings
involved are not opened by a user. Propagation does not occur across OPCs between the
active drawing and a non-active drawing.
Display > Engineering Data Editor Command (View Menu)
Turns on or off the display of the Engineering Data Editor.

Query Results Dialog Box

Displays options for continuing your work in the Engineering Data Editor when you have
requested more information than can appear in the interface (when the number of rows exceeds
350,000 / number of columns or 65,537, whichever value is smaller). You can either refine your
query or run a report with your query results.
Add — Places a new entry at the end of the existing definition list and enables the options in the
Edit group so that you can edit the new entry.
Additional Filter Criteria — Displays all new criteria to add to the current filter. To add to or
modify the definition list, you must select a line in the list and then define or edit the property in
the Edit group.
Continue with this query so that I can generate a plant or personal report — Causes the
Engineering Data Editor to enable only these commands: Edit view, Save view, Delete view,
My Reports, and Plant Reports. This option is useful when creating a report for large data sets
such as an entire plant database.
Delete — Removes the selected criterion from the definition list. This button is available only
when you select a criterion in the definition list.
Edit — Allows you to define or edit a single line of filter definition criteria.
Match all — Specifies that items matching ALL of the filtering criteria pass through the filter.
Match any — Specifies that items matching any one or more of the filtering criteria pass through
the filter. Match any is the default matching method.
Maximum Allowed — Displays the currently allowed number of items in the Engineering Data
Editor.
Operator — Specifies the relationship between the property and its value. Relationships
include, for example, greater than, >; equal to, =; not equal to, <>; and so forth.
Options — Allows you to choose between refining your query and entering report-only mode.
Property — Displays a list of all properties for a certain item type. Examples of properties
include Equipment Type, Instrument Loop Item Tag, and Estimated Length. You define or
modify filtering criteria by selecting a property, an operator, and a value.
Refine Query Definition — Allows you to use the Additional Filter Criteria list in this dialog
box to refine your query in order to display an allowed number of items in the view.
Rows Returned — Displays the number of items that your query returned.
Value — Lists appropriate values for the property specified in the Property column. If a list of
attributes is not already associated with the Value box, you must type a value, which can be free
text, or choose null. You can type a percent sign (%) as a wildcard character to find multiple
characters or an underscore (_) as a wildcard character for a single character. Do not use an
asterisk (*) in the Value box.

Display the Engineering Data Editor

Click View > Display > Engineering Data Editor.
To close the Engineering Data Editor, click View > Display > Engineering Data Editor
again.
Actions Menu (Engineering Data Editor)
Contains commands for placing multiple representations of an item, deleting stockpile items, or
moving items between stockpiles. Click the down-arrow next to the Actions menu to display
the available commands.
Place Multiple Representation Command

Allows you to place a second instance of an equipment item in a second drawing. This multiple
representation allows the depiction of an item from another drawing in a detailed or alternate
view. Multiple representations are available only for some types of equipment.
For SmartPlant P&ID Engineering, this command is disabled.
Delete Stockpile Item Command

Removes the stockpile item from the plant model completely. The item and its properties are
deleted from the database and can no longer be placed in a drawing, regardless of the settings
in Options Manager or Catalog Manager.
 In the case of a connector, this command is not available unless the partner connector is in
one of the stockpiles.
 For equipment components, the Engineering Data Editor view does not include a filter for
Item Status = 'Active' (unlike other item types). Therefore the row corresponding to the item
that was deleted from the stockpile is still shown in the view but becomes read-only after
refreshing the Engineering Data Editor display; the item is removed from the display only
when you close and reopen the drawing.
 After deleting a stockpile item from the model, you can restore it to the stockpile (and then to
the drawing) using the Edit > Undo command on the main menu, unless you have
performed one of the actions that clears the Undo buffer. For details, see Undo Command
(Edit Menu) (on page 157).

Move to Different Stockpile Command

Allows you to move a stockpile item from one stockpile to another. For instance, you can move
an item from the Stockpile into the stockpile for your active drawing if you know the item belongs
in that drawing but are not yet ready to place the item. Similarly you can move an item in the
Drawing Stockpile to the Stockpile so that it can be used in other drawings. You can even move
items from one drawing stockpile to another. The Move to Different Stockpile dialog box
opens.
Edit Menu (Engineering Data Editor)
Allows you to copy and paste values from one cell to another cell in the Engineering Data
Editor and to select all the items in the view in order to create a select set. You can also invoke
a claim at any time to expand the scope of your project, and any new item created in a project is
automatically claimed by that project. You can also release a claim at any time and you can
determine the validity of a claim.
Click the down-arrow next to the Edit menu button to display the available commands.
Copy Command
Places the value in the currently selected cell onto the Clipboard so that you can paste it
somewhere else. This command does not remove the value from the selected table cell. Values
placed on the Clipboard remain there until newer values are copied over them.
Paste Command
Places the value from the Clipboard into the selected cell. If the cell is read-only, then the Paste
command is not available. You must have previously placed a value on the Clipboard in order to
paste it.
Select All Command

Chooses all the items in the active Engineering Data Editor. You can create a select set using
this command.
Claim Command
Gives control of the selected items to the current active project. The Claim dialog box opens,
allowing you to confirm the "claim-ability" of the items and enter claim comments. Claim
comments can be viewed later by anyone in the Plant when the claim status is displayed.
This command can only be used for items that belong to the active drawing.
See Also

Release Claim Command

Displays the Release Claim dialog box and allows you to relinquish control (by your project) of
the selected items. This dialog box also displays when you attempt to unclaim an item that has
been modified in the project. Claims must be released before projects can be completed or for
other projects to be able to check in drawings with changes.
 If you are working in SmartPlant environment and there are any differences between an item
in the Project and an item in the As-Built, the claim cannot be released. If you are not
working in the SmartPlant environment, the claim can be released. Also, items that display
no warnings or errors are released.
 This command can only be used for items that belong to the active drawing.
Claim Status Command

Opens the Claim Status dialog box, which displays the details of the claimed state of the
selected items and enables you to claim items, release the claims to items, and so forth. You
must select the items in the Drawing view or the Engineering Data Editor before using this
command.
View Menu (Engineering Data Editor)
Displays the commands that help you customize and manipulate the layout and content of the
Engineering Data Editor. Click the down-arrow next to the menu button to display the
commands.
Edit View Command

Opens the Edit View dialog box, where you can access options to specify the tabular display. If
you click Advanced on this dialog box, the Advanced View Properties dialog box opens, and
you can further modify the layout and create custom filters for your Engineering Data Editor.
The Engineering Data Editor is where stockpile items are displayed.
Edit View Dialog Box

Enables you to select the item types, filters, and layouts for the Tabular or Engineering Data
Editor. This dialog box appears when you right-click an existing table and select Edit View.
Item type — Lists all the item types that you can select (for example, equipment or motors).
Filter — Lists all of the filters that have been saved for the selected item type.
Layout — Lists all of the layouts that have been saved for the selected item type. For a list of
default layouts, see Default Table Layouts (on page 54).
Advanced — Displays the Advanced View Properties dialog box, where you can define and
save filters or layouts for the Tabular or Engineering Data Editor. You can specify the default
filter and layout for a certain item type also. Specify brief and bulk properties in this dialog box,
too. Brief and bulk properties appear in the Properties window when you select the Show Brief

Properties, Copy Bulk Properties, or Paste Bulk Properties commands from the Properties
window toolbar.
Advanced View Properties Dialog Box

Allows you to define, select, and save filters and layouts for the Tabular or Engineering Data
Editor. This dialog box opens when you click Advanced on the Edit View dialog box.
Filter Tab (on page 52)
Layout Tab (on page 53)
Filter Tab
Allows you to define, select, and save a filter for the Engineering Data Editor. If using an
on-the-fly filter to display data in the Engineering Data Editor (by opening the Edit View dialog
box and clicking Advanced), this filter overrides the existing filter selected using the settings on
the EDE toolbar.
Base filter
Displays details of a saved filter.
Name — Displays the name of the filter as defined in Filter Manager.
Default — Indicates if the named filter is the default filter for the item type selected on the Edit
View dialog box. You can change a filter to the default by selecting this box.
Browse — Opens the Select Filter dialog box, which allows you to select a base filter.
Definition
Allows you to add, remove, or edit filter criteria and to specify the relationship between multiple
criteria.
Edit
Provides options that allow you to define or edit a single line of filter definition criteria.
include revision number and name. You define or modify filtering criteria by selecting a property,
an operator, and a value.

Layout Tab
Allows you to define, select, and save a layout for the Tabular or Engineering Data Editor.
Name — Displays the name of a saved layout. You can enter a new layout name and then click
Save to save the layout for re-use, or you can select any of the layouts in the list.
Default — Indicates whether the named layout is the default layout for the item type on the Edit
View dialog box. You can designate a layout as the default by selecting this box and then
clicking Save.
Usage — Lists the property display types associated with the Properties window. The
available options are:
 Blank value — Specifies that neither Brief nor Bulk usage is implemented in the selected
layout.
 Brief — Determines that the list of properties shown in the Display Property column are
displayed in the Properties window when you select the Show Brief Properties command
from the toolbar.
 Bulk — Determines that the list of properties shown in the Display Property column are
copied in the Properties window when using the Copy Bulk Properties and Paste Bulk
Properties commands from the toolbar.
 Brief/Bulk — Specifies that both Brief and Bulk usage are implemented in the selected
layout.
Where more than one layout exists, you can define the usage as Brief for any one layout and
Bulk for any other layout, or you can define the usage as Brief/Bulk for one layout only. If you
previously defined the usage for a particular layout and subsequently define the same usage for
another layout, the usage in the first layout is removed. In order for your choice for the Usage
property to take effect, you must exit and re-enter the design software.
Delete (Name) — Removes the named layout.
Save — Saves the data in this dialog box as a named layout. Layout names must be unique.
Saving a layout is not the same as saving a view in the Engineering Data Editor. For
more information about saving views, see Save an Engineering Data Editor View (on page 58).
Definition — Displays all defined criteria associated with the selected layout. This group
contains two list views. In order to add to or modify either list, you must select a line in the list
and then define or edit the property in the Edit group. The buttons to the right act upon the
active list view.
Display Property — Lists the columns that appear in the Engineering Data Editor. To edit an
entry, select it and modify the property in the Edit group.
Caption (Definition) — Displays the caption for each column in the Engineering Data Editor.
Sort Property — Lists the properties that apply to the item type specified on the Edit View
dialog box.
Order — Lists the sort orders Ascending and Descending. You can select one.
Type — Lists the sort types Numeric and Alphanumeric. You select one.

Add — Adds a new entry at the end of the existing entries and enables the options in the Edit
group so that you can edit the new entry.
Insert — Places a new entry above the currently selected entry and enables the options in the
Delete (Definition) — Removes the currently selected entry.
Up — Moves the currently selected entry up one line. Moving a row up either moves a display
column to the left or moves a sort order up, depending on the row you have selected.
Down — Moves the currently selected entry down one line. Moving a row down either moves a
display column to the right or moves a sort order down, depending on the row you have
selected.
Edit — Allows you to edit a single entry selected in either the Display Property or Sort
Property list views. If you select an entry in the Display Property view, the Edit group allows
you to edit the property and the caption. If you select an entry in the Sort Property view, the
Edit group allows you to edit the property, order and type.
Property — Displays a list of all the properties that apply to the item type defined on the Edit
View dialog box. If you select an entry in the Display Property view, you can specify the
property and its caption. If you select an entry in the Sort Property view, you can specify the
property, its order, and its type.
Caption (Edit) — Displays the caption for each column in the Engineering Data Editor.
Default Table Layouts

The software includes several default layouts. You can use them to base your own layouts on by
changing the layout name, adding or deleting properties, and saving under a new name.
Different layouts are included with SmartPlant Electrical and SmartPlant P&ID.
SmartPlant Electrical
 Default Battery Bank List
 Default Bus List
 Default Cable List
 Default Circuit List
 Default Circuit Breaker List
 Default Control Stations List
 Default Document List
 Default Generator List
 Default Load List
 Motor List
 Default PDB List
 Default Reference Cable List

SmartPlant P&ID
 Area Break
 Drawing
 Equipment
 Equipment Component
 Exchanger
 Mechanical
 Equipment Other
 Vessel
 Instrument
 Instrument Loop
 Item Note
 Nozzle
 OPC
 Package
 Pipe Run
 Piping Component
 Plant Item
 Plant Item Group Other
 Representation
 Safety Class
 Signal Run
 System
Define a New Engineering Data Editor View

 Click Window > New > Engineering Data Editor. The system displays a new
Engineering Data Editor window.
Define a New Filter for an Engineering Data Editor View

1. On the Edit View dialog box, click Advanced.
You can open the Edit View dialog box by right-clicking the Engineering Data Editor
and choosing Edit View on the shortcut menu.
2. On the Filter tab of the Advanced View Properties dialog box, specify a name for the filter
in the Base filter box.
Check Default if you want this filter to be the default for the item type that you selected
on the Edit View dialog box dialog box.

3. Click Browse if you want to search for a filter or create a new filter (either simple or
compound) using the Select Filter dialog box.
4. To further define a filter, populate the Definition box with properties and values.
5. Select a property, operator, and value in the Edit group.
The Property list displays properties that apply to your item type; the Operator list
displays all the possible relationships, such as greater than and not equal to; the Value list
displays the specific properties that you can filter for.
6. You can click Add to add another line to the Definition box, if necessary. To add more
entries, repeat steps 4 and 5.
7. Click Delete if you want to delete the current row in the Definition box.
8. Click either Match all or Match any.
9. Click OK on the Advanced View Properties dialog box and again on the Edit View dialog
box so that the software can populate your table.
After you have defined a specific filter for your Engineering Data Editor, you can save
that definition (for details, see Save an Engineering Data Editor View (on page 58)).
 If you are using a Workshare environment and you are at a satellite site, Project Filters
should not be created at a satellite site because when you synchronize reference data, you
lose that information. However, you can always create My Filters in the Filter Manager
environment.
 The filter settings override any existing filter selected using the settings on the EDE
toolbar. Furthermore, the filter settings are lost when you close the drawing or select a
different item type in the Engineering Data Editor.
Define a New Layout for the Engineering Data Editor

1. On the Edit View dialog box, click Advanced.
You can right-click an existing Engineering Data Editor and select Edit View to open
the Edit View dialog box.
2. On the Layout tab of the Advanced View Properties dialog box, specify a name for the
layout.
Select Default if you want this layout to be the default table layout for the item type,
which you specify on the Edit View dialog box.
3. Click Save if you want to save the layout in order to apply it to another Engineering Data
Editor; click Delete if you want to delete the layout.
4. To further define a layout, populate the Definition box with display and sort properties.
5. Click Add to add a blank line to the Display Property list, and then specify the property and
caption in the Edit group at the bottom of the dialog box.
6. To add and define more display properties, repeat step 5.
To change the display order of the columns in the Engineering Data Editor, select a
row in the Display Property box and click Move Up or Move Down.

7. In the Sort Property list, click Add to add an entry. Then select the property, order, and
type in the Edit group at the bottom of the dialog box.
8. To add and define more sort properties, repeat step 7.
To change the sort order of the properties in the Engineering Data Editor, select a
row in the Sort Property box and click Move Up or Move Down.
 The Add, Insert, Delete, Move Up, and Move Down buttons apply to the active list view,
which can be either Display Property or Sort Property.
 If you are using a Workshare environment and you are at a satellite site, you should not
store custom layouts for the Engineering Data Editor because when you synchronize
reference data, you lose that information.
Modify the Properties of an Existing Engineering Data Editor View

1. In the Engineering Data Editor, click the View menu and select Edit View.
2. Review and edit the item type, filter, and layout on the Edit View dialog box.
3. If you want to customize a filter or layout click Advanced on the Edit View dialog box. For
more information, see
 Define a New Filter for an Engineering Data Editor View (on page 55)
 Define a New Layout for the Engineering Data Editor (on page 56)
4. Click OK to display the modified view.
 After defining a layout, you can save it if you want to apply it to another view of the
Engineering Data Editor. To save the view layout, specify a name in the Name box and
click Save on the Layout tab of the Advanced View Properties dialog box.
 You can also name and save the entire Engineering Data Editor, layout and all. For more
information, see Save an Engineering Data Editor View (on page 58).
Save View Command

Opens the Save View dialog box, which allows you to name and save the current Engineering
Data Editor. These custom views appear at the bottom of the filter list on the Engineering Data
Editor toolbar.
Save View Dialog Box

Allows you to specify a name for your custom Engineering Data Editor. This name, which
applies to the currently active EDE, is displayed at the bottom of the filter list on the
Engineering Data Editor toolbar with other saved views. Open this dialog box by clicking View
> Save View in the EDE.
Name — Provides space for you to type in the name of your custom view.

Save an Engineering Data Editor View

1. After you customize the Engineering Data Editor (EDE), click View > Save View on the
EDE toolbar.
2. Enter a name for your view in the Name box.
You can reactivate your saved view any time from the bottom of the filter list on the EDE
toolbar.
 An EDE view is a combination of item type, filter, and layout. You can change filters and
layouts by using the Advanced View Properties dialog box, and this action applies to any
EDE that refers to those properties of the table. That is, you can change a layout that applies
not only to a standard view but also to a saved view, and the new layout is reflected in both
views of the EDE.
 You can delete a saved view, too. For more information, see Delete a Saved Engineering
Data Editor View (on page 58).
 There are several ways to customize your EDE:
 Modify the Properties of an Existing Engineering Data Editor View (on page 57)
 Customize the Display of the Engineering Data Editor (on page 36)
 The EDE is where you can display stockpile items.
Delete View Command

Allows you to delete a view if you have stored a custom Engineering Data Editor view. These
custom views appear at the bottom of the filter list on the Engineering Data Editor toolbar
under Saved Views. The Delete View dialog box opens, and you can choose the view that you
want to delete from a list of saved views.
Delete View Dialog Box

Allows you to choose a saved custom Engineering Data Editor and delete it. It no longer
appears in the filter list in the Engineering Data Editor toolbar. Open this dialog box by clicking
View > Delete View in the EDE.
Name — Lists the saved views. Choose one and click OK to delete that view.
Delete a Saved Engineering Data Editor View

1. On the Engineering Data Editor toolbar, click View > Delete View.
Saved views are displayed at the bottom of the filter list on the Engineering Data
Editor toolbar.
2. Select the view that you want to delete from the Name list on the Delete View dialog box.
The Engineering Data Editor is where stockpile items can be displayed.

Refresh Command
Updates the display in the Engineering Data Editor. This command queries the database and
builds a new view with new results.
Update the Engineering Data Editor

Click Refresh on the Engineering Data Editor toolbar.
The database can change all the time. The Engineering Data Editor is not updated
automatically: you must update it by using the Refresh command manually.
Engineering Data Editor Shortcut Menu

The shortcut menu includes commands that are frequently used when you are using a tabular
view. To access the shortcut menu, right-click in the view.
See Also
Claim Command (on page 50)
Claim Status Command (on page 51)
Copy Command (on page 50)
Delete Stockpile Item Command (on page 49)
Delete View Command (on page 58)
Edit View Command (on page 51)
Move to Different Stockpile Command (on page 50)
Paste Command (on page 50)
Place Multiple Representation Command (on page 49)
Refresh Command (on page 59)
Release Claim Command (on page 51)
Save View Command (on page 57)
Select All Command (on page 50)
Using Catalog Explorer

Catalog Explorer is an interface to view and manipulate an electronic catalog containing
drawing symbols and their associated properties. Conceptually, the Catalog Explorer resembles
a manufacturer catalog with pictures of parts to build a plant. The paper catalog contains many
items arranged in sections; you can search for items or browse through the catalog and
bookmark certain pages and sections. Catalog Explorer replaces the paper catalog with an
electronic equivalent. You can browse the catalog tree view for drawing items that you need and
create bookmarks for important categories.
You can create a navigation bar in the region between the tree and list views for shortcuts to
places throughout the catalog.
The Catalog Explorer display is turned off by default the first time you launch SmartPlant
P&ID Engineering.

The tree view displays a hierarchy of nodes that contain catalog items. You can navigate
through the tree view by clicking the different nodes. To open a node, click the "+" to the left of
the node name. To close a node, click the "-" to the left of the node name. If the selected node
contains any drawing symbols, the software displays them in the list view.
If the Symbols node is not displayed in the tree view, ensure that in Options Manager,
the Catalog Explorer Root Path value does not include a trailing '\' (backslash) character.
At the top of the tree view, there are several toolbar buttons for carrying out commands and
allowing you to customize the tree and list views to suit your work session.
The list view displays the symbols that are associated with the active node in the tree view. Only
the contents of one node appear. You can specify the view style for the symbols in the list view
by selecting options on the View menu . View styles available are large icons, small icons,
list, and details.
From the list view, you can select catalog items before placing them in a stockpile.
1. Click "+" to the left of a node name to open the hierarchy below the node.
When you click a node that contains catalog items, the items stored in it are displayed
in the Catalog Explorer list view.
2. Click "–" to the left of a node name to close the hierarchy below the node.
3. Use the horizontal and vertical scroll bars to view other portions of the hierarchy.
Catalog Explorer Command (View > Display Menu)
Turns the display of Catalog Explorer on or off.

The Catalog Explorer display is turned off by default the first time you launch SmartPlant
P&ID Engineering.
Turn the Display of Catalog Explorer On or Off

1. Click View > Display > Catalog Explorer.
 You can also right-click the empty area in the main toolbar and then select Catalog from
the shortcut menu.
 Or, click View > Toolbars and select Catalog.
2. Use Catalog Explorer to view the symbol catalog and its contents and manipulate catalog
items.

Add an Item to the Stockpile from Catalog Explorer

1. In the Catalog Explorer tree view, click "+" by the node containing the appropriate symbol
library.
You can also double-click a node name in the Catalog Explorer tree view to expand
the node.
2. Select the appropriate node in the symbol library in order to display catalog symbols in the
Catalog Explorer list view.
3. In the Catalog Explorer list view, right-click the Loop or Plant Item Group symbol (excluding
Area Breaks and Revision Clouds) that you want to add to the stockpile (which do not
display on the drawing).
4. From the shortcut menu, choose either Send to Stockpile or Send to Drawing Stockpile,
depending on the stockpile that you want to place the item in.
 You can import a spreadsheet in a recognized format into a stockpile to populate it, too.
For more information, see Populate the Stockpile from a Spreadsheet (on page 173).
 You can move an item into the stockpile of a specific drawing. For more information, see
Move a Stockpile Item to the Stockpile of Another Drawing (on page 171).
Close the Catalog Explorer Window

 Do one of the following:
 Right-click the main toolbar area and cancel the selection of the Catalog Explorer
option.
 Right-click in the tree view of Catalog Explorer and on the shortcut menu, click Close.
 Toggle the display of Catalog Explorer back off by clicking the icon on the main
toolbar:
Catalog Menu
Catalog Explorer > Catalog
The Catalog menu in Catalog Explorer provides access to commands that allow you to
manipulate list view items and tree view nodes in the Catalog Explorer. Also, you can search
for catalog items.
The list of commands that are available on the Catalog menu depends on whether the
Tree (on page 60) view or the List (on page 60) view is active.
Find Command
Displays the Find dialog box, from which you can search the catalog for a specific item or group
of items.

Catalog Explorer Find Dialog Box

Allows you to search the active catalog for a specific item based on user-defined search criteria.
Open this dialog box by clicking File > Find in the Catalog Explorer.
Named — Specifies the name of the item for which you want to search. You can type an
asterisk (*) as a wildcard character to find multiple characters or a question mark (?) as a
wildcard character for a single character.
Class — Specifies the class of item for which you want to search. Select the asterisk (*) to
search for items in any class or select a class from the list to search for items in that class only.
Look In — Specifies the drive or folder that contains the symbol library that you want to search.
Browse — Opens the Explore Elsewhere dialog box, allowing you to search any network
drives or the local directory structure for a symbol library to display in the Look In box.
Results List — Lists the items that met the defined search criteria. You can drag catalog items
from this area into a My Catalog set of items in the Catalog Explorer tree view.
Find Now — Starts a search of the symbol library defined in the Look In: box.
Stop — Ends the current search.
New Search — Clears all search criteria in preparation for a new search.
Explore Elsewhere Dialog Box

Opens when you click Browse on the Catalog Explorer Find dialog box, allowing you to search
any network drives or the local directory structure for a symbol library.
Look in — Enter the location from which you want to view symbol information, or select a drive
from this list and use the tree that is displayed below to find the location you want.
Search for an Item in Catalog Explorer
1. On the Catalog menu , click Find.

The Tree view must be the active view in Catalog Explorer for the Find command to
be available on the File menu.
2. On the Find dialog box, fill in the Name & Class options.
You can use the asterisk, *, as a wildcard in either the Named or Class options to
broaden the scope of your search.
3. Click Find Now to start the search with the defined criteria.
Items found by the search appear at the bottom of the Find dialog box. You can select
one or more items by using the CTRL or SHIFT keys, but you cannot place an item directly onto
a design from this results window. However, you can save the set of current search results to
use later by dragging them into a My Catalog folder or subfolder in the Catalog Explorer Tree
view.

New Command
Adds a node under the My Catalog > Toolbars node in the Catalog Explorer. This command
is available when you click the Toolbars node.
Clicking the down-arrow of the File menu button accesses a list of the associated
commands. Clicking the File menu button itself repeats the last command that you used from
the File menu.
Designing Symbol Toolbars

Symbols toolbars allow you to create toolbars that contain the symbols you use most frequently,
keeping them conveniently located for easy access. Symbol toolbars can be plant-level or
user-level. You create plant-level toolbars in Catalog Manager; whereas, you create user-level
toolbars in either Catalog Manager or SmartPlant P&ID. With the most often used equipment,
instrumentation, or piping symbols, for example, your symbol toolbars can streamline your work
considerably. The symbol toolbars can be docked on any side of the main window.
Define a User-Level Symbol Toolbar

1. In the Catalog Explorer tree view, open the My Catalog node.
2. Right-click the Toolbars node under My Catalog.
3. Click New on the shortcut menu.
4. Name the new toolbar.
5. In the Catalog Explorer list view, find symbols you want to place on your new symbol
toolbar.
6. Drag symbols from the list view and drop them into the new toolbar in the tree view.
7. When you have added all the new symbols you want to your new toolbar, click on the
toolbar to view the symbols available from the new toolbar.
 You can dock the symbols toolbars on any side of the main window.
 You can define up to two levels of toolbars. For example, you can create a Vessels node
under Toolbars, and under Vessels you can create Vertical and Horizontal. A divider
appears in the symbol toolbar between levels.
 Plant-level symbol toolbars are created in Catalog Manager.
 You must have the proper permissions, granted in SmartPlant Engineering Manager, to
create symbol toolbars.
Open Command
Opens the Catalog Explorer window.

Delete Command (Catalog Explorer > Catalog Menu)

Removes the selected item from the Catalog Explorer list view or catalog node from the tree
view.
You must first delete all sub-nodes and catalog items that reside under a node before you
can delete the node itself.
Depending on your editing permissions, you are able to delete items from certain
catalogs. See your system administrator for information regarding your current privileges, which
are specified in SmartPlant Engineering Manager.
Delete a Catalog Node

1. Click the custom catalog node that you want to delete in the Catalog Explorer Tree view.
2. Click File > Delete .

3. Click OK on the confirmation box to delete the selected node.
 Depending on your editing privileges, you are able to delete nodes in certain catalogs. See
your system administrator for information regarding your current editing privileges, which are
specified in SmartPlant Engineering Manager.
 You must first delete all sub-nodes and catalog items that populate a node before you can
delete the node itself.
Delete a Catalog Item

1. In the Catalog Explorer List view, click the custom catalog item that you want to delete.
2. Click File > Delete .

3. Click OK on the confirmation box to delete the selected item.
Depending on your editing permissions, you can delete items from certain catalog.
See your system administrator for information regarding your current privileges, which are
specified in SmartPlant Engineering Manager.
Rename Command
Allows you to type a new name for the item or node.
Rename a Catalog Node

1. Click the custom catalog node that you want to rename in the Catalog Explorer tree view.
2. On the File menu , click Rename.

3. Type the new name for the custom catalog node.

Depending on your editing privileges, you can rename nodes in certain catalogs.
See your system administrator for information regarding your current editing privileges, which
are specified in SmartPlant Engineering Manager.
Refresh Symbol Toolbar Command (Catalog Explorer > Catalog

Menu)
Activates plant- or user-level symbol toolbars or updates the symbol toolbars to incorporate any
modifications to a toolbar.
Activate Symbol Toolbars

1. Right-click in the Catalog Explorer tree view.
2. On the shortcut menu, click Refresh Symbol Toolbar.
Close Command
Closes the Catalog Explorer window.
Send to Stockpile Command

Catalog Explorer > Catalog > Send to Stockpile
Sends the catalog item selected in the list view to the Stockpile. This command is particularly
useful for instrument loops and packages and other items that reside in a stockpile but generally
are not depicted graphically in a drawing.
Send to Drawing Stockpile Command

Catalog Explorer > Catalog > Send to Drawing Stockpile
Sends the catalog item selected in the list view to the Active Drawing Stockpile. This command
is particularly useful for instrument loops and packages and other items that reside in a stockpile
but generally are not depicted graphically in a drawing.
View Menu
The Catalog Explorer View menu provides commands that allow you to control the display
format of catalog items within the Catalog Explorer list view.

Large Icons Command

Catalog Explorer > View > Large Icons
Displays larger icons and names horizontally in the list view and does not list details.
Small Icons Command

Catalog Explorer > View > Small Icons
Displays smaller icons with names horizontally in the list view and does not list file locations.
List Command
Catalog Explorer > View > List
Displays smaller icons with names vertically using multiple columns in the list view and does not
list details.
Details Command
Catalog Explorer > View > Details
Displays smaller icons with names and source information vertically in a single column in the list
view.
Customize the Catalog Explorer List View

1. In Catalog Explorer click the down-arrow on the View menu .
2. Choose the display of items in your list view. Options include
 Large Icons — Displays the icon for an item in the list view in a larger format.
 Small Icons — Displays the icon for an item in the list view in a smaller format.
 List — Displays the icon and name for an item in the list view in a simple list.
 Details — Displays the icon, name, and file location for an item.
Navigation Menu
Navigation Menu (Catalog Explorer)
The Navigation menu in Catalog Explorer provides commands that allow you to control the
display and assignment of shortcut buttons within the Catalog Explorer. Shortcut buttons
provide shortcuts that bookmark a node in the active Tree view of Catalog Explorer. These
buttons reside on the navigation bar between the tree and list view in the Catalog Explorer
window.
For example, if your workflow requires you to route a lot of piping, you want to make a shortcut
button to the Process Lines node. Then when you open Catalog Explorer and click this

shortcut button, you open the node for the piping and all the piping types appear in the list view.
Consequently you save the time and effort of browsing the catalog node structure in the tree
view in order to find the node that you want to open in the list view.
The software does not limit the number of shortcut buttons that you can create, but you are
limited by the size of the Catalog Explorer window. Also, shortcut buttons are shortcuts to
catalog nodes only. If you want to make a shortcut to a particular symbol that you use a lot, you
can use the symbol toolbar.
All of the commands for managing your shortcut buttons are found on the Navigation menu of
the Catalog Explorer window.
Add Button Command

Catalog Explorer > Navigation > Add Button
Adds a shortcut button to Catalog Explorer for the active tree view node. For example, if you
frequently select nozzles, you can add a shortcut button to the nozzles node of the Catalog
Explorer tree view by selecting Nozzles in the tree view and then choosing Add Button from
the menu that appears when you click the down-arrow of the Navigation menu. You must also
select the Show Buttons option in the menu in order for your shortcut button to appear between
the tree view and list view windows of Catalog Explorer.
Clicking the down-arrow of the Navigation menu button above accesses a list of the
associated commands. Clicking on the Navigation menu button itself repeats the last command
that you used from the menu.
Add a Shortcut Button to the Catalog Explorer Navigation Bar

1. Verify that shortcut buttons are set to appear on the navigation bar between the tree and list
views of Catalog Explorer by clicking the down-arrow on the Navigation menu and
making sure that Show Buttons is selected.
2. In the tree view, select the node that you want a shortcut to.
3. On the Navigation menu, click Add Button to create a shortcut button for the currently
selected node.
You can right-click any shortcut button to display options to add, remove, and show
buttons.
Remove Button Command

Catalog Explorer > Navigation > Remove Button
Removes the active shortcut button from the list of shortcut buttons in Catalog Explorer.

Remove a Shortcut Button from the Catalog Explorer Navigation Bar
On the Navigation menu , click Remove Button to delete the active shortcut button from the
navigation bar.
Or you can right-click any shortcut button and select Remove Button from its shortcut
menu.
Show Buttons Command

Catalog Explorer > Navigation > Show Buttons
Causes shortcut buttons to appear on the navigation bar between the tree view and the list view
of Catalog Explorer.
Display Shortcut Buttons in Catalog Explorer
On the Navigation menu , click Show Buttons.

A check mark next to the menu item indicates that shortcut buttons appear in Catalog
Explorer. The buttons appear on the navigation bar between the tree and list views.
You must first define a shortcut button in order to display it. For more information, see
Add a Shortcut Button to the Catalog Explorer Navigation Bar (on page 67).
Customizing Catalog Explorer

The Catalog Explorer toolbar buttons access the Catalog Explorer File,
View, and Navigation menus. The commands on these menus allow you to customize the
Catalog Explorer. After customization you can control the content and display of components in
the Catalog Explorer window. For example, you can control the display of icons in the list view
and define shortcut buttons that allow you easy access to user-defined groups of catalog items.
Assign a Command to a Catalog Explorer Toolbar Button

1. Click the down-arrow portion of a Catalog Explorer toolbar button to open the associated
menu.
2. On the menu, click an available command, for example, File > Find. The software assigns
the selected command to the Catalog Explorer toolbar button, the icon located next to the
menu button.
3. Click the toolbar button itself, and that most recent command from the menu is carried out.
For example, click the File menu button (not the down-arrow) and the Find command is
invoked again.

Navigating in the Properties Window

Working with the Properties Window
The Properties window display is a two-column table that provides the common properties of
the current selection in the active Design window. The active items always determine the
content of the Properties window. You can only have one Properties window open. If only one
component is selected, or all components are of the same type, all the properties of that type of
component appear. If your select set contains components of different types, then only the
common properties appear. If the selected items have different values for their common
properties, the value box is blank.
You can modify the values for properties in the Properties window. You can display and edit
relationships that involve components, component types, or assemblies.
At the top of the Properties window is the Selected Items list, which itemizes all of the selected
objects individually and as a select set. You can display item properties by locating the
appropriate item in the Selected Items list, as well as by selecting an item in the Design
window. If more than one item is selected in the Design window, then the Selected Items list
contains the choice Select Set as well as individual items in the set.
You can use the Copy Bulk Properties and Paste Bulk Properties buttons to copy properties
from one item to another. This action can be particularly useful when correcting inconsistencies,
for instance, or when you must apply changes to more than one item.
 The software includes a default set of bulk properties, but you can change those properties
specified as bulk in the Usage box on the Layout tab of the Advanced View Properties
dialog box.
 When you hold the pointer over the buttons on the Properties window toolbar, a ToolTip
appears with the name of the button.
 An item and the properties that belong to it are associated when the item is created in
Catalog Manager.
 If you copy or paste values in the grid area, use CTRL + C and CRTL + V. Do not use the
Edit > Copy, Edit > Paste, or Edit > Cut menu commands to modify property values in this
grid.
Turns the display of the Properties window on or off.

Properties Window Command (View Menu)
Opens the Properties window and displays characteristics for a selected item or a select set.
You can review and edit the properties. The applicable properties of an item are defined when it
is created in Catalog Manager.
You can also display the Properties window by clicking View > Display > Properties.
Properties Window Toolbar

You can customize the display of the Properties window by using the following Properties
window toolbar buttons:
Alphabetic — Lists properties in alphabetical order.
Categorized — Displays properties grouped by specific categories. Categories are defined

and properties are assigned to those categories in Data Dictionary Manager.
Show Brief Properties — Displays those properties that have been previously specified as
brief on the Advanced View Properties dialog box.
Copy Bulk Properties — Copies the bulk properties of a selected item. The properties are
then available to paste onto other items. For more information, see Copy Bulk Properties (on
page 73).
Paste Bulk Properties — Pastes copied bulk properties onto the newly selected item or
items. You must have previously selected an item or items and copied bulk properties. For
more information, see Paste Bulk Properties (on page 73).
Display Null — Displays a null value in blank properties that currently contain no
value. This option helps avoid confusion between empty cells and cells containing a zero. For
more information, see Display Null Values in the Properties Window (on page 73).
Show Case Data — Displays a list of case conditions, for example, temperatures,
pressures, and so forth. Case data includes both process cases and control cases, which are
displayed for equipment, pipe runs or instruments, according to relevance. To see the case
data that appears for corresponding items, look in Data Dictionary Manager.
Show Select Set — When using a fence to select a set of items, displays the common
properties of the selected items. This option improves display performance.
Show Single Item — When using a fence to select a set of items, displays the properties of
one item only. If you select multiple items by holding down the CTRL key, the software displays
the select set properties.
 The software includes a default set of bulk and brief properties, but you can change those
properties in the Usage box on the Layout tab of the Advanced View Properties dialog
box.

 The software will recognize valid URL addresses in a Description field. Double-clicking a
URL link in a Description field activates the link; for example, displaying an IP address in a
Web browser.
Turn the Display of the Properties Window On or Off

 Click View > Display > Properties Window. You can also display the Properties window
with a right-click in the empty area of the Main toolbar. Then, select Properties from the
shortcut menu.
Customize the Properties Window

1. Open the Properties window.
For more information on opening the Properties window, see Turn the Display of the
Properties Window On or Off (on page 71).
2. If more than one item is selected in the Drawing view or in the Engineering Data Editor,
use the Selected Items list at the top of the Properties window to choose a single item or
the select set of all listed items.
 The properties that are subsequently displayed in the window belong to the chosen item
or the select set. For the select set, only properties that all items have in common
appear, and only common values are displayed for those properties. Consequently,
empty property values for a select set do not necessarily mean that no value has been
assigned for any of the items in the set, only that either no value has been assigned or
that the different items have different values for the property.
 Whenever you have constructed a select set, you can choose single items from that set
by using the Selected Items list at the top of the Properties window. A single item
chosen in a select set this way is highlighted in a different color in the Drawing view.
3. Display properties alphabetically or by categories by clicking the corresponding display
mode button on the Properties window toolbar. Click to display properties
alphabetically; click to display properties by categories.
4. Display only brief properties by clicking Show Brief Properties .
5. Display case data by clicking Show Case Data .

6. Display a null character in empty property cells by clicking Display Null .
7. Display the common properties of a set of items selected using a fence by clicking Show
Select Set .
8. Display the properties of a single item among a set of items selected using a fence by
clicking Show Single Item . Note that if you select multiple items by holding down the
CTRL key, the software displays the select set properties.
When you point to a button on the Properties window toolbar and pause over it, a
ToolTip displays the name of the corresponding command.

Review and Edit Item Properties

1. Select the item or items whose properties you want to review.
2. Click Edit > Properties to display the Properties window.
 You can also display the Properties window by right-clicking the empty area of the main
toolbar and then selecting Properties from the shortcut menu.
 Or you can click View > Display > Properties Window on the main menu bar.
 Or you can right-click an item, and select Properties from the shortcut menu.
 Or you can click View > Toolbars and select Properties.
3. Enter or edit information in the cell next to the appropriate property.
 You can review and edit item properties in the Engineering Data Editor, too. You can edit
the contents of some cells directly in the table if the corresponding property is not read-only
or generated strictly by validation, or you can select an item by clicking the icon in the
left-most column and then edit its properties in the Properties window.
 For formatted properties, such as estimated length or maximum operating temperature, you
can enter a value without a format. Use a single quote, ', at the beginning of your entry. In
this way, you can enter free text into a formatted property and no units of measurement are
assigned.
Associate an Item with a Plant Group

1. Select the item that you want to associate with a different plant group.
 The default plant group is the node in the plant hierarchy immediately under which the
drawing resides.
 Not all item types support the plant group property.
2. In the Properties window, select the plant group type in the Plant Group Type property
box.
It is possible that you do not want to modify the plant group type. For instance, your
item can already be associated with the plant group type of unit, but you want simply to
associate it with a different unit. Go to the last step if this is the case.
3. Modify the plant group name in the Plant Group Name property box.
If identical plant group names exist, holding the mouse pointer over a selected value
from the list displays a tool tip showing the plant group hierarchy path for that value.
Therefore if two units named U1 are available in the list, displaying the tool tip will show the
different paths for the names; for example \A1\U1 and \A2\U1.

Copy Bulk Properties

1. In the Design window or Engineering Data Editor, select the item whose bulk properties
you want to copy.
2. Click Copy Bulk Properties .

You can now paste these properties onto another item. For more information, see
Paste Bulk Properties (on page 73).
The software includes a default set of bulk properties, but you can change those
properties specified as bulk in the Usage box on the Layout tab of the Advanced View
Properties dialog box.
Display Null Values in the Properties Window

1. Select an item in your drawing.
2. Right-click and select Properties.
3. Click the null button to display a null value in blank properties.
Null means that the property is not defined, or is empty, and is not the same as a zero
value.
Paste Bulk Properties

1. Select the item or items that you want to paste bulk properties onto.
2. On the Properties window toolbar, click Paste Bulk Properties .

You must first have copied the bulk properties of a different item in order to paste them
onto your current selection. For more information, see Copy Bulk Properties (on page 73).
The software includes a default set of bulk properties, but you can change bulk properties
in the Usage box on the Layout tab of the Advanced View Properties dialog box.
Show Brief Properties

On the Properties window toolbar, click the Show Brief Properties button .
The software includes a default set of brief properties, but you can change that set on the
Layout tab of the Advanced View Properties dialog box.

Show Case Data

 On the Properties window toolbar, click the Show Case Data button .
 Once you display case data in the Properties window, case data remains displayed for
the current design session.
 After updating case data using Plant Editing, the next time the drawing is opened and
an appropriate item is selected, its case data is displayed.
 If the Properties window is not displayed, you can select an item and click Edit >
Properties.
 Case data includes both process cases and control cases, which are displayed for
equipment, pipe runs, or instruments, according to relevance. To see the case data that
appears for corresponding items, look in Data Dictionary Manager.
Customizing the Software

Customization allows you to modify and enhance the software to meet your specific needs.
You can use standard Windows programming tools and languages that are OLE-aware, such as
Microsoft® Visual Basic®. Several ways to customize the software are available:
Customizing with Built-In Commands

You can add commands to a menu or a menu command to a toolbar. To add a button to a
toolbar or a command to a menu, you click Tools > Customize. From there, you can click the
Menu or Toolbars tab and click the options that you want. For example, if you frequently use
the View > Previous command, you could add the Previous View button to the main toolbar.
The Previous View button is listed on the Toolbars tab of the Customize dialog box.
If you want to create a new toolbar that does not exist in the software, you can start by clicking
View > Toolbars. You then click New and type the name of the new toolbar on the New
Toolbar dialog box. After you click OK, the Customize dialog box automatically appears so
that you can add buttons to the new toolbar.
Customizing with Macros

Not only can you add built-in commands or buttons to the software, but you can also create your
own macros and add them to menus and toolbars in the same manner. The Tools >
Customize command allows you to add macros to the standard menus and toolbars in the
software. Or, you can run the macros directly by clicking Tools > Custom Commands and
selecting the macro.
You can create the macros in Visual Basic or other OLE-aware programming applications.
Some of the OLE-aware programming applications are Visual Basic for Applications, Visual C++
Delphi, Visual Basic, and so forth.
The software includes a type library, which contains all the objects, properties, and methods
available with the product. Click Help > Programming with SmartPlant P&ID to access the
SmartPlant P&ID Programming User's Guide, which provides a complete reference to the

objects, methods, and properties. You can view the type library with the type library browser of
Visual Basic or the browser for an OLE-aware programming application. Some macros also
are delivered with the software; see a list by using the Tools > Custom Commands command.
Customizing Interface Elements

You can customize many of the various ways of interfacing with the software. Some
customization options include displaying small or large icons, creating shortcut buttons to
access your most commonly used items, creating display sets, and so forth. For more
information about some of these options, see these examples:
 Add a Shortcut Button to the Catalog Explorer Navigation Bar (on page 67)
 Customize the Catalog Explorer List View (on page 66)
 Customize the Properties Window (on page 71)
 Define a User-Level Symbol Toolbar (on page 63)
 Using Filters and Display Sets Versus Levels (on page 374)
Customize Command (Tools Menu)

Opens the Customize dialog box, which allows you to customize toolbars or menus to fit your
workflow. You can add commands to toolbars or menus, or you can create new toolbars and
menus.
Customize Dialog Box

Changes the display of toolbar buttons and menus according to your needs. This dialog box
opens when you click Tools > Customize on the main menu bar.
Menu Tab (on page 76)
Toolbars Tab (on page 78)

Menu Tab
Adds or removes commands from menus or the main menu bar. You can add a command to an
existing menu or build a custom menu with the commands that you want. Or you can add a
single command to the main menu bar.
Add Command — Places a command on a menu. This button is available only when you select
a command or macro in the Commands box or Macros box.
Add Menu — Places a menu at the level currently open on the menu tree. When you add a
menu with this option, you can add commands to the new menu later. If you add a menu to an
existing menu, you create a cascading menu. After you click this button, you can type the name
that you want in the tree view and then enter it by clicking any other location on the dialog box.
Browse — Opens the Select Macro Directory dialog box. When you select a folder and click
OK, the Macros list displays the macros for the folder that you selected. The Browse button
appears only when you choose Macros in the Categories list.

Categories — Allows you to specify the category that you want to select a command or macro
from. Then you can add the command or macro to the menu or main menu bar. When you
select the title of a group of commands in this box, you can click the title of a command in the
Commands list. When you select Macros in the Categories list, you can select a macro from
the Macros list.
Commands — Allows you to specify the command that you want to add to the menu.
Description — Displays a description of the command that you selected before you add it to a
menu. Descriptions do not appear for macros.
Macros — Allows you to specify the macro that you want to add to the menu. If you select a
macro, you can click Browse to change the folder for macros.
Menu Tree — Lists the menus and their associated commands or macros. To see all the
commands on a menu, double-click a menu name or click the "+" next to the menu name. When
you click Add Command, Add Menu, or Remove, the changes show up on the menu tree.
Also, you edit menu and command names in this view.
Place into selected menu — Overrides the default placement and places a command or macro
on the menu that is currently selected in the menu tree. If you do not set this option, then the
macros, commands, or menus are added at the level that is currently open in the menu tree.
Reset All — Restores all menus and the main menu bar to the original settings.
Remove — Removes the command or menu that you selected in the menu tree.

Toolbars Tab
Adds or removes commands from toolbars.
Categories — Lists the categories of the toolbars that you can customize. Choose one and the
corresponding buttons appear in the Buttons area.
Buttons — Lists the buttons available in the active category. You can drag a button from this
area onto a toolbar.
Description — Describes the button selected in the Buttons area.

Custom Button Dialog Box

Allows you to assign a toolbar button icon to a macro. This dialog box opens when you drag a
macro from the Toolbars tab of the Customize dialog box to the toolbar.
Buttons — Displays the available icons.
Assign — Specifies the icon for your button and closes the dialog box.
Browse — Opens the Select Bitmap File dialog box, which allows you to look for an icon on
your local computer or on the network.
Remove a Command from a Menu

2. On the Menu tab, double-click a menu in the menu tree.
The menu tree expands to show the commands on the existing menu.
3. Click the name of an existing menu or command that you want to remove from the main
menu bar or the existing menu.
4. Click Remove.
Add a Command to a Menu

2. In the Categories list on the Menu tab, select the command category that you want.
3. In the Commands or Macros box, click the name of the command that you want to add.
If you choose Macros from the Categories list, then the Macros box is displayed;
otherwise, the view contains the Commands box.
4. In the menu tree, double-click the name of the existing menu that you want to add a
command to.
The menu tree nodes expand to show the commands on the existing menus.
5. Click the name of the command that you want the new command to appear after.
6. Select Place into selected menu.
If you want to add the new command to the main menu bar, clear the Place into
selected menu option. The software places the new command on the main menu bar after
the existing menu that you select in the menu tree.
7. Click Add Command.

Restore All Built-In Menus to their Original Settings

2. On the Menu tab, click the Reset All button.
If you remove Customize from the Tools menu, you can restore the command.
Right-click the empty area of the main toolbar and click Customize on the shortcut menu in
order to open the Customize dialog box.
Create a New Menu

2. In the Categories box on the Menu tab, click the command category that you want.
3. On the menu tree, click the name of an existing menu.
4. Click the Add Menu button.
 The new menu is added after the existing menu that you selected in step 3.
 If you want to add a menu to an existing menu, select Place into selected menu before
you click the Add Menu button, thereby creating a cascading menu.
5. On the menu tree, type the name of the menu.
6. To enter the new menu, click anywhere away from the name.
After you create a new menu, you can add commands to it. For more information, see
Add a Command to a Menu (on page 79).
Custom Commands Command

Opens the Custom Commands dialog box. You can choose a macro and run it. Some macros
are delivered with the software, generally in the ..\SmartPlant\P&ID Workstation\bin folder. You
can also record your own macros and store them wherever you want to.
Clean Data Dialog Box

The Delete Orphan Model Items utility opens when you click Tools > Custom Commands and
run the DelOrpModItems.dll. You use this utility to delete obsolete model items from the
database. For more information, refer to the SmartPlant P&ID Installation and Upgrade Guide.
Database Report — Generates a report, written to the DBCleanup.txt file in your Temp folder,
that helps you decide if a manual cleanup alternative exists before using the Entire Database
command to delete the problems from the database.
Entire Database — Removes orphaned records from the plant database. Use this only after
running Database Report, examining the report, and manually cleaning up as many items in the
database as necessary.
Model Items — Opens the Delete Orphan Model Items dialog box, that allows you to find and
delete any model item in the database that does not have a corresponding entry in the
T_Representation table. For details, see Delete Orphan Model Items Dialog Box (on page 81).

OPCs — Finds and repairs off-page connectors (OPCs) that have lost their associations with
the OPC with which they were originally paired. If one OPC has lost the identity of its mated
OPC, but the mated OPC still has the identity of the first OPC, then the OPC is considered
repairable. To repair the OPC, the utility updates the identity information for the first OPC.
However, if both the OPC and its mated OPC have lost the identities of each other, then the
OPCs are considered non-repairable, and you are given the option to delete them.
Gaps — Repairs and updates gaps in the representation record with the proper item type. On
rare occasions you will need to perform this operation if you have gapping problems in your
drawings.
Repair OPCs Dialog Box

Opens when you click Tool > Custom Commands to run DelOrpModItems.dll and click
OPCs. You can choose OPCs to repair or delete from the plant database. This dialog box is part
of the Delete Orphan Model Items Utility. For more information, see Related Topics.
OPC Types — Allows you to choose to list either the repairable or the non-repairable OPC pairs
that have lost links to their partner OPCs either one-way or both ways.
Fix — Fixes the reference to the mated OPC that you have selected in the OPC list.
Delete — Deletes the non-repairable OPC pair that you have chosen in the OPC list.
Delete Orphan Model Items Dialog Box

Opens when you click Model Items on the Clean Data dialog box. You can choose the orphan
model items that you want to delete from the plant database. As part of the Delete Orphan
Model Items Utility, this dialog box can be used to accomplish the following tasks:
 Clean orphaned records from the plant database.
 Find and delete any model item in the database that does not have a corresponding entry in
the T_Representation table. The utility works on an item type basis and repairs the following
model item types: Vessel, Mechanical, Exchanger, Equipment: Other, Equipment
Component, Instrument, Nozzle, Piping Component, Ducting Component, Pipe Run, Signal
Run, Duct Run, OPC, Item Note, Area Break, Room, and Room Component. Once the
orphan model items for an item type are found, you can select any or all of the items and
choose to delete them.
 Find and repair off-page connectors (OPCs) that have lost their associations with the OPC
that they were originally paired with. If one OPC has lost the identity of its mated OPC, but
the mated OPC still has the identity of the first OPC, then the OPC is considered repairable.

To repair the OPC, the utility updates the identity information for the first OPC. However, if
both the OPC and its mated OPC have lost the identities of each other, then the OPCs are
considered non-repairable, and you are given the option to delete them.
 Update gaps in the representation record with the proper item type. This need occurs only in
rare instances. You need to perform this operation if you have gapping problems in your
drawings.
Item Type Names — Allows you to choose the type of orphaned model items that you want to
display in the Item list.
Delete — Removes the orphan items selected in the Item list from the plant database.
Delete All — Selects and deletes all the orphan model items of the type specified in the Item
Type Names list.
Delete Orphan Model Items
 Verify that the plant user has full permissions to the tables, T_Representation and
T_ModelItem. For information on setting table permissions, refer to your database
documentation.
 It is very important that you perform the steps in the sequence that they are presented. The
buttons on the utility are arranged appropriately.
1. Open a drawing, and click Tools > Custom Commands to open the Custom Commands
dialog box.
2. Browse the drawing software program directory and open DelOrpModItems.dll.
You can find this macro in the ..\SmartPlant\P&ID Workstation\bin folder.
3. On the Clean Data dialog box, click Model Items.
4. On the Delete Orphan Model Items dialog box, choose the model item type from the Item
Type Names list.
5. In the list view, select the model orphan items to delete and click Delete.
You can also click Delete All to select and delete all the items in the list view.
6. Click Close.

7. On the Clean Data dialog box, click OPCs.

8. On the Repair OPCs dialog box, choose either repairable or non-repairable from the OPC
Type list.
Repairable OPC pairs retain one link out of two between the mates. Non-repairable
OPC pairs retain neither link.
9. Choose the OPC pair that you are interested in from the OPC list, and click Fix if it is a
repairable pair or Delete if it is non-repairable.
10. Click Close.
11. On the Clean Data dialog box, click Gaps to find and repair gaps that do not have the
correct representation in the database.
Follow the prompts on message boxes if you see any.
12. Click Close to return to the design software.
 The Delete Orphan Model Item Utility must be run from within the drawing environment.
 Log messages generated when orphaned records are deleted from the plant database are
written to the DBCleanup.txt file in the directory assigned to the Temp environment
variable.
 Log messages are placed in SPDelOrpModItems.log file in the directory assigned to the
Temp environment variable. The log file contains information about deleted items including
the item type and SP_ID.
Run a Macro
1. Click Tools > Custom Commands.
2. On the Custom Commands dialog box, select the macro that you want to run.
3. Click Run.
You can create macros with any programming tool that supports OLE automation, such
as Visual Basic.


SECTION 3
Working with Drawings

When you open a drawing, the drawing is displayed in a Drawing view in the Design window.
Drawings are graphical representations of plant models using standard symbols and
conventions. A plant model consists of components. A component is any piece of equipment,
instrumentation, piping, or other item used to create a plant model. Symbols represent
components in Catalog Explorer and Engineering Data Editor. In the Properties window, you
enter appropriate values into the database for each property of the component. You can use the
commands on toolbars and in menus to add information to your drawing, and you can use edit
commands to modify the information in your drawing.
Any changes that you make to the drawing data are automatically saved in the database. You
can also save drawings in .pdf format. You cannot save a drawing as a template. The only way
to use a template is to have a plant administrator select a template at drawing creation in
Drawing Manager.
The following table lists the characters that cannot be used in certain names, paths, passwords,
or file names throughout the SmartPlant Engineering Manager, SmartPlant P&ID, and
SmartPlant Electrical products.
Object Restricted Characters
File and Directory Names (Windows \/:*?”<>|

restriction)
SmartPlant Engineering Manager Names ~`!%^&*()-+={}[]\/;:‘"<>,.?|

(site, plant, project, and satellite names)
Database User Names " ’ [ ] for Oracle

~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : ‘ " < > , . ? | for
SQL Server
Database Passwords " ' @ for Oracle

' for SQL Server
' Other special characters are allowed for
'passwords.
Oracle System Passwords All special characters are restricted except for
@ ('at' symbol), . (period), and _ (underscore)
Paths (directories, and so forth) ~`!%*(){}[]/;:'"<>,?|

Opening Existing Drawings

The Open command on the File menu opens existing drawings. You can also change
databases by using this command so that you can open drawings in other plants.
The software keeps track of the drawings that you worked on last. These drawings appear at the
bottom of the File menu. To open one of these drawings, you can select it from that list. The
Options command on the Tools menu allows you to set the number of entries displayed in that
list.
Setting Up Properties for a Drawing

An administrator sets up drawing properties such as units of measure in Options Manager and
Format Manager. The drawing information is stored in a database associated with the drawings
in a plant.
With the Properties command on the File menu, you can view, edit, and save properties for a
drawing. Drawing properties can include the title, the author, and keywords that identify
important information. These properties include drawing statistics, such as drawing size and the
date that a drawing was created and last modified; the software updates statistics automatically.
You can change the name of a drawing in Drawing Manager.
Renaming a drawing file in Windows allows the drawing to be opened with all graphics
pointing to the database. However, renaming a drawing file in Windows does not update the
drawing table in the plant schema where the drawing name is stored.
Working with Several Open Drawings

Several drawings can remain open in the same session but only if they all belong to the same
plant. Each drawing can have more than one view, too. You can use the Cut, Copy, and Paste
commands to move or copy information between the drawings or within one open drawing. You
can use commands on the Window menu to arrange all the open drawings and views so that
you can see them easily.
Open Command (File Menu)
Opens the Open dialog box, which lists existing plants and their drawings. An administrator
creates the hierarchy of plants and projects in SmartPlant Engineering Manager.
Open Dialog Box

Displays the active plant hierarchy and lists its drawings, and allows you to open a drawing and
to choose the database that you access. This dialog box appears when you click File > Open
on the main menu bar.
Pause over a toolbar button in order to display a ToolTip, which names the corresponding
command.
Open Database — Opens the Open Plant Structure dialog box, which allows you to
specify a different initialization file so that you can work in a different database. You cannot open
two drawings from different databases at the same time. If you currently have a drawing open
in SmartPlant P&ID, the Open Database command is not available.

Filter — Opens the Filter dialog box, which allows you to specify criteria for filtering the
drawings that are displayed in the List view.
Clear Filter — Deactivates any filter you have applied to the list of drawings that appears in
the List view.
Include Subnodes — Displays in the right-hand view of the Open dialog box all the
drawings and node names that reside in the currently selected node.
Details — Displays a detailed view in the right-hand window. The detailed view displays all
the properties specified in the Selected Properties list of the Customize Current View dialog
box. Using the detailed view allows you to view and sort drawings by several attributes.
List — Displays the list view in the right-hand window. The list view only displays one
property for each drawing. You can specify that descriptor by clicking Customize View; the first
item in the Selected Properties list is the descriptor that appears in the list view.
Customize View — Opens the Customize Current View dialog box, which allows you to
specify the information about each drawing that is displayed in the report or list view of the Open
dialog box.
Open Plant Structure Dialog Box

Sets options for connecting to a site and plant structure and passes user access information to
the application. This dialog box opens when you click Open Database on the Open dialog
box.
Application Type — Allows you to select an application for filtering the available plant
structures that are associated with that application. If all the plants in the site are associated
with one application only, the value is read-only.
Available plant structures — Lists those plant structures found on the network. You can select
only one item from this list view at a time.
Open — Connects you to the selected database. The Open command also checks to make
sure you have the correct access privileges for the selected plant structure and passes your
access information back to the software.
Site Server — Opens the Open Site Server dialog box, allowing you to select an initialization
file from local and network directories. Plant structures that correspond to the initialization file
that you choose are subsequently displayed in the list of available plant structures.

Filter Dialog Box

Sets options for the display of drawings in the list or report view of the Open dialog box. This
dialog box opens when you click Filter on the Open dialog box.
Definition — Displays all defined criteria associated with a filter. To add to or modify the
definition list, you must select a line in the list and then define or edit the property in the Edit
group.
Edit — Allows you to define or edit a single line of filter definition criteria.
include revision number and name. You define or modify filtering criteria by selecting a property,
an operator, and a value.
Customize Current View Dialog Box

Allows you to specify what drawing property or properties are displayed in the list view of the
Open dialog box. This dialog box opens when you click Customize View on the Open
dialog box.
Add — Moves the selected items in the Drawing properties list into the Selected properties
list so that those properties are available in the detailed view of the Open dialog box.
Drawing properties — Lists the properties that are available to be displayed in the detailed
view of the Open dialog box.
Move Up — Moves the selected property up in order in the list, which changes the order of the
display in the detailed view of the Open dialog box.
Move Down — Moves the selected property down in order in the list, which changes the order
of display in the detailed view of the Open dialog box.
Remove — Moves the chosen items in the Selected properties list back into the Drawing
properties list so that they are no longer available in the detailed view.
Selected properties — Displays the properties that are currently available for the detailed view
in the Open dialog box.

Open an Existing Drawing

1. On the main toolbar, click Open .
2. Double-click the drawing that you want to open.
If you do not see the drawing that you want to open, confirm that the plant hierarchy is
correct. You can change the database you are working in. For more information, see
Open a Drawing in a Different Database (on page 89).
 You can open one of the last edited drawings by selecting it from the list of recently opened
files at the bottom of the File menu on the main menu bar.
 You need to have the correct permissions to open or save certain drawings. Your plant
administrator has set the plant hierarchy and has identified user names and tasks for those
plants and related drawings. User roles are assigned in SmartPlant Engineering Manager.
 If a filter was previously applied on the Open dialog box or in Drawing Manager, the filter
settings are retained for the plant the next time you open the List view. If you select another
plant, any filter that was previously applied to the current plant is cleared.
Open a Drawing in a Different Database

1. On the main menu bar, click File > Open.
2. On the Open dialog box, click Open Database .

The Open Database command is not available if you already have a drawing open
because you cannot open drawings from different databases during the same P&ID session.
3. On the Open Plant Structure dialog box, click Site Server.
4. On the Open Site Server dialog box, select the correct SmartPlant .ini initialization file and
click OK.
5. Select the correct plant on the Open Plant Structure dialog box and click Open.
The Open command checks to make sure that you have the correct access privileges
for the selected plant structure and passes your access information back to the software.
6. Navigate to the correct drawing in the Open dialog box and double-click it.
Customize the Open Dialog Box

1. To apply a filter to the drawings displayed in the right-hand view of the Open dialog box,
click Filter .
2. On the Filter dialog box, define your ad hoc filter criteria.
3. To cancel a filter that you have already applied to the Open dialog box, click Clear Filter
.
4. To display all the drawings and node names that reside in the currently selected node, click
Include Subnodes .

5. To cancel the display of subnodes, click Include Subnodes again.
6. To display a detailed view in the right-hand window, click Details .

The detailed view displays all the properties specified in the Selected Properties list of
the Customize Current View dialog box. Using the detailed view allows you to view and
sort drawings by several attributes.
7. To display a list view in the right- hand window, click List .

The list view displays only one property for each drawing. You can specify that
descriptor by clicking Customize View; the first item in the Selected Properties list is the
descriptor that appears in the list view.
8. To further manipulate the properties that are available to view in the right-hand window, click
Customize View .
On the Customize Current View dialog box, you can add and remove drawing
properties from the display, and you can change the order that drawing properties appear in.
Because the Open dialog box is similar in nature to the Drawing Manager interface, you
can see Drawing Manager Help for more information.
Recent Drawings Command (File Menu)

Opens one of the drawings that you worked on most recently. The file names are listed near the
bottom of the File menu. You can change the number of files listed on the menu by using the
Tools > Options command.
Access a Recently Open Drawing

1. Click File on the main menu bar.
2. Select the drawing from the list of recently opened drawings.
Switch to Another Open Drawing or View

If you can see a portion of the drawing or view that you want to switch to, click its window. Or, if
you cannot see any portion of the drawing or view, on the Window menu, select the view that
you want to work in from the list. The view then appears on top of other open views.
Properties Command (File Menu)

Opens the File Properties dialog box, which displays general information about the current
drawing. You can review and edit the drawing summary and statistics.

File Properties Dialog Box

Tracks information about the properties of a drawing. Open this dialog box by clicking File >
Properties on the main menu bar.
Summary Tab (on page 92)
Statistics Tab (on page 92)
Units Tab (on page 92)
You must save the drawing before you can access the Statistics and Summary tabs of
the File Properties dialog box.
General Tab
Displays general information about the current document.
Type — Displays the type of document. The type is based on the application used to create the
document.
Location — Displays the directory containing the document.
Size — Displays the size of the document in bytes, kilobytes, and megabytes.
MS-DOS Name — Displays the name of the document as it would appear in a Windows file
naming system.
Created — Displays the date and time that the document was created or copied.
Modified — Displays the date and time that the document was last modified.
Accessed — Displays the date that the document was last opened or copied.
Attributes — Displays the properties of the current document. These settings are read-only.
Read-Only — Indicates that the document is read-only. You cannot open a read-only file for
writing. You cannot create a file with the same name as a read-only file.
Archive — Shows that the document is an archive document.
Hidden — Indicates that the document is a hidden document. You usually cannot see this
document in the Windows.
System — Shows that the document is a system document. You usually cannot see this
document unless you change the view options in Windows Explorer.
If some of the above information is not available, the dialog box displays Unknown.

Summary Tab
Displays the title and author, if available, along with keywords and comments for the current
document. The software generates the author and template information when you create, save,
or print the document. You can edit these properties, with the exception of the template, unless
the document is write-protected.
Title — Specifies the title of the current document.
Subject — Gives a general description of the current document.
Author — Displays the name of the person who created the document.
Keywords — Displays a list of words that identify the document when you browse or search
documents.
Comments — Specifies comments about the current document.
Template — Specifies the current drawing template.
Statistics Tab
Displays detailed information about the current document. The software automatically generates
these properties when you create, save, or print the document.
Created — Displays the date and time the document was created or copied.
Creating Application — Displays the name of the application that created the document.
Modified — Displays the date and time the document was last modified.
Accessed — Displays the date that the document was last opened or copied.
Last Saved By — Displays the name of the person who last saved the document.
Saving Application — Displays the name of the application that most recently saved the
document.
Currently Opened By — Displays the name of the person who has the document open.
Units Tab
Sets up units of measure and precision readout for the length, area, or angle values in a
drawing.
The precision readout sets the number of significant figures to appear. It represents the
accuracy of the unit readout value. The precision setting does not alter the numbers that you
type into a property, only the display of the numbers. Values ending in 5 are rounded up. For
example, if the precision readout is .123 and you draw a line that is 2.1056 inches long, then the
line value length is rounded up to 2.106 inches.
Length Readout — Sets the unit of measure and precision readout for the length values in a
document.
Angle Readout — Sets the unit of measure and precision readout for the angle values in a
document.

Area Readout — Sets the unit of measure and precision readout for the area values in a
document.
 To avoid loss of precision in units when switching between small and large types of a
particular unit, increase the precision, that is, increase decimal places, of the larger unit
through Format Manager.
 When placed on a drawing, all delivered labels that include units of measure use the plant
default formats defined in Options Manager, and so labels do not always display the units of
measure selected in the Properties window. To ensure that a label displays the units of
measure specified in the Properties window, in Catalog Manager, select the desired label,
and from the Format list on the SmartText Editor dialog box, select the As Entered option.
 The software supports round-trip conversion of units without loss of precision. That is, you
can convert centimeters to meters and back and retain the originally entered value of
centimeters with no round-off loss.
View Document Properties

1. Click File > Properties.
2. On the File Properties dialog box, click the tab that contains the information that you want.
You must save the document before you can view the document statistics or summary
information on the Statistics and Summary tabs of the File Properties dialog box.
The File Properties dialog box displays information about the current condition of the
active document. If the document has unsaved changes, you must save the document to update
the property information.
Set Document Properties

1. Click File > Properties.
2. On the File Properties dialog box, set the options that you want, such as summary
information or keywords.
Before you can set or view the document statistics or summary information on the
Statistics and Summary tabs of the File Properties dialog box, you must save the document.
Close Command (File Menu)

Closes the active drawing. The software saves your changes automatically.

Close an Active Drawing

Click File > Close.
Any changes are automatically saved upon closing.
Exit Command (File Menu)

Closes the active drawing and the program. The software checks for unsaved changes when
you close the software. Any changes are automatically saved.
Close the Program

Click File > Exit.
The software saves any changes since the last time you saved your changes.
Saving Drawings
Whenever you save a drawing using File > Save, the software uses the name and folder
location specified in Drawing Manager during drawing creation. If you want to save the drawing
in a format other than .pid, use the Save As or Save as PDF command.
When you open an existing drawing, the software copies the drawing from the disk or network
and displays it on the screen. As you work, the changes that you make to the drawing appear
on your screen. These changes are saved in the database automatically.
If another user modifies an item on an open drawing using automation and you also
modify the same item from SmartPlant P&ID, on saving the drawing, you will receive a message
that you must close and then reopen the drawing. All unsaved changes that you made to the
drawing will be lost.
After you have saved a drawing, it remains displayed on the screen. You can use File > Close
to close the drawing and clear it from your screen, or you can use File > Exit to close the
drawing and quit the software.
Saving Assemblies
You can save a group of items in a drawing as an assembly. Assemblies are saved in a specific
folder specified in Options Manager. You can retrieve assemblies from Catalog Explorer to
place in a drawing.
Saving Drawings in Other Formats

You can save drawings to the following formats using the Save As command:
 MicroStation (*.dgn)
 AutoCAD (*.dwg)

 AutoCAD (*.dxf)
 SmartPlant P&ID uses the ExportLayer.xlsx file to map drawing item types to the layers that
they will be assigned to. Filters are used to define the scope of the item type, for example
'New Equipment'. The file then specifies the layer to which the scoped item type will be
assigned. If a symbol’s item type does not match any of the filter definitions and if that
symbol is in the current drawing layer (Primary, Typical, or both), the symbol is saved in the
Default layer. If a display set is assigned to the drawing and the Color value of filtered or
background items is None, the software ignores the ExportLayer.xlsx file and those items go
to the hidden layer in AutoCAD or MicroStation. If the Color value of filtered or background
items is not None, filtered items go to the layer specified by the filter and background items
go to the default layer unless a filter exists in the ExportLayer.xlsx file for a particular item or
set of items, in which case the settings in the ExportLayer.xlsx file override the display set
settings for those background items.
 You can save drawings as PDF files using the Save as PDF command.
 You can also batch save drawings in other formats in Drawing Manager. For details, see
Save Drawings in Other Formats in the Drawing Manager User's Guide.
Save Command (File Menu)
Stores the active drawing. Plant location and paths are set in SmartPlant Engineering Manager
and Options Manager.
Save a Drawing in a Different Format

1. In Microsoft Excel, open the ExportLayer.xlsx file. The location of this Microsoft Excel
workbook is specified in Options Manager.
2. Assign levels or layers using alphanumeric names to ensure that graphics appear in the
designated levels or layers.
 You can choose more filters for the Filter column of this worksheet from filters in Filter
Manager.
 If you save your drawing to the AutoCAD format, you can name layers with any
combination of alphanumeric characters.
3. Save ExportLayer.xlsx.
In addition to ExportLayer.xlsx definitions, you can also apply a display set to the
drawing to specify the assignment of drawing objects to different layers and their color
assignments. For details, see Notes and table below.
4. Click File > Save As.
5. On the Save As dialog box, select the drive and folder for the new drawing.
6. In the File path box, if desired, edit the name and path for the drawing file, or click Browse
to open the File Name and Path window to navigate to the desired path.

7. From the Save as type list, select the file format that you want to use.
 The value of the Override Layers on Export attribute in the pidacad.ini file affects the
output when saving a file as AutoCAD. If symbols are exported as blocks (when the value of
the Dissolve Symbol to Groups attribute is set to 0), you must specify a value of 2 or 3 for
the Override Layers on Export attribute to ensure that the blocks are exported to the
correct AutoCAD layer. For full details of the Override Layers on Export attribute, see
Configuration File Settings for AutoCAD Translation (on page 97).
 When saving to AutoCAD or MicroStation, the software checks the ExportLayer.xlsx file and
if it finds a reference to a filter that does not exist in the reference data, a Filters Not Found
dialog box is displayed showing a list of missing filters. When you click Exit to dismiss the
dialog box, the save as process stops.
 When saving to AutoCAD or MicroStation using a display set, the software uses the
ExportLayer.xlsx file only for filtering items that do not meet any of the display set filter
criteria and for which the Color value of filtered or background items is not None.
 The dependent behavior of drawing items on the color value of display sets is as follows:
Color Value Effect on Filtered Items Effect on Background Items
Specific color Layer is created with name of Items are mapped according to
display set filter and filtered items go filters in the ExportLayer.xlsx file.
to that layer with the color specified Colors specified by the display set
by the display set filter. If Override filter are ignored for items mapped to
Layers on Export = 2 in the layers that appear in
pidacad.ini or pidmstn.ini file, the ExportLayer.xlsx, and the colors of
color from the seed file overrides the those items are assigned according
display set filter color for the to the Override Layers on Export
particular layer. setting. Items sent to the Default
layer are assigned the background
items color from the display set.
Default Layer is created with name of Items are mapped according to

display set filter and filtered items go filters in the ExportLayer.xlsx file.
to that layer with the default color Color is assigned according to
specified in Options Manager. If Override Layers on Export setting.
Override Layers on Export = 2, the
color from the seed file overrides the
default color for the particular layer.
None Items are sent to the HiddenObjects Items are sent to the HiddenObjects
layer and the ExportLayer.xlsx file layer and the ExportLayer.xlsx file
settings are ignored. settings are ignored.

 When exporting to AutoCAD, extra layers such as ConsistencyChecks, HeatTrace,

HiddenObjects, Labels, and others may be created on your AutoCAD drawing. To delete
one of these layers, you must add a row to the ExportLayer.xlsx file and enter the name of
the layer in the Filter column and the value -9999 in the Layer column as shown:
Configuration File Settings for AutoCAD Translation

The configuration file, pidacad.ini, is used by translators and provides the capability for
customizing the process of translation between the software and an AutoCAD document. The
options shown here should be changed only by experienced users at their own risk.
Options
Name of Setting Description Import Export Default Value Accepted Values
Seed File Name of a seed file used for No Yes pidacad.dwg Filename
export (not mandatory).
Enable Logging If set, a log file will be created Yes Yes 0 0 = Logging is turned
in the directory that the file OFF
was opened from and will
have the same name as the
file that was opened. 1 = Logging is turned
ON

Sets the default units for Yes No 64 59=m; 61=mm;

foreign format. Since .dwg is 62=cm; 63=km;
Read Default Units a unit-less file format, the 64=in; 65=ft; 66=yd;
Read Default Units setting is 67=miles
used to determine the unit
settings.
Template File Sets the document that will be Yes No TransAcad.igr Filename
used as a template when
importing foreign data for (If this file is
setting up hatching and required, it can be
patterns. taken from the
SmartSketch folder)
Symbol Template Sets the symbol file that will Yes No Filename
File be used as a template when
importing foreign data.
Override Layers on Determines which settings No Yes 3 0 – Translation

Export AutoCAD translation honors honors seed file
to include visibility, locks, settings and sends
color, linetype, and lineweight blocks to the Default
for duplicate layers. layer. ByLayer=7 is
needed to display
Any layer specified in the the colors correctly.
seed file will be generated in
the AutoCAD drawing 1 – Translation
regardless of this setting or honors SmartPlant
whether the layer contains P&ID settings and
any objects. sends blocks to the
Default layer.
2 – Translation
honors seed file
settings and sends
blocks to the
specified layer.
ByLayer=7 is needed
to display the colors
correctly.
3 – Translation
honors SmartPlant
P&ID settings and
sends blocks to the
specified layer.
ByLayer Used with Override Layers No Yes 7 7

on Export setting for values 0
and 2.
Ignore Sheet Scale Determines whether to scale Yes No 1 0 = Do not fit the
the sheet to fit the graphics graphics to the sheet
during a translation import.
1 = Fit the graphics

to the sheet

Processing Batch If set, progress bar dialog Yes Yes 1 0 = Progress Bar
Translation boxes do not display during display is turned ON
the translation.
1 = Progress Bar
display is turned
OFF
Attribute Sets Controls the import / export of Yes Yes TranslationSettings String consisting of
attribute information on attribute names
objects during translation. delimited by
semicolons, or the
ALL keyword
Read Block Sets how the blocks imported Yes No Shared Embeds Shared Embeds -
Options from AutoCAD are handled. Preserves blocks
Rigid Groups -
Translates blocks
into groups
Write Version Sets the version of the foreign No Yes 2012 2000; 2002; 2004;
file format that is created on 2005; 2006; 2007;
export. 2008; 2009; 2012
Read Reference Specifies options to process Yes No Translate; Link;

Options reference files during Merge
translation.
Read Default Sets the width to be assigned Yes No 0.25 mm millimeters

Width to all AutoCAD entities that do
not have width or color to
width mapping.
Write Polyline Sets the width to determine No Yes 10.000000

Width Threshold when polylines with width
must be created.
Dissolve Symbol Controls the export of No Yes 0 0 = Symbols are

to Groups SmartSketch symbols to exported as blocks
blocks or to groups of
individual objects.
1 = Symbols are
dissolved into their
individual
components

Export All Displays reference data No Yes 2 0 = All graphic

Graphics to contained in SmartSketch objects are exported
PaperSpace SmartFrames on the to Model space.
AutoCAD PaperSpace sheet SmartFrames with
during a translation export. clipping boundaries
do not display
properly and detail
views are ignored.
1 = All graphic
objects are exported
into the Paper space.
SmartFrames with
clipping boundaries
display properly.
Detail views are
ignored.
2 = All graphic
objects are exported
to Modelspace and
Paper space is
populated so that the
original SmartSketch
sheet is re-created.
Process Multiple Indicates whether to handle Yes No 0 0 = OFF

Orientation in multiple orientations in
Viewports viewports.
1 = ON
Max. Nesting Refers to the depth that Yes No 0 -1 = Process ALL

Depth reference files (inserted via nested reference
the Insert > Object menu files
command) will be processed
for displaying and locating.
This setting does not apply to 0 = Process NO
reference files in foreign data nested reference
files that are translated in via files
the File > Open command or
to reference files in
SmartSketch drawings that
are translated to a foreign n = Process nested
format via the File > Save As reference files up to
command. n levels deep, where
n is an integer
between 1 and 9
Application Text Determines whether text Yes Yes 1 0= Text origin always
Type origin and justification are in upper left corner
preserved.
1= Origin preserved

Single Text Determines the horizontal Yes No 0 0 = Horizontal text

Alignment alignment of text. alignment is set to
Horizontal
Justification
1 = Horizontal text
alignment is set to
Left
Process Non- Determines whether Yes Yes 1 0 = OFF

Displayable non-displayable reference
Reference Files files are translated.
1 = ON
Attributes as Determines whether attributes Yes No 0 0 = Attributes are

Smart Text are created as simple text created as text
boxes or SmartLabels during boxes
translation import.
1 = Attributes are
created as
SmartLabels
AutoCAD Sets the XData to be Yes No ACADASE String consisting of

Extended Data imported. XData names
delimited by semi-
colons
Stroke Reference Determines whether attached No Yes 0 = OFF

reference files are stroked on
export.
1 = ON
Stroke Text Determines whether text is No Yes 0 0 = OFF

stroked on export.
1 = ON
Stroke Dimension If set, the dimension objects No Yes 1 0 = OFF

are stroked on export.
1 = ON
Disk-based Controls whether or not to Yes No 0 0 = Do not leave

Symbols leave symbol files that are symbols on the disk
created for AutoCAD blocks
on the disk when performing a
translation import. 1 = Leave symbols
on the disk

Ignore Controls whether to include Yes Yes 0 0 = Do not include

Non-Displayable non-displayable objects on non-displayable
Symbols import or export. objects
1 = Include
non-displayable
objects
Preserve Layers Controls the export of No Yes 0 0 = Do not translate

on Dissolved elements contained by a objects in symbols
Symbols Symbol whose layer is turned when the objects’
off. If the setting is ON, then layers are not
all objects in a symbol will be displayed
translated whether their layer
display is turned on or not.
This can result in 1 = Translate all
non-WYSIWYG translation. objects in symbols
This setting is relevant only if whether or not layers
the value of the Dissolve are displayed
Symbol to Groups setting is
1.
Push Owner If set to 1, RAD dynamic No Yes 0 = Attributes are

Attributes to its attributes are moved from a NOT created on
Children group (symbol) to its children of owner
members. objects
1 = Attributes are
created
Metafile to Raster Sets the dpi resolution for No Yes 350 dpi resolution (1
DPI Resolution raster metadata during export. through 1200)
Stroking Tolerance Determines the accuracy No Yes 0.1 mm millimeters

used when objects are
stroked during export.
Hatch Supported Supported Hatch complexity No Yes 3 1 (only supports a

Complexity of output format. single independent
hatch line with
dashes and gaps)
Need Hatch If true, then stroke hatch even No Yes 1 0/1

Description and when hatch name and
Stroke description are included in
symbology.
Delete Symbol Controls what happens to the Yes No 1 0 = Do not delete

Definitions symbol definitions after symbol definitions
translation.
1 = Delete symbol
definitions

Process Controls whether to process Yes No 1 0 = Processing

PaperSpace the PaperSpace sheet in an PaperSpace is
AutoCAD file if the file was turned OFF
last saved with a PaperSpace regardless of the last
layout as the active tab. saved space in the
AutoCAD file
This setting has no
effect if the model space tab
was the active tab when the 1 = Processing
AutoCAD file was last saved. PaperSpace is
turned ON
Bigfont Name Name of the AutoCAD font file No Yes Filename

with Asian characters.
Write DXF Controls the number of No Yes 6 1 through 16

Precision decimal places that are used
during a translate DXF export.
Export Internal Controls whether attribute No Yes 1 0 = Do not export

Attributes sets will be exported. This attribute sets
setting takes precedence over
the Attribute Sets setting.
1 = Export attribute
sets
Merge References Controls whether files of type No Yes 2 0 = Save inserted igr,
.igr, .dwg, .dgn, and .dxf that .dwg, .dgn, and .dxf
were inserted into a files as separate
SmartPlant P&ID drawing are .dwg files
merged into the main .dwg file
when saving to AutoCAD.
Inserted Office documents are 1 = Merge inserted
translated to .tiff file format. files using BIND.
Regardless of the setting Creates a duplicate
value, objects with .tiff or .jpg set of styles for each
format are not merged and block reference.
need to be kept in the same
folder as the .dwg file in order
to display correctly.
2 = Merge inserted
files using INSERT.
Creates a single set
Note that for a main drawing of unique styles for
saved as a .dxf file with the main drawing
objects in .tiff format, when and all block
the files are copied to a new references.
location, AutoCAD cannot find
them due to the reference to
an exact location, even if they
are in the same location as
the .dxf file. To rectify this, the
path to the .tiff file needs to be
updated manually in the .dxf
file.

Clipping Boundary Extends the boundary of No Yes 0.1 Numeric values

Growth SmartFrames (including
drawing template borders) by
the quantity shown to avoid
clipping when graphics are on
the boundary. The units of
measure are taken from the
Unit value under Length
readout on the Units tab of
the drawing properties which
are accessed using the File >
Properties command in
SmartPlant P&ID.
Write Linestyles
Many of the default linestyles in your document are pre-mapped to the most equivalent
AutoCAD linestyles. Other linestyles are mapped as continuous. If the _default_ = _stroke_
setting is used, all linestyles are stroked regardless of their mapping. The _default_ = _stroke_
setting is commented out by default to disable it.
The number values are used in the linestyle table to map linestyle definitions in the current
document to AutoCAD line types.
Number Definition
9 CONTINUOUS
10 HIDDEN2
11 DOT2
12 DASHDOT2
13 DIVIDE2
18 CENTER2
19 CENTER
20 PHANTOM2
21 BORDER2
23 CONTINUOUS

The following table shows the Signal Run linestyles as they appear in the software and in
AutoCAD.
Software AutoCAD
Capillary = CAPILLARY
Electric = ELECTRIC
Electric Binary = ELECTRIC_BINARY
Guided = ELECTROMAGNETIC
Electromagnetic
Hydraulic = HYDRAULIC
Connect To Process = CONTINUOUS
Mechanical Link = MECHANICAL_LINK
Pneumatic = PNEUMATIC
Pneumatic Binary = PNEUMATIC_BINARY
Software Link = SOFTWARE_LINK
Data Link = SOFTWARE_LINK
Undefined = UNDEFINED
Unguided = UNGUIDED_ELECTROMAGNETIC
Electromagnetic
_default_ = _stroke_
The following table shows the revision cloud linestyles as they appear in the software and in
AutoCAD.
Software AutoCAD
Cloud Large = CLOUDLARGE
Cloud Small = CLOUDSMALL

Configuration File Settings for MicroStation Translation

The configuration file, pidmstn.ini, is used by translators and provides the capability for
customizing the process of translation between the software and a MicroStation document.
The options shown here should be changed only by experienced users at their own risk.
Options
Seed File The Working Units of the No Yes pidmstn.dgn Filename

seed file that is specified by
this setting determines the
Working Units of the resulting
DGN file. If the Master Units
of the specified seed file are
not a standard recognized
unit, then the Length Readout
Unit of the IGR file (specified
on the File Properties dialog
box) is used for the Master
Units of the resulting DGN
file. If the Length Readout
Unit contains Sub Units, such
as ft – in, the Sub Units will
also be taken from the Length
Readout Unit. If the Length
Readout Unit does not
contain Sub Units, the Sub
Units will be taken from the
specified seed file.
This setting is optional for the
current MicroStation version.
Enable Logging If set, a log file will be created Yes Yes 0 0 = Logging is turned
in the directory that the file OFF
was opened from and will
have the same name as the
file that was opened. 1 = Logging is turned
ON
Read Default Units If the MicroStation file being Yes No 64 59=m; 61=mm;
imported does not have a 62=cm; 63=km;
master unit setting that 64=in; 65=ft; 66=yd;
matches one of the default 67=miles
SmartSketch unit settings,
then this setting is used to
specify the units being
imported. If the MicroStation
file being imported does have
a valid master unit setting that
matches a default
SmartSketch unit setting, then
this setting is ignored.

Template File Sets the document that will be Yes No TransMstn.igr Filename
used as a template when
importing foreign data for (If this file is
setting up hatching and required, it can be
patterns. taken from the
SmartSketch folder)
Symbol Template Sets the symbol file that will Yes No Filename
File be used as a template when
importing foreign data.
Ignore Sheet Scale Determines whether to scale Yes No 1 0 = Do not fit the
the sheet to fit the graphics graphics to the sheet
during a translation import.
1 = Fit the graphics

to the sheet
Processing Batch If set, progress bar dialog Yes Yes 1 0 = Progress Bar
Translation boxes do not display during display is turned ON
the translation.
1 = Progress Bar
display is turned
OFF
Attribute Sets Controls the import / export of Yes Yes TranslationSettings; String consisting of
attribute information on _SymInst attribute names
objects during translation. delimited by
semicolons, or the
ALL keyword
Write Version Sets the version of the foreign No Yes 8.0 7.0; 8.0
file format that is created on
export.
Read Reference Specifies options to process Yes No Translate; Link;

Options reference files during Merge
translation.
Write Polyline Sets the width to determine No Yes 10.000000

Width Threshold when polylines with width
must be created.

Dissolve Symbol Controls the export of No Yes 0 0 = Symbols are

to Groups SmartSketch symbols to cells exported as shared
or to groups of individual cells
objects.
1 = Symbols are
exported as type 2
cells to control the
graphics level
To
implement this
behavior, you must
also assign to the
Attribute Sets
option the value
'TranslationSettings;
_SymInst'; otherwise,
when the value of
Dissolve Symbol to
Groups is set to 1,
symbols are
exported as
individual objects
Override Overrides the background No Yes 1 0 = Override is

Background Color color specified in the turned OFF
MicroStation seed file during
a translation export, by using
the SmartSketch sheet color. 1 = Override is
turned ON
Process Multiple Indicates whether to handle Yes No 0 0 = OFF

Orientation in multiple orientations in
Viewports viewports.
1 = ON
Max. Nesting Refers to the depth that Yes No 0 -1 = Process ALL

Depth reference files (inserted via nested reference
the Insert > Object menu files
command) will be processed
for displaying and locating.
This setting does not apply to 0 = Process NO
reference files in foreign data nested reference
files that are translated in via files
the File > Open command or
to reference files in
SmartSketch drawings that
are translated to a foreign n = Process nested
format via the File > Save As reference files up to
command. n levels deep, where
n is an integer
between 1 and 9

Application Text Determines whether text Yes Yes 1 0= Text origin always
Type origin and justification are in upper left corner
preserved.
1= Origin preserved
Single Text Determines the horizontal Yes No 0 0 = Horizontal text

Alignment alignment of text. alignment is set to
Horizontal
Justification
1 = Horizontal text
alignment is set to
Left
Process Non- Determines whether Yes Yes 1 0 = OFF

Displayable non-displayable reference
Reference Files files are translated.
1 = ON
Process Determines whether elements Yes No 0 0 = Do not translate

Construction on a MicroStation elements
Elements construction layer are
translated.
1 = Translate
elements
Attributes as Determines whether attributes Yes No 0 0 = Attributes are

Smart Text are created as simple text created as text
boxes or SmartLabels during boxes
translation import.
1 = Attributes are
created as
SmartLabels
Stroke Reference Determines whether attached No Yes 0 = OFF

reference files are stroked on
export.
1 = ON
Stroke Text Determines whether text is No Yes 0 0 = OFF

stroked on export.
1 = ON
Stroke Dimension If set, the dimension objects No Yes 1 0 = OFF

are stroked on export.
1 = ON

Disk-based Controls whether or not to Yes No 0 0 = Do not leave

Symbols leave symbol files that are symbols on the disk
created for MicroStation cells
on the disk when performing a
translation import. 1 = Leave symbols
on the disk
Ignore Controls whether to include Yes Yes 0 0 = Do not include

Non-Displayable non-displayable objects on non-displayable
Symbols import or export. objects
1 = Include
non-displayable
objects
Preserve Layers Controls the export of No Yes 0 0 = Do not translate

on Dissolved elements contained by a objects in symbols
Symbols Symbol whose layer is turned when the objects’
off. If the setting is ON, then layers are not
all objects in a symbol will be displayed
translated whether their layer
display is turned on or not.
This can result in 1 = Translate all
non-WYSIWYG translation. objects in symbols
This setting is relevant only if whether or not layers
the value of the Dissolve are displayed
Symbols to Group setting is
1.
Preserve MSTN Determines whether to No Yes 0 = User-defined

UDLS Styles preserve user-defined linestyles are stroked
linestyles.
1 = User-defined
linestyles are
preserved
Push Owner If set to 1, RAD dynamic No Yes 0 = Attributes are

Attributes to its attributes are moved from a NOT created on
Children group (symbol) to its children of owner
members. objects
1 = Attributes are
created
Metafile to Raster Sets the dpi resolution for No Yes 350 dpi resolution (1
DPI Resolution raster metadata during export. through 1200)
Stroking Tolerance Determines the accuracy No Yes 0.1 mm millimeters

used when objects are
stroked during export.

Hatch Supported Supported Hatch complexity No Yes 3 1 (only supports a

Complexity of output format. single independent
hatch line with
dashes and gaps)
Need Hatch If true, then stroke hatch even No Yes 1 0/1

Description and when hatch name and
Stroke description are included in
symbology.
Delete Symbol Controls what happens to the Yes No 1 0 = Do not delete

Definitions symbol definitions after symbol definitions
translation.
1 = Delete symbol
definitions
Export Internal Controls whether attribute No Yes 1 0 = Do not export

Attributes sets will be exported. This attribute sets
setting takes precedence over
the Attribute Sets setting.
1 = Export attribute
sets
Read Cell Options Sets how the shared (type Yes No Shared Embeds Shared Embeds -
34/35) cells imported from Preserves shared
MicroStation are handled. cells
Rigid Groups -
Translates shared
cells into groups
Sub Units Per Sets the values to determine Yes No 10 Numeric

Master Units the size of units for a
MicroStation cell.
Pos Units Per Sub Sets the values to determine Yes No 1000 Numeric
Units the size of units for a
MicroStation cell file
Always Shift GO to Controls whether to set the No Yes 0 0 = Do NOT shift the
Center Drawing Global Origin of .dgn files in Global Origin of the
case the drawing objects fall resulting .dgn file
outside the maximum design
plane as defined by
MicroStation. 1 = Shift the Global
Origin of the
resulting .dgn file
EDF as Smart Text Determines whether the Yes No 0 0 = Tags are created
values of tags are created as as text boxes
simple text boxes or as
SmartLabels during
translation import. 1 = Tags are created
as SmartLabels

Write Linestyles
The default linestyles in your document are pre-mapped to the most equivalent MicroStation
linestyles. Linestyles other than the default linestyles or any complex linestyles containing
shapes are mapped to continuous unless they are specifically mapped on the Linestyle tab.
Linestyles that are not mapped on export are stroked to give them a more correct appearance.
The default length of the stroking line is 0.1 millimeters (mm).
The number values are used in the linestyle table to map linestyle definitions in the current
document to MicroStation line types.
Number Definition
9 0
10 2
11 1
12 4
13 6
18 7
20 6
The following table shows the Signal Run linestyles as they appear in the software and in
MicroStation.
Software MicroStation
Capillary = Capillary
Electric = Electric
Electric Binary = Electric_binary
Guided = Guided Electromag/Sonic

electromag/sonic
Hydraulic = Hydraulic
Connect To Process = Connect To Process
Mechanical Link = Mechanical Link
Pneumatic = Pneumatic
Pneumatic Binary = Pneumatic Binary

Software Link = Software Link
Undefined = Undefined
Unguided = Electromag/Sonic
Electromagnetic
_default_ = _stroke_
The following table shows the revision cloud linestyles as they appear in the software and in
MicroStation.
Cloud Large = CLOUDLARGE
Cloud Small = CLOUDSMALL
In addition to the above mapping, the PIDLineStylesV8.rsc file, delivered with SmartPlant P&ID,
must be copied to the MicroStation installation folder:
C:\ProgramData\Bentley\WorkSpace\System\Symb.
The following table shows the Tracing Media linestyles as they appear in the software and in
MicroStation.
NT = NT
E = E
FA = FA
FB = FB
FC = FC
I = I
MI = MI
SKE = SKE
SH = SH
SL = SL
SM SM

SN = SN
SS = SS
ST = ST
Save As Command (File Menu)

Opens the Save As dialog box. You can save the active document to a new format.
When using AutoCAD, your parametric symbols should not be scaled. The graphics will
display incorrectly.
Save As Dialog Box

Allows you to save the active drawing in a specified file format.
Save options
File path — Allows you to type or edit the file path and name.
You can also click Browse to open the File Name and Path window to navigate to the
desired path where you want to save the drawing.
Save as type — Allows you to select a file format for the drawing you want to save. The
following formats are available:
 AutoCAD (*.dwg and *.dxf)
 MicroStation (*.dgn)
Save a Drawing as a PDF File

1. Click File > Save as PDF.
2. On the Save as PDF dialog box, specify the resolution, color mode, JPEG compression,
and whether or not to include inconsistency markers in the output.
3. Beside the File path box, click the ellipsis button to navigate to the folder where you
want to save the PDF file and type a name for the file.
Save as PDF Command (File Menu)

Opens the Save as PDF dialog box to allow you to define the output settings and the file name
and path for the current drawing in order to save it as a .pdf file.

Save as PDF Dialog Box

Allows you to define the output settings and the file name and path for P&IDs that you save as
PDF files.
Resolution — Modifies the dots per inch, or "dpi". The greater the dpi, the better the clarity.
Increasing the resolution setting increases the file size and can slightly increase the time
required to process some files.
Color options
Color — Creates a PDF using the colors available in the document. You can only create a color
PDF from a color drawing sheet.
Grayscale — Creates a PDF using a 256-color grayscale.
Pure black and white — Creates a PDF that has no color or grayscale. Anything that is not
pure white is drawn as black.
JPEG compression — Compresses images embedded in your document according to the
compression level you define. If your drawing contains a lot of images, compression settings are
very important for achieving good image quality at a manageable file size. Use the pull-down
menu to set the compression level. Compression levels in the High quality range do not
noticeably affect image quality, and produce larger file sizes than settings in the Low quality
range. However, using a mid-range compression level usually strikes the best balance in
creating a compact file while still maintaining enough information to product high-quality images.
Include inconsistency markers — When selected, includes inconsistency symbols that appear
on the drawing in the PDF output.
File path — Allows you to define the name and path for the PDF file.
Re-creating Drawings
SmartPlant P&ID continually updates the database as you edit a drawing; however, the drawing
file is not updated until you actually save the file (that is, when you click File > Save or when you
exit SmartPlant P&ID). Occasionally, the software may terminate abnormally due to power
outages and so forth. As a result, the database is up-to-date with changes that you posted to
the drawing, but the drawing file reflects the status when you last saved the drawing. When
you re-open the drawing, the software recognizes that the drawing file is different from the
database.
The software displays a message box that states: 'One or more items in this drawing are
inconsistent with the database. Click OK to re-create the drawing from the database.'
During the re-create process, the status bar at the bottom of the main window keeps you
informed about the particular elements currently reconciling with the database. Also, a log file,
Recreate-DrawingName.log, is created in your Temp folder. You can check this file for
irregularities that occur during the re-create process.

Do not interfere with the re-create process once started because the drawing can
become unusable.
 For best system performance, close all other applications except for SmartPlant P&ID when
running the re-create process.
 During the re-create process the status bar at the bottom of the P&ID window displays
updates about the particular elements currently being reconciled with the database. You can
check the log file, Recreate[Drawing#].log, located in the Temp directory, for any problems
that may have occurred during the re-create process.
 If your reference data has changed, use the Update Drawings functionality to incorporate
those changes into your existing drawings. For more information, see the SmartPlant P&ID
Drawing Manager User's Guide.
After the re-create process finishes, SmartPlant P&ID reinitializes the drawing and displays the
message 'Re-create drawing is complete'. Review the re-created drawing and resolve any
errors that occurred.
Error Conditions
If a section of the drawing could not re-create successfully, an error condition appears on the
drawing as a heavy line segment that is highlighted orange by default. Error conditions are
almost always associated with a pipe or signal run and must be resolved manually.
In SmartPlant Engineering, it is not possible to resolve such error conditions.

Orphaned Drawing Symbols and Band-Aiding

An orphaned drawing symbol is a symbol for which no properties appear in the Properties
window when the symbol is selected. This occurs because the symbol is missing from the
database. On opening a drawing which is in a re-create state and contains orphaned symbols,
the following message appears:
Clicking OK will automatically delete orphaned symbols in the drawing. To band aid the
symbols, click Cancel. The next time you open the drawing, the message will appear again and
the symbols will be band-aided, Band-aided symbols are indicated by heavy orange lines.
It is not possible simply to delete orphaned symbols manually from a drawing.
Re-create a Drawing
1. Open the drawing that you want to re-create.
2. Set a heat trace medium for an item in the drawing.
3. Right-click an empty space on your Windows taskbar, and then click Task Manager.
4. Click the Processes tab.

5. In the list, click draft.exe.

6. Click End Process.
7. In SmartPlant P&ID, open the drawing that you opened in step 1.
8. When the software prompts you that a re-create is necessary, click OK to re-create the
drawing from the database.
9. Remove the heat trace medium that you set in step 2.
10. Save the drawing.
 Normally SmartPlant P&ID re-creates drawings automatically when it detects a discrepancy

between the drawing and the database.
 For more information about re-creating drawings, see the Re-creating Drawings section in
the SmartPlant P&ID Installation and Upgrade Guide.
Using Filters
You can use filters in many ways throughout the software and its stand-alone applications and
utilities.
You can use filters when you create report templates to display particular items on a report. You
can use filters in Rule Manager to define how items interact within a view. You can associate
filters with the source or target properties in rules. You can also use filters to find items.
You can create filters to control the display of hierarchy items in Drawing Manager. These filters
are not saved to any folder in Filter Manager, but the methods of creating these filters are the
same as those for creating filters saved in Filter Manager.
If you are using a Workshare environment and you are at a satellite site, do not create
Project Filters at a satellite site. However, you can always create My Filters in the Filter Manager
or Select Filter dialog box environment.

SECTION 4
Working with P&IDs in SmartPlant P&ID

Engineering
With SmartPlant® P&ID, you can easily perform the tasks required to create a detailed plant
model. SmartPlant P&ID provides multiple views of a central, unified data structure that
represents the plant model. The plant model is the computer representation of the conceptual
design in its entirety, including all plant components and their relationships. By manipulating
model views, you can organize the information within the plant model to better understand and
maintain the data. A view is a visual presentation of the data that composes the plant model. A
view can be a schematic drawing, a table, or a report.
In the Properties window, you can add values for various properties of each item.
As you work on your drawing, you can monitor any inconsistencies in your design by reviewing
the inconsistency indicators. These indicators appear in your drawing as soon as an
inconsistency occurs in the design. You can resolve inconsistencies using solutions from the
Consistency Check dialog box.
Additionally, you can generate reports to help you keep track of information in the drawing. For
example, after you finish the drawing, you can generate order lists for the components in the
drawing. You can print the drawing, if necessary.
Understanding Database Constraints

The following database constraints improve the integrity of the data associated with your design.
 Foreign Key — Insures that the corresponding value, unless it is null, exists in the table
referenced by the foreign key. This type of constraint is used to enforce logical relationships,
such as the plant item to plant group relationship.
 Foreign Key in conjunction with Not Null — Enforces group relationships, such as the case
to model item relationship. This constraint is similar to the Foreign Key constraint described
above, but does not allow null values to persist.
 Foreign Key with Not Null and Unique — Enforce all subclass and one-to-one
relationships, such as the pairing of OPCs. This constraint is similar to the Foreign Key
constraint described above, but does not allow null values to persist and requires that all
values be unique.
The constraints so far described serve to enforce relationship integrity. Since the relationship,
the object and the foreign key it points to, already exists in the database or is created during
your transaction, the constraints are satisfied without changing the scope of your transaction.
 Check — Used for more complex data integrity controls, such as monitoring conditions on
multiple items. For example, History records can pertain to either a drawing or the model.
Either of these objects can be null, but not both of them. A Check constraint enforces this
condition by using comparisons and exclusions. Another candidate for a Check constraint is
the enforcement of certain values for one or more items. For example, invalid null or zeros
assigned to properties are tested against Check constraints.

Working with P&IDs in SmartPlant P&ID Engineering
Selecting Drawing Items

To select an item, you can use the Select Tool on the main toolbar. You can select pipe routes,
equipment, valves, labels, and so forth, and you can select item groups or assemblies.
Selecting Single Items

To select an item, click the Select Tool on the main toolbar. When you click the Select
Tool, the pointer changes to an arrow with a locate zone indicator at the end: . As you pause
on items in a drawing, the items appear in the highlight color. When an item is highlighted, click
to select it.
When you select an individual item, the item changes to the selection color. You can change the
selection color with the Tools > Options command.
You can also select drawing items by first selecting them in the Engineering Data Editor. The
corresponding items are selected in the Drawing view if they reside in the active drawing.
Selecting Multiple Items

You can select more than one item at a time by clicking Select Tool and then holding CTRL
or SHIFT as you click the items that you want to select. Additionally, you can click the Select
Tool and then drag to fence items.
When you select multiple items or grouped items, the items change to the selection color.
You can use the Select Tool Ribbon (on page 121) to choose if you want to select only items
completely enclosed by the fence or any item that is partly enclosed by the fence.
You can also use the Polygon Fence Locate tool to create a polygon shaped fence to
select multiple items.
If you select multiple items in the Engineering Data Editor, these items are also selected in the
active drawing, if they reside there. You construct a select set using the Engineering Data
Editor in this way.
Whenever you have constructed a select set, you can choose single items from that set by using
the Selected Items list at the top of the Properties window. A single item chosen in a select set
this way is highlighted in a different color in the Drawing view.
Canceling the Selection of Items

To cancel the selection of an item or group of items, click any empty point on the drawing.

Select Tool Command

Changes the pointer to the arrow-shaped selection pointer so you can select, modify, and
manipulate items. The circle at the end of the pointer arrow is the locate zone. While the Select
Tool is active, the Select Tool ribbon (on page 121) is displayed.
Select Tool Ribbon
The Select Tool Ribbon appears when nothing is selected. After you select an item, the Select
Tool ribbon is replaced with a ribbon for editing the selected item.
Inside — Specifies that items inside the fence are selected.
Overlapping — Specifies that items both overlapped by the fence and inside the fence are
selected.
Top Down — Specifies that symbols are recognized in the locate zone as opposed to individual
elements in a symbol.
Bottom Up — Specifies that individual elements, which make up symbols, are recognized in the
locate zone as opposed to the whole symbol.
To find out the name of an option on the ribbon, pause the pointer over an option and
read the ToolTip.
Polygon Fence Locate Command

Creates a select set by drawing a rectangular or polygonal fence around objects based on
points that you define.
Click to place the first point, click the remaining points to define the rectangle or polygon. Points
are placed when you release the mouse button. Right-click to end the fence. When the
Polygon Fence tool is active, the Polygon Fence ribbon is displayed.
See Also
Polygon Fence Ribbon (on page 121)
Polygon Fence Ribbon
Rectangle — Creates a select area, or fence, by drawing a rectangle around points that you
define. When you drag the mouse to define a rectangular fence, a dashed rectangular outline
dynamically appears as you drag. When you reach the desired size, release the mouse button
to create the fence. The dashed fence outline disappears and the elements are selected.
Polygon — Creates a select area, or fence, by drawing a polygon around points that you
define. Click to place the first point, click the remaining points to define the polygon. Points are
placed when you release the mouse button. Right-click to end the polygon. The dotted outline
disappears and the elements are selected.

Inside — Specifies that elements inside the fence are selected.
Overlapping — Specifies that elements overlapped by the fence are selected, as well as
elements inside the fence.
Top Down — Specifies that groups of elements are located as opposed to individual
elements in a group.
Bottom Up — Specifies that individual elements in a group are located as opposed to the
whole group.
Locate Filter — Opens the Define Locate Filter (see "Define Locate Filter Dialog Box" on
page 124) dialog box where you can specify a filter for the selection of specific drawing
elements. Filters allow you to select specific types of drawing elements, or all drawing elements.
See Also
Polygon Fence Locate Command (on page 121)
Configuration (QuickPick) Tool

You can use QuickPick to select closely-associated items, such as check valves or flow arrows
or other inline items.
Select an Item
1. On the main toolbar, click the Select Tool .
2. Do one of the following:
 To select one item, click it.
 To select more than one item, hold CTRL or SHIFT and click each item.
 To select more than one item at once, drag to fence the objects.
 To select one of several overlapping items, use QuickPick. For more information, see
Select an Item Using the Configuration (QuickPick) Tool (on page 123).
3. To clear the selection of an item or items, do one of the following:
 Click in an empty portion of the drawing.
 Right-click in an empty portion of the drawing.
 Select another item without holding CTRL or SHIFT.
 To clear the selection of one item and leave other items selected, click the item while
holding CTRL or SHIFT.
 When the Select Tool is active, selectable items are highlighted as you pass the pointer
over them. When the item you want to select is highlighted, click to select it.

 Click Tools > Options to change the item highlight and selection colors and locate and
break-away tolerances.
 To select all items in a drawing, right-click a blank area in the drawing and click Select All
on the shortcut menu, or, to accomplish the same thing, press CTRL + A or click Edit >
Select All.
 You can also select items in the Engineering Data Editor. If they reside in the active
drawing, they are selected in the Engineering Data Editor. You can build up a select set
using this method, too.
Select an Item Using the Configuration (QuickPick) Tool

1. Pause the pointer over the item you want to select.
When the pointer appears with ellipses, as illustrated below, click.
2. On the QuickPick tool, which appears near the pointer, move the pointer over the numbered
buttons, without clicking, to highlight the corresponding items.
3. The first item is highlighted.
4. The second item is highlighted.

5. When the item you want to select is highlighted, click the corresponding button on the
QuickPick tool.
QuickPick helps you to select items that overlap each other.

Select a Polygon-Shaped Area of a Drawing

1. Click the Polygon Fence Locate command .
2. On your drawing, click to place the start point of the polygon fence.
3. Move the cursor and click to define further points of the area you want to select. As you
move the cursor a dashed line shows the area selected.
4. Right-click to finish selection, the dashed line disappears and the selected items are
highlighted.
See Also
Polygon Fence Ribbon (on page 121)
Polygon Fence Locate Command (on page 121)
Define Locate Filter Dialog Box

Specifies a Locate Filter to use to assist in selection of objects in the drawing. Click Locate
Filter on the SmartSelect toolbar to display this dialog box. The dialog box provides a list
of locate filters that, upon selection, can be applied to certain selected elements in the drawing.
For a SmartPlant P&ID drawing, only the following elements are supported for filtering:
 All
 Connector
 SmartFrame
 Symbol
 SmartSymbol (selects the labels in the Polygon Fence selected area)
This command is inactive if filtering has been turned off. Use the Turn Filtering On/Off
command on the SmartSelect ribbon to enable and disable the use of filters during element
selection.
Assigning Heat Tracing and Jacketing

In SmartPlant P&ID, you can assign heat tracing to pipe runs and to certain other plant items.
The following types of heat tracing can be assigned:
 Single heat trace
 Double heat trace
 Jacketed heat trace
The general workflow for making heat trace definitions is as follows:
1. Define heat trace media in Data Dictionary Manager by adding entries to the Heat Trace
Medium select list.
2. Define the line style of each heat trace medium on the Options Manager Tracing tab.
3. Define the type of heat tracing on the Options Manager Settings tab by doing one of the
following:

 For a single heat trace, ensure that the heat trace medium does not appear beside Heat
Tracing Media - Double Heat Trace or Heat Tracing Media - Jacketed Pipe.
 For a double heat trace, assign the heat trace medium to Heat Tracing Media - Double
Heat Trace.
 For a jacketed heat trace, assign the heat trace medium to Heat Tracing Media -
Jacketed Pipe.
The implementation and positioning of heat trace or jacketing graphics depends on the heat
tracing type and whether the heat tracing is applied to a pipe run or some other item type. The
following table summarizes the behavior.
Type of Heat Tracing Behavior when Applied to Pipe Run Behavior when Applied to Other
Item Types
Single As defined by the selected default Displays graphics from the Heat
placement on the Options Manager Trace layer of the symbol defined in
Tracing tab. Catalog Manager.
Double Heat tracing is placed on both sides of Displays graphics from the Heat
the pipe run. Trace layer of the symbol defined in
Catalog Manager (same appearance
as for single heat trace).
Jacketed Heat tracing is placed on both sides of Displays graphics from the Jacket
the pipe run. layer of the symbol defined in
Catalog Manager.
 If, in Catalog Manager, no graphics are defined on the Heat Trace layer of a symbol, no
heat trace will be displayed for the symbol in the drawing if a single or double heat trace is
assigned and the item type of the symbol is anything other than Pipe Run.
 If, in Catalog Manager, no graphics are defined on the Jacket layer of a symbol, no heat
trace will be displayed for the symbol in the drawing if a jacketed heat trace is assigned and
the item type of the symbol is anything other than Pipe Run.
 If, in Catalog Manager, the item type of the symbol is Pipe Run, any graphics defined on the
Heat Trace or Jacket layers are ignored.
 In the drawing, the heat tracing line style of the selected heat trace medium for all item types
is determined by the definition made on the Options Manager Tracing tab.
 If a heat tracing medium that has been designated as jacketed is assigned to a pipe run in
SmartPlant P&ID, additional jacketed properties are displayed in the Properties window
under the Piping Jacket category for that pipe run. If the heat trace medium is removed
from the pipe run or is changed to something other than a jacketed heat trace, the Piping
Jacket category and the associated properties are no longer displayed, and any values
assigned to those properties are removed. In Data Dictionary Manager, you can add more
jacketed properties if you desire.
 In Insulation Manager, you can define a heat trace medium to automatically be assigned
with a particular insulation spec for a pipe run or equipment. Only the defined heat trace
medium can be used in combination with that insulation spec. You can also choose one of
the following options:
 Undefined — No heat trace can be used if that particular insulation spec is assigned.

 Ignore — Any heat trace can be used with that specified insulation spec.
Create a New Heat Tracing Medium

1. In Data Dictionary Manager, do the following:
a. Click Select Entry.
b. From Selected list, select Heat Trace Medium.
c. On the last row, enter information in the Value and Short Value columns.
d. Click Save .
Refer to the Modify a Select List Entry topic in Data Dictionary Manager Help for more
details about modifying a select list.
2. After adding the new entry in the select list, open Options Manager and click Tracing
.
The new heat tracing medium will now be displayed in the Tracing Media list.
3. From the Tracing Media list, locate the new media and click the Style box.
4. Select a new heat tracing style from the list.
5. Click Save .
 To designate a particular heat tracing medium as a double heat trace or jacketed heat trace,
in Options Manager, click Settings and add the heat tracing media to one of the
following:
 Add heat tracing media designated as double to the Heat Tracing Media - Double Heat
Trace row, with each value separated by a comma.
 Add heat tracing media designated as jacketed to the Heat Tracing Media - Jacketed
Pipe row, with each value separated by a comma.
 Any changes made to a heat trace medium in Options Manager will not be reflected in any
drawing in which that heat trace medium was already assigned to an item. For changes to
be reflected in the drawings, you must run the Update Drawings command first. For
details, see the Update Drawings Command topic in the Drawing Manager User's Guide.

Define Heat Tracing Graphics for an Item

1. Open Catalog Manager.
2. In Catalog Explorer, find the item (for example, equipment) for which you want to define heat
tracing.
3. Double-click the item to open the symbol, as shown in the example.
4. In the View window, click the Graphics layer, then while holding down the CTRL key, click
the Heat Trace layer.
This action makes both layers visible at once.
5. Using the drawing tools, draw the heat trace around the symbol.

To display the Heat Trace layer only, click any layer other than the Graphics or Heat
Trace layer, then click the Heat Trace layer.
6. Click Save.
The actual style of the heat tracing graphics displayed in the drawing depends on the line
style chosen for the specified heat trace medium in Options Manager. For details, see Create a
New Heat Tracing Medium (on page 126).
Modify the Offset Distance of Heat Trace Lines

The heat trace line offset is modified by setting the offset value in the line style properties for an
individual heat trace. The offset value has to be modified for every heat trace line style for which
the offset change is required. The workflow is as follows:
1. Creation of a new symbol in Catalog Manager to be used to edit the line style and import the
changes back into the ProjectStyles.spp file.
2. Referencing the ProjectStyles.spp file.
3. Importing line styles to be edited from the ProjectStyles.spp file into the symbol file and
setting the offset to the desired value using Line Style Editor.
4. Importing the updated line style from the symbol file back into the ProjectStyles.spp file in
Options Manager.
5. Updating drawings in Drawing Manager.
Symbol Creation and Line Style Definition

As part of the line style definition, you set the value of the offset distance.
1. Open Catalog Manager and create a new symbol.
2. Assign a meaningful name to the symbol, for example: HT_offset_modifier.sym.
3. Display the Line Style Editor.
4. Reference the ProjectStyles.spp file as follows:
a. Click Format > Style.
b. On the Style dialog box, click Resources.

c. On the Style Resources dialog box, click Add.

d. In the Add Style Resource window, browse to the active plant’s P&ID Reference Data
folder and in the File name field, type ProjectStyles.spp.
e. Click Open.
f. On the Style Resources dialog box, click OK.
g. On the Style dialog box, click Close.
5. In the Line Style Editor, expand the Linear Styles node.

6. Right-click on the heat trace line style that you want to modify (for example, Electric Heat
Trace) and on the shortcut menu, click Import Style.
The line style name becomes bold, indicating that it has been imported into the
symbol.

7. Right-click again on the style and on the shortcut menu, click Properties.
8. On the Linear Style Properties dialog box, in the Offset field, enter the desired offset
value.
The base offset value for heat trace lines is 0.05 in, therefore the actual offset value will
be 0.05 in + the value entered in the Offset field.
9. From the Crossover orientation list, select a value that matches one of the Options
Manager Tracing options, such as Top right.
10. Save the file in Catalog Manager and exit.
Import the Line Style Changes back into the ProjectStyles.spp File Using Options Manager
1. Open Options Manager and click Tools > Linear Styles.
2. On the Linear Styles dialog box, click Import.
3. In the Import Linear Styles From window, browse to and select the symbol with the
updated linear styles.
4. Click Open.

5. On the Linear Styles dialog box, click Close.

6. Save the changes and exit Options Manager.
Update Drawings
1. Open Drawing Manager and select existing drawings that you want to update with the new
heat trace style.
2. Click File > Out-of-Date Drawings > Update.
 Unlike the default offset distance, a user-defined additional heat trace offset distance will not
change dynamically as the zoom level changes in the SmartPlant P&ID drawing view. It is
recommended to turn on the Display as printed option (Tools > Options > General) in
SmartPlant P&ID to get a consistent look for the offset. This limitation will not affect the
print-out results of the SmartPlant P&ID drawings.
 This procedure has no impact on the heat trace line offset in translation output files (.dwg /
.dxf / .dgn) created by the SmartPlant P&ID Save As feature.
Assign Heat Tracing to an Item

1. Select the pipe run, piping component, equipment, equipment component, nozzle, or
instrument for which you want to specify heat tracing.
2. In the Properties window, specify values for the HT Medium, HT Medium Temp, and HT
Requirement properties.
 If you have already specified insulation properties for the item, you cannot subsequently
assign heat tracing properties unless the default heat trace medium was set to Ignore for
the specified insulation spec.
 If you assign heat tracing to an item before you assign insulation properties, your choices of
insulation properties and specifications are restricted.
 The HT Medium and HT Requirement properties are available from select lists. When you
type the temperature value for the HT Medium Temp property, the software associates the
default unit of measure with the value unless you specify a different unit of measure. Select
list values are defined in Data Dictionary Manager; Format Manager contains definitions for
temperature units.
 The location of the heat tracing graphics for piping components, equipment, equipment
components, nozzles, or instruments is determined using the Heat Trace layer in Catalog
Manager.
 In Options Manager, you can define the heat trace symbology and if desired, you can
specify whether a particular heat trace medium is defined as a single or a double heat trace.
This affects the way the symbology is applied, as shown in the following examples.

Pipe run, valve and nozzle with single heat trace medium:
Pipe run, valve and nozzle with double heat trace medium:
Note that the double heat trace definition affects the symbology of the pipe run only.
See Also
Define Heat Tracing Graphics for an Item (on page 127)
Modify the Offset Distance of Heat Trace Lines (on page 128)
Assign a Jacketed Heat Trace to an Item (on page 136)
Define Heat Trace Media as Pipe Jacketing

This procedure describes how to define heat trace media as pipe jacketing before assigning it to
a pipe run. All of the changes are made in Options Manager.
1. Click Settings .
2. Add the desired heat tracing media to the Heat Tracing Media - Jacketed Pipe row, with
each value separated by a comma.
3. Click Tracing .
4. From the Tracing Media list, locate one of the media defined as a jacketed pipe and click
the Style box.
5. Select a new heat tracing style from the list if one has not already been defined or if a
different style is desired.
6. Define styles as desired for the other jacketed pipe media.
7. Click Save .
8. To define standard pipe jacket nominal diameters, do the following:
a. Click Tools > Pipe Jacket Nominal Diameter.
b. On the Pipe Jacket Nominal Diameter dialog box, click Add Row.
c. In the Core NPD column, select a nominal pipe diameter value for the core pipe.
d. In the Jacket NPD Min column and as many of the succeeding columns (Jacket NPD
2, Jacket NPD 3, and so forth), select nominal diameter values for the pipe jacket.
The values in these columns must always be greater than the corresponding
core pipe value.

e. Continue to enter core pipe and jacket diameters until you have all the values that you
need.
f. Click Save and then click Close.
Define Jacketing Graphics for an Item

1. Open Catalog Manager.
2. In Catalog Explorer, find the item (for example, equipment) for which you want to define
jacketing.
3. Double-click the item to display its symbol, as shown in the example.
4. In the View window, click the Graphics layer, then while holding down the CTRL key, click
the Jacket layer.
This action makes both layers visible at once.
5. Using the drawing tools, draw the jacket around the symbol.

To display the Jacket layer only, click any layer other than the Graphics or Jacket
layer, then click the Jacket layer.
6. Click Save.
The actual style of the jacketing graphics displayed in the drawing depends on the line
style chosen for the specified heat trace medium in Options Manager. For details of how to
define the jacket style and to designate a heat trace medium as a pipe jacket, see Create a New
Heat Tracing Medium (on page 126).
Create a New Jacketed Property for Pipe Runs

Jacketed properties are those properties that appear under the Piping Jacket category.
Jacketed properties that come shipped with the software have the J_ prefix; however, you can
also create new jacketed properties if desired.
1. In Data Dictionary Manager, on the Database Tables tab, select Pipe Run.
2. Click Edit > Add Property.
3. On the Add Property dialog box, enter all the desired information.
For the Display Name value, you may want to use the J_ prefix or some other
identifier to identify the property as jacketed.
4. Beside Category, select Piping Jacket from the list.
5. Click OK to close the Add Property dialog box.
6. On the toolbar, click Save .

For a pipe run, the Piping Jacket category and all properties created under the Piping
Jacket category are only displayed in the Properties window when a Jacketed heat tracing
value is assigned to the item in the Properties window.

Assign a Jacketed Heat Trace to an Item

1. Select the pipe run, piping component, equipment, equipment component, nozzle, or
instrument that you want to specify as being jacketed.
2. In the Properties window, select a value for the HT Medium that is defined as jacketing.
3. Select values for the HT Medium Temp and HT Requirement properties.
4. For a pipe run, if desired, enter values for the piping jacket properties, which begin with J_.
 For a pipe run, if you have already specified insulation properties, you cannot subsequently
assign jacketed pipe properties unless the default heat trace medium was set to Ignore for
the specified insulation spec.
 If you define a pipe run as jacketed, you can no longer assign values for regular insulation
properties and specifications. If you desire to specify insulation property values for the
jacketed pipe, you must assign those values using the properties that have the J_ prefix,
which apply only to a jacketed pipe run.
 The HT Medium and HT Requirement properties are available from select lists. When you
type the temperature value for the HT Medium Temp property, the software associates the
default unit of measure with the value unless you specify a different unit of measure. Select
list values are defined in Data Dictionary Manager; Format Manager contains definitions for
temperature units.
 The location of the jacketed graphics for piping components, equipment, equipment
components, nozzles, or instruments is determined using the Jacket layer in Catalog
Manager.
 Options Manager contains the symbology definitions and settings for defining the heat trace
medium as a pipe jacket. This affects the way the symbology is applied to items. In the
following example, graphics were added to the Jacket layer in Catalog Manager for the
inline valve only, therefore jacketed symbology is displayed only for the valve and the pipe
run, but not for the nozzle and the vessel.
 When you select a nominal diameter value for a pipe run, the software assigns the minimum
value for the jacket nominal diameter (as defined on the Pipe Jacket Nominal Diameter
dialog box table in Options Manager) to the J_Nominal Diameter property of the pipe
jacket. Also, the software only allows combinations of core pipe nominal diameter and pipe
jacket diameter that are consistent with the values in the table.

Using Piping Components

Piping components are graphic elements that represent processes or functions within a
particular piping segment. Piping components include valves, flanges, reducers, and strainers.
In drawings, piping components are connected with lines.
The software includes a standard group of piping component symbols.
Using the Piping Specification Utility

The Piping Specification Utility (PipeSpec) works with PDS 3D, SmartPlant 3D, or SmartPlant
Reference Data to validate the piping materials class with the temperatures, pressures, and
diameters assigned to the pipe run and to search commodity codes (in all product databases)
and fabrication categories (in PDS 3D databases only) for inline piping components. The
database tables and library files in the products provide source information for the validation and
search. The service limits validation and automatic commodity code look-up can be disabled
simultaneously using a switch in Options Manager. For more information about modifying the
PipeSpec settings, see the Options Manager User's Guide topic Configure Piping Specification
Settings. For more information about using the Piping Specification Utility with SmartPlant 3D,
refer to the SmartPlant P&ID Installation and Upgrade Guide for details about installing
SmartPlant 3D Piping Specification Remote Access Client.
In Data Dictionary Manager, the ValidateNomDiam.ForeignCalc program ID, which is assigned
to the Nominal Diameter property, starts the Piping Specification Utility and triggers the
commodity code and fabrication category look-ups when a nominal diameter is changed. For
more information about assigning calculation and validation IDs, see the SmartPlant P&ID
Utilities Guide topic, Enter Required ProgIDs.
PDS 3D Files Used for PipeSpec

 pd schema — pdtable_102 table
 ra schema — pdtable_201 and pdtable_202 tables
 library files — us_pjstb.l, us_pjstb.l.r, and us_pjstb.l.t (The library file locations are listed in
pdtable_102.)
 .dll files — PipeSpec.dll, pdpjs.dll, pdpjsx.dll, and ValidateServiceLimits.dll
The Piping Specification utility allows separate logon for the ra and pd schemas in the PDS 3D
database.
 To use the Piping Specification Utility with SmartPlant 3D, you must install the SmartPlant
3D Piping Specification Remote Access Client, which is available on the SmartPlant P&ID
product CD under Prerequisite Software.
 All of the displayed text strings are maintained as Visual Basic resources in the
PipeSpec.dll file. These strings can be translated or modified as required using a resource
file editor.
 When performing piping materials class validations, commodity code lookup, or validation of
nominal diameter for SmartPlant 3D or SmartPlant Reference Data, the Piping Specification

Utility assigns the highest revision number from the SmartPlant 3D or SmartPlant Reference
Data piping materials class to the Pipe Spec Revision property.
 Error messages are placed in the PipeSpecError.log file in the folder assigned to the TEMP
environment variable. Error messages help you identify the cause of failure when the utility
does not complete the tasks as expected. For example, if minimum requirements are not
met for the look-up, the missing properties are listed in the log file.
 The ServiceLimits.log file contains any errors encountered during the Service Limit
Validation process, which runs as part of the Piping Specification Utility.
Performing Service Limits Validation

The Piping Specification Utility verifies that the temperatures and pressures assigned to a pipe
run comply with the service limits associated with the selected Piping Materials Class. In
continuous validation mode, which is activated by assigned settings in Options Manager, this
verification occurs each time you modify either the Piping Materials Class or a
temperature-pressure pair in the process case data of the pipe run. The Service Limits validation
requires at least one complete temperature-pressure pair from among design, alternate design,
operating, and alternate operating cases. If any temperature-pressure pair violates the service
limits of the selected Piping Materials Class, a warning displays the appropriate pair. This
warning appears in the design software by appending an error string ('SERVICE LIMITS
ERROR') to the name of the Piping Materials Class.
In SmartPlant 3D, for a particular temperature-pressure pair, the service limits may also
specify an accepted range of nominal diameters for the pipe run. In such cases, if the nominal
diameter lies outside this range or if no value is specified for the nominal diameter, the warning
also displays.
Performing Commodity Code and Fabrication Category Look

Up
The Piping Specification Utility (PipeSpec) looks up the Commodity Code property (in all
product databases) and the Fabrication Category property (in PDS 3D databases only) of
inline piping components. In the continuous validation mode, this look-up occurs each time the
Piping Materials Class or any of the case temperatures: Design Max Temp, Design Min
Temp, Operating Max Temp, or Operating Min Temp are modified on the pipe run (for
SmartPlant Reference Data, only changes in the Piping Materials Class or Design Max Temp
initiate the look-up). Validation also occurs each time the Option Code or Nominal Diameter
of the component is modified. If the modification occurs on a property of a piping component,
then the look-up is restricted to that particular component, but if the modification occurs on a
property of a pipe run, then the look-up encompasses every piping component on that run.
The minimum requirements to cause a look-up are that the piping components must be in a pipe
run and that the PMC and the nominal diameter of the pipe run must be specified. If
temperatures do not comply with the service limits, then the Commodity Code property
displays an error message.
The Piping Specification Utility uses process case temperatures of the run during the commodity
code look-up only if the code for the component has a maximum temperature limit value in the
3D or SmartPlant Reference Data database. For example, in PDS 3D, a value of -9999 for
maximum temperature in pdtable_202 indicates a null value and the process case temperatures
on that pipe run are ignored for the look-up. If a maximum temperature limit exists for a
component, then the look-up ensures that none of the relevant process case temperatures

assigned in SmartPlant P&ID to the pipe run in which the piping component resides exceed this
limit.
 The units for the PDS 3D maximum temperature are those specified in Options Manager.
 If continuous validation is turned on for the PipeSpec utility, then a pipe run with
temperature-pressure limits that do not agree with its PMC generates Error in PMC in the
commodity code for an inline component.
 If any temperature values for the pipe run are unspecified, then for SmartPlant Reference
Data or PDS 3D, a value of zero Deg-K is assumed for each of the unspecified
temperatures. For SmartPlant 3D, an unspecified temperature is interpreted as 'undefined'.
 SmartPlant 3D can validate commodity codes using the four case temperatures listed earlier
against Maximum Temperature ranges or Minimum Temperatures specified on piping
components in the SmartPlant 3D database.
 SmartPlant Reference Data can validate commodity codes using the pipe run’s Design Max
Temp against Maximum Temperatures specified on piping components in the SmartPlant
Reference Data database. Other case maximum temperatures or minimum temperatures will
not be used in the validation.
 If the temperature falls within the allowable limits, the software will return a commodity code;
otherwise, Not in Spec is returned.
 SmartPlant Reference Data supports a single maximum temperature only for each option
code.
 SmartPlant Reference Data does not return a commodity code for reducers.
 The Fabrication Category property of inline piping components is a select-listed property in
SmartPlant P&ID. A relationship between the fabrication category and the commodity name
can be defined in the PDS 3D database. The Commodity Name is a unique name for
every symbol. In PDS 3D, this unique name is the AABBCC Code property. In SmartPlant
P&ID, the commodity name corresponds to the Short Value entry of the Piping Component
Type select list for the symbol defined in Data Dictionary Manager and it is this value of the
commodity name that is used for the look-up. For a delivered SmartPlant symbol, the Short
Value entry is equivalent to the symbol's AABBCC Code, defined in Catalog Manager.
 Similarly, the Option Code property is a select list of text values in SmartPlant P&ID, while it
is a set of code numbers or indices in SmartPlant 3D. Short Value for the Option Code
select list contains the SmartPlant 3D indices corresponding to the appropriate Option Code
text in SmartPlant P&ID. The Piping Specification Utility uses the entries in the Short Value
box of the Option Code list to obtain the Option Code used in the SmartPlant 3D database
tables.

Piping Specifications Dialog Box

This dialog box opens when, in the Properties window, you click the Calc button beside the
Piping Materials Class property (PMC) for a pipe run. It allows you to choose a PMC from a
piping specification. This functionality is not available unless the proper settings are defined in
Options Manager and the applicable Program IDs are assigned in Data Dictionary Manager. For
more information about Piping Specification configuration, see Using the Piping Specification
Utility (on page 137).
Piping materials class — Lists the PMCs in your piping specification. Choose one, and
depending on the settings in Options Manager, property validation for piping segments and
inline components is run. This can include checking service limits.
Assign a Piping Materials Class to a Pipe Run Using the Piping

Specification Utility
The PipeSpec utility is not available unless the appropriate settings and program
IDs are assigned in Options Manager and Data Dictionary Manager respectively. For more
information about Options Manager settings, see the Options Manager User's Guide topic
Configure Piping Specification Settings. For more information about assigning calculation and
validation IDs, see the SmartPlant P&ID Utilities Guide topic, Enter Required ProgIDs.
1. Select the pipe run.
2. Select the Piping Materials Class property for the pipe run in the Properties window.
3. Click the Calc button .
4. On the Piping Specifications dialog box, choose the appropriate PMC from the list and
click OK.
Based on the chosen PMC and other assigned properties, such as Nominal Diameter,
Maximum Design Pressure, Maximum Design Temperature, and so forth, the PipeSpec
utility copies properties and checks limits in the entire run, including inline components.
 If you subsequently assign nominal diameters to inline valves or other components,

SmartPlant P&ID assigns commodity codes and fabrication categories to them that
correspond to the PMC of the pipe run and the specifications in your databases (fabrication
category is not supported for SmartPlant 3D or SmartPlant Reference Data). If you choose
a diameter, for instance, that does not exist for the assigned PMC, the commodity code
property becomes Not In Spec.
 If you choose temperature-pressure limits for process cases that do not agree with the
assigned PMC, then the error Service Limits Error is added to the PMC for the run.
 Given the appropriate settings in Options Manager and Data Dictionary Manager, you can
manually assign commodity codes to inline components, and the PipeSpec utility looks up
accepted diameters and validates the assignment. For more information, see Assign a
Commodity Code to a Piping Component Using the Piping Specification Utility (on page
141).

Assign a Commodity Code to a Piping Component Using the

Piping Specification Utility
The PipeSpec utility is not available unless the appropriate settings and program
IDs are assigned in Options Manager and Data Dictionary Manager respectively. For more
information about Options Manager settings, see the Options Manager User's Guide topic
Configure Piping Specification Settings. For more information about assigning calculation and
validation IDs, see the SmartPlant P&ID Utilities Guide topic, Enter Required ProgIDs.
Select an inline component that belongs to a pipe run whose piping materials class has
been defined. For more information on assigning a PMC, see Assign a Piping Materials
Class to a Pipe Run Using the Piping Specification Utility (on page 140).
1. In the Properties window, define the Nominal Piping Diameter property for the
component.
You can verify that a commodity code (in all 3D databases) and fabrication category (in
PDS 3D databases only) have been assigned in the Properties window, or you can open
the error log, PipeSpecError.log, if properties have not been assigned as expected.
 If continuous validation is turned on for the PipeSpec utility, then a pipe run with
temperature-pressure limits that do not agree with its PMC generates Error in PMC in the
commodity code for an inline component.
 With continuous validation, not only is the commodity code defined automatically, but for
PDS 3D, so is the Fabrication Category property for the inline components, if the
relationship is defined in your PDS 3D database.
 Adding or changing the option code can change the commodity code, if the relationship is
defined in your PDS 3D database.
 If continuous validation is not activated but other appropriate settings and program IDs are
assigned, you can still click the Calc button for the Commodity Code property and
choose a code. However this does not verify that the component agrees with a piping
specification.
 For additional information about the behavior of specific 3D databases when returning
commodity codes, see Using the Piping Specification Utility (on page 137).
Working with Instruments and Loops

In SmartPlant P&ID Engineering, you can add instruments to loops, update instrument
properties with loop data, and remove instruments from loops.

Loop Tag Dialog Box

Allows you to search for and specify the loop tag for the item whose properties currently appear
in the Properties window. This dialog box opens when you click the ellipsis button next to
the loop tag cell.
Search for — Allows you to type in descriptors to display the available loop tags, limited by
parameters that you enter. The percent character, %, is a wildcard. For example, if you want to
list only loop tags that contain the letter F, you can type %F% in the Search for box. If you want
to display all available loop tags, simply type %.
Search — Finds and displays the loop tags that match the criteria in the Search for box. You
can choose a tag from the main window and click OK to assign the tag to the item whose
properties currently appear in the Properties window.
Add Instruments to a Loop

1. Click the Catalog Explorer tree view Loops node.
2. In the list view, right-click the instrument loop that you want to place.
3. Select Send to Drawing Stockpile or Send to Stockpile from the shortcut menu.
4. Define properties for the loop by entering values in the Properties window. The software
automatically generates an item tag when you enter a tag suffix.
5. Select the item that you want to associate with the instrument loop.
6. Select the item tag of the loop from the Loop Tag select list in the Properties window, or
you can click the Calculation button beside the Loop Tag property in the Properties
window.
7. On the Loop Tag dialog box, enter characters in the Search for box in order to display the
available loop tags.
8. Click Search Now.
9. Choose the appropriate loop from the resulting list.
 If you need to change or modify a loop, and the loop has instrument(s) already assigned to
it, you can use the Updating Associated Instruments with Loop Properties (Properties
Window) command to select those instruments whose properties you want to update to
match the changes in the loop.
 If an instrument-loop association is attempted and the resulting instrument item tag is a
duplicate, the association will be canceled and the instrument tag will retain its original value.
This can occur for single or multiple instrument-loop associations.
 If an association is made between a loop and a select set consisting of several instruments
and the generated item tag for some of the instruments will be duplicates, no associations
will be made for the duplicate instruments. A message will be displayed for each duplicate
instrument indicating that the instrument tag will retain its original value.
 You can assign the Loop Tag qualifier to instruments that are already placed in your
drawing or that reside in the stockpile.

 Since loops are logical collections of instruments rather than physical groupings, you do not
need to place the loop symbol in the drawing itself to create an occurrence. Instead, placing
the loop in the stockpile adds the loop to the model.
 You can assign a group of instruments and other elements to a loop by creating a select set
of them and assigning the correct loop tag for the set.
 Instrument loops normally reside in a stockpile with their members residing on drawings.
Moving the instrument loop itself to another stockpile has special limitations. For more
information about moving plant item groups from one stockpile to another, see Move a
Stockpile Item to the Stockpile of Another Drawing (on page 171).
 After you create instrument loops, you can create a customized loop report to generate lists
of items in specific loops in your drawing or plant, or you can open the Engineering Data
Editor to display elements of the loop.
 If you need to refresh the instrument Loop Tag Suffix display in the Properties window,
clear selection of the instrument and then select it again.
 If the Properties window is not visible, you can display it by selecting the instrument or loop
and then selecting Edit > Properties on the main menu bar.
Update Associated Instruments with Loop Properties Dialog

Box
This dialog box allows you to update the Item tag property of an instrument so that it will
correspond with the current Loop tag property for that instrument. This dialog box may be
accessed by clicking the ellipsis beside one of the following loop properties: Loop Function,
Tag Seq No, or Tag Suffix.
The dialog box displays the list of instruments associated with that loop. The check boxes
beside the tags can be selected to determine which instruments will have their Instrument Tag
property updated.
Remove an Instrument from a Loop

1. In the drawing, select the item or items that you want to remove from the loop.
2. In the Properties window, remove the value for the Loop Tag property for the selection.
 When an instrument is assigned to a loop, validation automatically creates an instrument

item tag. If you remove the loop tag property, the instrument item tag remains the same until
the instrument is assigned to a new loop.
 If the Properties window is not visible, you can display it by selecting the item and then
clicking Edit > Properties.

Using Implied Items

An implied item is an item in the database with no graphical representation in the drawing
file. You can establish implied items by the existence of a single item, or by the existence of a
relationship between two items.
A common example of a symbol with implied items is a vent drain (macro component) detail. In
the drawing, the vent drain detail is represented graphically by only one symbol. However,
when the symbol is placed, it represents a 1-inch secondary pipe, a 3/4-inch root valve, and a
plug in the database.
Clicking Edit > Properties and selecting the Implied Items tab on the Rule Properties dialog
box allows you to define the method for specifying implied items. The list shows all implied
items for a rule. You can add or delete items by using the Add or Delete buttons beside the list.
If you associate implied items with a single item on the Items tab (Item 2 is freestanding), then
the software creates implied items for each instance of that item in the design. If you associate
implied items with a pair of items, then the software creates implied items for each instance of
the relationship between those two items.
Because implied items are not graphical, you cannot see them in a drawing. However, you can
display the items in the table view and in reports generated from the database.
For a detailed explanation of how to create a rule for an implied item, see the SmartPlant P&ID
Rule Manager documentation.
Calling Item Tag Validation

The Item Tag Validation project is saved as ItemTag.dll and performs calculations and
validations for unique tag checking, automatic tag generation, and tag reformatting. The
ItemTag Validation project can generate unique Item Tag values and maintains consistency
between the Item Tag value and the properties used in its calculation. Validation, in addition to
checking the active project for existing item tags, also checks for duplicate item tags in the
project environment.
Also, any leading or trailing spaces are removed during the validation (only for properties
included in the item tag).
The ItemTag project deals specifically with the following item types: instrument loops,
instruments, pipe runs, duct runs, equipment components, signal runs with a plant item type
pipe run (hydraulic, connect to process, and so forth), equipment (other equipment, exchangers,
mechanical equipment, and vessels), rooms, and nozzles. This project disregards all other item
types.
Property validation is triggered when any property that comprises the Item Tag value is added
or modified. Calculation can be triggered by the Item Tag property for any of the items shown in
the tables below. These tables list item types that are validated or calculated by the ItemTag
project, and the database tables and column names where modifications trigger calculation and
validation.
Legend
Italics: Required for checking item tag uniqueness.
Bold Italics: Required for the item tag, but can be generated automatically.

Instrument
Item Tag Structure Instrument Type Modifier Measured Variable Code Tag Sequence Number
Loop Tag Suffix Tag Suffix
Format (Instrument Type Modifier)(Measured Variable Code)(Tag Sequence

Number) Loop Tag Suffix(Tag Suffix)
Instrument Loop
Item Tag Structure Instrument Loop Function Tag Sequence Number Tag Suffix
Format (Instrument Loop Function)(Tag Sequence Number)(Tag Suffix)
Pipe Run
Item Tag Structure Unit Code Tag Sequence Number Tag Suffix Fluid Code
Format (Unit Code)(Tag Sequence Number)(Tag Suffix)(Operating Fluid Code)
Duct Run
Item Tag Structure Unit Code Tag Sequence Number Tag Suffix
Format (Unit Code)(Tag Sequence Number)(Tag Suffix)
Equipment
Item Tag Structure Tag Prefix Tag Sequence Number Tag Suffix
Format (Tag Prefix)(Tag Sequence Number)(Tag Suffix)
Room
Nozzle
Signal Run (Plant Item

Type Pipe Run)
Item Tag Structure Unit Code Operating Fluid Code Tag Sequence Number Tag Suffix
Format Unit Code(Operating Fluid Code)(Tag Sequence Number)(Tag Suffix)

 To refresh the instrument loop tag suffix in the Properties window, clear the selection of the
instrument and then select it again.
 All calculated item tags listed in the table are read-only.
 For information on customizing the software, including item tag formats, see the SmartPlant
P&ID Programmer's Guide.
Item Tag Validation Scope

The code for validating new item tag uniqueness is located in the ItemTag.dll file. To ensure
that the software does not create duplicate item tags, you must use the appropriate version of
this file according to the environment:
 ActivePlant — (Delivered in the Item Tag Validation folder) Contains the delivered item
tag validation code and the default ItemTag.dll with the scope set for validating item tag
uniqueness in the current plant only.
 ActiveProjectAgainstAs-Built — Contains the delivered item tag validation code and the
ItemTag.dll with the scope set for validating item tag uniqueness in the As-Built and the
current project.
 ActiveProjectAgainstAs-BuiltAndProjects — Contains the delivered item tag validation
code and the ItemTag.dll with the scope set for validating item tag uniqueness in the As-Built
and all of its projects.
These .dll files are delivered to the Programmer's Guide\Sample Source Code\Item Tag
Validation folder on the SmartPlant P&ID product CD. These files are not installed on your
computer during setup.
To use these files, you must rename the ItemTag.dll file installed on your computer (for
example, rename the file to DeliveredItemTag.dll), then copy from one of the product CD
sub-folders (ActiveProjectAgainstAs-Built or ActiveProjectAgainstAs-BuiltAndProjects)
the ItemTag.dll flavor that you want to use. Place this copy in the same location as the installed
ItemTag.dll that you just renamed. When you are finished, remove the ItemTag.dll copy, then
rename the delivered copy back to its original name.

Labeling
Your main tool to add or edit text content that appears in a label is the Properties window. By
adding or editing text, you are entering data into the database. Whenever you select a label, the
corresponding labeled properties for its item appear in the Properties window. The same
properties appear in the long list of properties when you select the item itself. Since only the
label properties appear when the label is selected, you have an easier method to find to the
label properties.
A label always reflects the current property values of the item that it labels. Labels that populate
a property at placement are called driving labels. In other words, the predefined property value
in the label overwrites the current property value on the item that it labels. Labels that do not
overwrite the property at placement are called driven labels. Labels are defined as driven or
driving in Catalog Manager.
If you enter text with a recognized unit of measure using a quotes or double-quotes, the
software parses the unit of measure and ignores the double-quotes (or tick marks).
At label creation time, the plant administrator can define text content inside the label with the
SmartText editor in Catalog Manager. In SmartPlant P&ID Engineering, you cannot edit text
such as OLL= on the OLL Elevation Equipment label. Nonetheless, you can place free text in an
item note.
Different labels have different label properties. The following table identifies some of the label
properties that are defined during label creation in Catalog Manager. After the creation of a
label, these properties dictate label placement behavior for labels that were placed in
SmartPlant P&ID. You do not see label properties while using the design software; these
properties perform their function in the background and are invisible to you.
Label Property Title Block Flow Arrow Component Break
Labeled Item Drawing Pipe Run Equipment Pipe Run

Type
Duct Run Equipment Duct Run
Component
Pipe Run
Piping
Component
Instrument
Duct Run
Ducting
Component
Room
Room Component
Placement Type 1-Point 1-Point 1- or 2-Point 2-Point
Leader Line Not applicable Not applicable Yes Yes

Label Property Title Block Flow Arrow Component Break
Terminator Type Not applicable Not applicable Yes Yes
Offset Distance Not applicable Not applicable Yes Not applicable
Offset Source Not applicable Not applicable Yes Not applicable
Behavior Follow Follow Follow Follow (no rotate)

Follow (no rotate)
Fixed
Fit Graphics to Yes Not applicable Yes Yes

Text
Table notes
 The four types of labels (title block, flow arrow, component, and break) appear in columns.
Label properties appear in rows.
 'Yes' indicates that the property applies to that type of label.
 'Not applicable' indicates that the property does not apply to that type of label.
 Special notes, such as '1- Point' for single-point placement, indicate that the property applies
under certain conditions.
Using Off-Page and Utility Connectors

A connector is not actually a label but more like a component that includes a label. Placement
behavior for a connector is very similar to a standard piping component label. OPCs, utility
connectors, and piping components are inserted into a line.
For SmartPlant P&ID Engineering, placement is not allowed; therefore this information
refers to the behavior of items that were placed by a SmartPlant P&ID user.
The drawing needs a connector when a process line or signal line continues on another
drawing. The minimum information in the label portion is the drawing name to which the
connector points and the connector number. Connectors do not have a property for flow
direction, although most connectors use an arrowhead to indicate direction. When a connector is
placed, it does not set or respond to flow direction. The connector represents continuation, not
connectivity or flow.
During document creation, when the first connector of the pair is placed, the software places the
partner in either the Plant Stockpile or the stockpile of another drawing of your choice. The
default placement for the partner is in the Plant Stockpile. When you create a connector and
place it in a drawing, the property for the drawing name is not defined. The partner in the
stockpile reflects the drawing name in which its match was located. When you place the partner
from the stockpile, the first connector is updated to reflect the drawing name where you placed
the partner connector. As a result, you never need to type a drawing name and the software
guarantees a valid match.

OPC pairs have a to and from orientation. The software does not use the graphical to and from
distinctions, but reading the drawing is easier for you with this differentiation.
1. The OPC is a to connector if its connected point appears at the finish end of the connector.
2. The OPC is a from connector if its connected point appears at the start end of the
connector.
These properties exist for connectors:
 Offset source is set to None.
 Rotation is set to True.
 Leader line is set to False.
In Catalog Explorer, Off-Drawing or Off-Unit OPCs are available for instruments. Two types of
connectors are available for process lines: Off-Drawing or Off-Unit OPCs or Utility Connectors.
The correct symbology differentiates OPCs. You define symbology with Options Manager.
Understanding System Editing and OPCs

An OPC can be placed as a freestanding item in a drawing or it can be placed onto an existing
process line or signal line (line). If an OPC has been placed as a freestanding item, a line can be
attached to it. When the relationship between the OPC and the line is created (either by placing
the OPC or by placing the line), the system finds the applicable rules, copies the specified
properties and evaluates the consistency criteria.
When the first OPC (of an OPC pair) is connected to a line, there is no line connected to the
mate OPC. Since there is no other line, the system will not find any applicable rules.
When the second OPC (of an OPC pair) is connected to a line, however, the system will find the
rules that apply to this pair of lines. The system copies the specified properties from the line in
the other drawing to the line in the active drawing. This copy operation will not overwrite any
existing values. (The Copy is forced into the Copy If Null mode.) The properties that are copied
across the OPC are propagated into the active drawing. This can mean that property values on
items other than the connected line are affected. However, this is only done if the current value
is Null. Existing values are not overwritten. After the copy process is complete, the consistency
criteria are evaluated and inconsistencies are generated for all inconsistent properties.
Each time a drawing is opened, a routine is executed to update all of the OPCs in that
drawing. Also, the relationship between the OPC and the connected line is updated. During this
update, the rule base is searched to find all of the applicable rules. If the mate OPC has been
connected to a new line since the last time this drawing was opened, it may find a different set of
rules that apply. After finding the applicable rules, the consistency criteria are evaluated and
inconsistencies are generated for all inconsistent properties. Property values are not
automatically copied across OPCs during this processing. If you want to copy changed property
values across OPCs, you can use the Solutions that are available in the Consistency Check
dialog box.

The text in the label on the OPC is also updated. If the mate OPC has been placed into a
different drawing since the last time this drawing was opened, this change will be reflected in the
updated label.
System Editing and Changing Property Values Across OPCs

When a property value is changed on a process line or signal line (line) that is connected to an
OPC, it is expected that the connected line in the continuation drawing should be changed in a
corresponding manner. You can achieve this result with a workflow that pulls the change into the
other drawing.
This workflow allows you to pull a changed property value across an OPC into the continuation
drawing. When a property value is changed on a line that is connected to an OPC, an
inconsistency is generated at the OPC. This inconsistency indicates that the two connected lines
have different values. To resolve this inconsistency, you must close the active drawing and open
the continuation drawing. In that drawing, another inconsistency is shown at the mate OPC. You
can double-click on that inconsistency to display the Consistency Check dialog box. A solution
is displayed to Copy the new value from the first drawing onto the line in the active drawing. If
you apply this solution, the value is copied into the active drawing and propagated to the related
items. This resolves the inconsistency in the second drawing. The next time the first drawing is
opened, the inconsistency will be resolved there as well.
If you use Plant Editing to change a property value in a non-active drawing, propagation
Editor display is automatically updated. This includes propagation of data between non-active
drawings across Off-Page Connectors (OPCs) when both drawings involved are not opened by
a user. Propagation does not occur across OPCs between the active drawing and a non-active
drawing.
To / From Dialog Box (Properties Window)

Opens when you click To / From in the Properties window when an OPC or other connector is
selected, and allows you to enter a text value to be displayed in the connector. Click the ellipses
to open this dialog box.
Description — Allows you to enter to or from information for the connector. You can enter
drawing names or numbers or other pertinent information about the connected drawing or the
direction of flow.
Move a Connector to Another Stockpile

1. In the Engineering Data Editor, select the connector that you want to move.
2. On the Engineering Data Editor toolbar, click Actions > Move to Different Stockpile.
If you select a connector that you do not have write privileges for, then the Move to
Different Stockpile command is not available. That is, you cannot move a connector that
belongs to a different drawing, for instance.
3. On the Move to Different Stockpile dialog box, select the plant hierarchy element that
contains the drawing whose stockpile you want to assign the connector to.
If you do not want to place the connector in a stockpile of a specific drawing, you can
select Stockpile at the bottom of the Plant hierarchy tree.

4. In the Drawing list area, select the drawing whose stockpile you want to add the partner to.
Move Partner OPC Command (Connector Shortcut Menu)

Opens the Move Partner OPC dialog box, from which you can move the selected connector to
the stockpile of any drawing in the active plant. This command is available only when the partner
connector is located in the Stockpile.
Move Partner OPC Dialog Box

Opens when you click Move Partner OPC on the Connector shortcut menu. This dialog box
allows you to move a partner connector from the Stockpile into the stockpile of a specific
drawing, or vice versa.
Plant Hierarchy — Displays the hierarchical tree representation of the plant. When you select a
node, the drawings associated with that node appear in Drawing list.
Drawing list — Displays all the drawings associated with the selected node on the Plant
Hierarchy tree.
Move a Partner Connector to Another Stockpile

1. In the Drawing view, right-click the connector whose partner you want to move.
2. From the shortcut menu, click Move Partner OPC.
If you select a connector that you do not have write privileges for, then the Move
Partner OPC command is not available. That is, if the partner connector belongs to another
drawing, you cannot move it, for instance. However, you can use the Open Continuation
Drawing command on the shortcut menu to open the other drawing and move the
connector from its stockpile. For more information about opening the partner drawing, see
Open a Continuation Drawing (on page 152).
3. On the Move Partner OPC dialog box, select the plant hierarchy element that contains the
drawing whose stockpile you want to assign the connector to.
If you do not want to place the connector in a stockpile of a specific drawing, you can
select Stockpile at the bottom of the Plant hierarchy tree.
4. In the Drawing list area, select the drawing whose stockpile you want to add the partner to.
If the partner connector is in a stockpile and is displayed in the Engineering Data Editor,
you can move it from there. For more information, see Move a Connector to Another Stockpile
(on page 150).

Open Continuation Drawing Command (OPC Shortcut Menu)

Opens the connected drawing when the partner of the selected off-page or utility connector is in
a drawing or a drawing stockpile. This command is not available if the partner OPC is in the
stockpile (instead of a drawing or drawing stockpile). If the partner OPC is in the drawing and
not in the drawing stockpile, the software highlights and zooms in on the partner OPC.
Open a Continuation Drawing

1. Select the OPC or utility connector whose connected drawing you want to open.
2. Right-click the connector and on the shortcut menu, click Open Continuation Drawing.
The connected drawing opens and if the partner OPC is in the drawing and not in the drawing
stockpile, the software highlights and zooms in on the partner OPC.
Adding Design Elements

Topics
Place a Package ............................................................................ 152
Place a Safety Class ...................................................................... 153
Place a Test System ...................................................................... 153
Place a Hydro Test Package ......................................................... 154
Defining Test System Relationships .............................................. 155
Place a Contract Package ............................................................. 156
Place a Package
1. Right-click the Package symbol in Catalog Explorer in the Design node.
2. From the shortcut menu, select Send to Stockpile or Send to Drawing Stockpile,
whichever is appropriate.
3. In the Properties window or the Engineering Data Editor, enter a value for the Item Tag
property.
4. In the Drawing view, select items to be part of the package.
5. If you want to create a select set, in the Properties window, choose Select Set from the
Properties box.
6. In the Properties window, click in the Package Item Tag box and select the appropriate
value displayed list.
Some catalog items do not possess the Package Item Tag property, for example,
OPCs and Item Notes. Do not include those items in your select set because the package
item tag does not appear in the Properties window if any member of the select set does not
possess that property.
 Packages normally reside in a stockpile with their members residing on drawings. Moving
the package itself to another stockpile has special limitations. For more information about

moving plant item groups from one stockpile to another, see Move a Stockpile Item to the
Stockpile of Another Drawing (on page 171).
 If the Properties window is not visible, you can display it by selecting an item and then
selecting Edit > Properties on the main menu bar.
Place a Safety Class

1. Right-click the Safety Class symbol in Catalog Explorer in the Design node.
3. In the Properties window or the EDE, enter a value for the Item Tag property.
5. If you want to create a select set, choose Select Set from the Properties box in the
Properties window.
6. In the Properties window, click in the Instr Safety Class Item Tag box and select the
appropriate value from the displayed list.
Some catalog items do not possess the Instr Safety Class Item Tag property, for
example, OPCs, piping, equipment, and Item Notes. Do not include those items in your
select set because the package item tag does not appear in the Properties window if any
member of the select set does not possess that property.
 Safety Class only applies to instruments.

Place a Test System

1. Right-click the Test System symbol in Catalog Explorer in the Design node.
Properties window.
6. In the Properties window, click in the Test Sys Item Tag box and select the appropriate
value from the displayed list.
Some catalog items do not possess the Test Sys Item Tag property, for example,
Trays, Items Notes, and OPCs. Do not include those items in your select set because the

package item tag does not appear in the Properties window if any member of the select set
does not possess that property.
Place a Hydro Test Package

1. Right-click the Hydro Test Package symbol in Catalog Explorer in the Design node.
Properties window.
6. In the Properties window, click in the HydroTest Package No box and select the
appropriate value from the displayed list.
Some catalog items do not possess the HydroTest Package No property. Do not
include those items in your select set because the package item tag does not appear in the
Properties window if any member of the select set does not possess that property.
 The Hydro Test Package is for piping only.


Defining Test System Relationships

You can define many-to-many relationships between test systems and SmartPlant P&ID
drawing items; that is, you can associate several test systems with one or more items.
SmartPlant P&ID supports the association of multiple hydraulic circuits with pipe runs, vessels,
instruments, equipment, nozzles, and piping components.
Associate Hydraulic Circuits with an Item

Before selecting the pipe run for associating hydraulic circuits, open Options
Manager and make sure that Hydraulic Circuit appears among the items included in the
StockpileItems property.
1. In the Catalog Explorer tree view, select the Symbols > Design node.
2. In the lower pane, right-click Hydraulic Circuit and on the shortcut menu, click Send to
Stockpile.
3. Assign a value for the hydraulic circuit's Item Tag property.
4. Select one or more items and in the Properties window, beside the Hydraulic Circuit Item
Tag property, click the ellipsis .
5. On the Select Hydraulic Circuits dialog box, from the Available circuits list, select a
hydraulic circuit that you want to associate with the item, and then click Add.
6. Repeat the previous step for each additional hydraulic circuit that you want to associate with
the item.
7. Close the dialog box and beside the Hydraulic Circuit Item Tag property, view the
hydraulic circuits that you added.
Select Hydraulic Circuits Dialog Box

Allows you to select one or more hydraulic circuits for an item of equipment, an equipment
component, or a pipe run. This dialog box opens when you select the item and click the ellipsis
beside the Hydraulic Circuit Item Tag property in the Properties window.
Available circuits — Displays the list of available hydraulic circuits that are not selected for the
item. To select one or more hydraulic circuits, highlight them in this window one at a time and
click Add.
Selected circuits — Displays the list of hydraulic circuits that have been selected. To deselect
one or more hydraulic circuits, highlight them in this window one at a time and click Remove.

Place a Contract Package

1. Right-click the Contract Package symbol in Catalog Explorer in the Design node.
Properties window.
6. In the Properties window, click in the Contract Package No box and select the appropriate
value from the displayed list.
Some catalog items do not possess the Contract Package No property. Do not
include those items in your select set because the package item tag does not appear in the
Properties window if any member of the select set does not possess that property.
Modifying Items in SmartPlant P&ID Engineering

You can modify the items placed in a drawing in several ways.
You can modify the properties of each item by selecting the item and changing individual
properties in the Properties window. Also you can edit some item properties in the Engineering
Data Editor in the Design window by selecting a table cell and filling in the appropriate
information. You can select an entire row by clicking on the corresponding row number to the left
of the table and then viewing the properties in the Properties window and editing them there.
 When modifying or setting the fluid code properties of a line, you always select the fluid
code from a select list. If you do not set the fluid code first, you will see all possible fluid
codes. If you set the fluid system prior to setting the fluid code, then only the fluid codes
applicable to the type of fluid system display. To redisplay a complete list of available fluid
code values, delete the property for the fluid system, and then the complete list of fluid code
values appears.
 If the Properties window is not open, you can display it by selecting an item and then
selecting Edit > Properties.

Undo Command (Edit Menu)
Allows you to reject the last action that you completed.

Up to ten operations are saved in the undo list, and you can undo them by repeated use of the
Undo command. The undo list is cleared if you perform any of the following actions:
 Change the properties of the Drawing view on the View Properties dialog box
 Turn the display of inconsistency indicators off or on by clicking View > Show
Inconsistencies
 Click File > Save
 Open a different drawing or toggle to another open drawing
 Open a new Drawing view or new Engineering Data Editor
 Perform Plant Editing
 Move a connector to another drawing stockpile by using commands in the Engineering
Data Editor or on the Connector shortcut menu
 Change or view the claim status of drawing objects
An action that can be undone is defined in several ways. Running a command is usually an
action. Modifying item properties is an action that ends when another item is selected. This
definition of an action holds true for select sets, too, and for multiple items selected in the
Engineering Data Editor. That is, modifying the properties of a select set is one action in and of
itself, not one action for each member of the set.
The Undo command does not reverse view manipulations; however, the View >
Previous command is still available for that purpose.
Undo Your Last Action

 Click Undo .
 Pressing CTRL + Z also undoes your last action.

 The Undo command stores up to 10 actions making this command available repeatedly.
 If the Undo button is not available, then the undo list has been cleared, and you can
no longer undo your last action.
The Undo command does not reverse view manipulations; however, the View >
Previous command is still available for that purpose.

Move Command (Edit Menu)
Moves items from one location to another.

Move to Drawing Command (Edit Menu)

Allows you to move a select set of drawing items into another open drawing.
Finding Drawing Items

The software has the ability to find items and inconsistency indicators in your drawing. You can
define search criteria based on a catalog item or an item type already in place in your drawing.
Or, you can define criteria based on a delivered filter or on a user-defined filter. Having found all
drawing items of a certain type, you can modify their properties.
The software also searches your drawing for inconsistency indicators so that you can review
and correct inconsistencies systematically.
When you find drawing items, the selected items are added to a select set, and so you can view
the common properties of the select set items in the Properties window and edit them if
appropriate.
The Find command is not available in the Engineering Data Editor.
Find Command
Displays the Find and Replace dialog box, which allows you to search a drawing for items by
using catalog items or a filter or to find inconsistencies in your drawing. As drawing items are
found, they are added to a select set.
Find Drawing Inconsistencies

1. Click Edit > Find.
2. On the Find and Replace dialog box, select <Inconsistency> from the Find what list.
3. Choose an option from the Search in list.
Selecting Active window disables the Scroll mode option. Selecting Active
Document enables the Scroll mode option.
4. Click Find to select the first inconsistency.

5. Continue clicking Find to advance through the drawing inconsistencies.
 For detailed information about all your drawing inconsistencies one-by-one, right-click the
selected inconsistency and click Properties. Leave the Consistency Check dialog box
open, and click Find on the Find and Replace dialog box to display information on the next
drawing inconsistency.
 Use the Direction options to change the order in which drawing items are found.
 Use the Scroll mode options to control how the Drawing view changes when an
inconsistency is selected.
Find an Item by Using a Filter

2. On the Find and Replace dialog box, select <Filter...> from the Find what list.
3. On the Select Filter dialog box, select a filter to locate your drawing items, and click OK.
4. Select an option from the Search in list.
5. Click Find to search for and select the next item match in your drawing or click Find All to
select all matches in the drawing items that meet the selected filter.
 Use the Scroll mode options to control how the Drawing view changes when a drawing item
is found.
Find a Drawing Item by Using a Catalog Item

2. On the Find and Replace dialog box, select <Catalog Item> from the Find what list.
3. On the Select Catalog Item dialog box, select the catalog item type to search for, and click
OK.
4. Select an option from Search in.
5. Click Find to select the first match in the drawing or click Find All to select all matches in
the drawing. All the items are in the select set, and you can view the common properties of
the set in the Properties window.
is found.
 Use the Direction options to change the order in which single drawing items are found.

Find an Item by Using an Existing Drawing Item

1. Select an item in your drawing.
3. On the Find and Replace dialog box, select an option from the Search in list.
 On the dialog box, the Find what option is automatically defined according to the
drawing item you selected in the first step.
 Selecting Active window disables the Scroll mode option. Selecting Active
4. Click Find to search for and select the next matching item in the drawing or click Find All to
select all matches in the drawing.
is found.
Select Associated Item Command (Edit Menu)

When an item note and label is associated with a drawing item and you select the label's
annotation point, this command highlights the associated item. This is useful for example, if
you have a number of items with associated labels that are placed remotely from those items,
and it is not clear which label belongs to which item.
Replace Command (Edit Menu)

 Displays the Find and Replace dialog box, which allows you to replace some or all of the
drawing items that match the search criteria defined by the options on the Find tab.
Replace Mode Command (Tools Menu)
Controls whether catalog items are placed as substitutions for existing drawing items or placed
normally. When this mode is active, the software places catalog items only when they replace
an existing drawing item. When this mode is not active, the software places catalog items as
usual. The Replace Mode command copies properties of the current item onto the new item.

Find and Replace Dialog Box

 Sets options for searching for and replacing drawing items. This dialog box opens when you
click Edit > Find
For SmartPlant P&ID Engineering, the replacement options are disabled.
Find Tab (Find and Replace Dialog Box)

Allows you to search the drawing for specified items.
Find what — Lists search criteria, and allows you to enter new search criteria or select from a
list of the five most recently used criteria. The items listed above the dashed line in the list are
used to set new search criteria by searching using the Catalog Item, Filter, Inconsistency, or
Redundant Breaks options. Selecting the Catalog Item option opens the Select Catalog Item
dialog box. Selecting the Filter option opens the Select Filter dialog box.
Search in — Defines the scope of the search. You can search the active drawing or just the
contents of the active window (items that are currently visible in the Drawing view). If the Active
Window option is selected, the Scroll mode feature is not available. If the Active Drawing
option is selected, the Scroll mode feature is automatically set to Zoom, and you can select a
preferred scroll mode.
Scroll mode — Defines how the active view should be changed when a drawing item is found.
If you select Zoom, the active view is zoomed to a multiple of the range of the found drawing
item. If you select Pan, the active view is shifted without changing the view scale so that the
center of the drawing item is in the center of the view. If Scroll Mode feature is turned off, then
the active view is left unchanged.
Direction — Specifies the direction of the search. Because drawing objects are stored linearly
in the database, using either Next or Previous moves forward or backward through the
document.
Find — Initiates a search for a single item that is part of the specified search scope. Each time
you click Find, the software searches for and highlights the next drawing item that matches the
defined search criteria in the defined direction. Each time an item is found that matches the Find
what criteria, the active view is changed based on the Scroll mode setting.
Find All — Initiates a search for all items matching the search criteria and adds them to the
select set. The active view is updated based on the Scroll mode setting.

Replace Tab (Find and Replace Dialog Box)

Sets options for searching for and replacing drawing items. This tab is on the Find and Replace
dialog box.
For SmartPlant P&ID Engineering, this dialog box tab is disabled.
Find what — Lists search criteria, and allows you to enter new search criteria or select from a
list of the five most recently used criteria. The items listed above the dashed line in the list are
used to set new search criteria by searching using the Catalog Item, Filter, or Inconsistency
options. Selecting the Catalog Item option opens the Select Catalog Item dialog box. Selecting
the Filter option opens the Select Filter dialog box. Since you cannot replace an inconsistency,
if you select the Inconsistency option from the Find what list, the Replace with option is not
available.
Replace with — Allows you to enter a new replacement item or select a replacement item from
a list of the five most recently used items, which are listed below the dashed line. You can define
a new replacement item by selecting Browse and picking a catalog item from the Select
Catalog Item dialog box.
Search in — Defines the scope of the search. You can search the active drawing or just the
contents of the active window. If the Active Window option is selected, the Scroll mode feature
is not available. If the Active Drawing option is selected, the Scroll mode feature is
automatically set to Zoom, and you can select a preferred scroll mode.
Scroll mode — Defines how the active view should be changed when a drawing item is found.
If you select Zoom, the active view is zoomed to a multiple of the range of the found drawing
item. If you select Pan, the active view is shifted without changing the view scale so that the
center of the drawing item is in the center of the view. If Scroll Mode feature is turned off, then
the active view is left unchanged.
Direction — Specifies the direction of the search. Because drawing objects are stored linearly
in the database, using either Next or Previous moves forward or backward through the
document.
Find — Initiates a search for a single item that is part of the specified search scope. Each time
you click Find, the software searches for and highlights the next drawing item that matches the
defined search criteria in the defined direction. Each time an item is found that matches the Find
what criteria, the active view is changed based on the Scroll mode setting.
Replace — Replaces the item selected when you clicked Find. The Replace button is available
only when the item found can be replaced by the item defined in the Replace with box. Each
time you click Replace, the located item is replaced, and the Find command continues based
on the Direction setting. As each drawing item is found, the active view is updated based on the
Scroll mode setting.
Replace All — Replaces all items that match the Find what criteria with the item defined in the
Replace with box without prompting you. After all of the replacements are completed, the
software reports the number of matches found and the number of replacements that were made.
The active view is also updated depending on the Scroll mode setting.

Select Catalog Item Dialog Box

Allows you to select a catalog item type for the search criteria when you use the Find or
Replace commands. This dialog box is constructed much the same as the Catalog Explorer
window.
Tree View — Displays a hierarchy of nodes that contain catalog items. You can navigate
through the tree view by clicking the different nodes. To open a node, click the plus sign to the
left of the node name. To close a node, click the minus sign to the left of the node name. If the
selected node contains any drawing symbols, the software displays them in the list view.
List View — Displays the symbols that are associated with the active node in the tree view.
Only the contents of one node appear.
Navigation Bar — Allows you to see and use Catalog Explorer shortcut buttons to navigate to
catalog items more quickly.
Mirror Command (Edit Menu)
Reflects one or more selected items about a line or axis that you define.
Rotate Command (Edit Menu)
Rotates one or more items a precise distance or angle about a specified point.
Cut Command (Edit Menu)
Cuts selected items from the drawing and pastes them to the Clipboard. The selected items
replace the previous contents of the Clipboard. Cut items go to the Stockpile, given appropriate
stockpile settings.

Paste Command (Edit Menu)
Inserts the Clipboard contents at the specified location. The command is not available if the
Clipboard is empty.
Paste Special Command (Edit Menu)

Inserts the Clipboard contents into a drawing with the format that you select in the Paste
Special dialog box.
Select All Command (Edit Menu)

Selects all visible items in a view.
You can also access this command by right-clicking a blank area in a drawing or table.
On the shortcut menu that displays, click Select All.
Delete to Stockpile Commands (Edit Menu)

Removes the selected item to the plant or drawing stockpile.
For SmartPlant P&ID Engineering, these commands are disabled.
Delete to Stockpile > Plant Command (Edit Menu)

Removes the selected item to the Plant Stockpile.
Delete to Stockpile > Drawing Command (Edit Menu)

Removes the selected item to the Active Drawing Stockpile.
Delete from Model Command (Edit Menu)

Deletes the selected item from the database.

Copying Items
In SmartPlant P&ID Engineering, it is possible to copy a drawing item to the Clipboard for use in
other applications. Items that you copy cannot be placed in SmartPlant P&ID drawings.
Copy Command (Edit Menu)
Copies selected items to the Clipboard. This command replaces the previous contents of the
Clipboard with the new contents.
Copy an Item
1. Select an item.
2. On the main toolbar, click Copy .

After you copy an item, it is placed on the Clipboard; however, you can only paste the
item in another application and not in a SmartPlant P&ID drawing.
Selecting Connected Items

You can use the Select Connected Items command to navigate the line connectivity from a
selected line segment to add components and other runs to a select set based on matching
properties. In cases where you want the software to continue constructing a select set beyond a
break in a line, for example, a nozzle, this command makes it possible to accomplish that goal.
This functionality is useful for finding branches from runs and finding all the runs and
components on an entire drawing that have a common property value.
Once the items are selected in the drawing, it is then a simple matter to choose the select set in
the Properties window and continuing editing properties for not only runs, but also lines and
networks and all runs included in the drawing.
The properties that define a run are specified in Options Manager.
Select Connected Items Command (Edit Menu)

Opens the Select Connected Items dialog box, which allows you to create a select set that
includes the active line and disconnected lines and inline components in any network. This
command is available only when either a single line segment or a single component is selected
on the drawing; however, once the dialog box is open, you can change the selected item in the
drawing and change the scope of the select set freely.

Select Connected Items Dialog Box

Allows you to construct a select set from lines and inline components, even if there are breaks in
a network. This dialog box remains open until you dismiss it, and you can highlight items in the
drawing and manipulate members of the select set while the dialog is active. The Select
Connected Items command, which appears both on the Edit menu and on the Line Shortcut
menu, is available only when either a single line segment or a single component is selected.
Scope — Provides options for defining the extent of your select set. The Scope List allows you
to choose extent, and the Include Runs and Include Components buttons allow you to
incorporate different items into the select set. At no time can neither the Include Runs nor
Include Components buttons be selected; that is, one or the other or both is always active.
Scope List — Allows you to choose from Run, Line, Network, and Drawing. The default value
for this list is Line.
The Run option means that lines in a single run are selected. The Line option selects
runs that are connected at end points, including components. The Network option adds
branches, and the Drawing option selects all the runs and inline components in the open
drawing.
Include Runs — Incorporates lines into the select set.
Include Components — Adds inline components into the select set.

Matching Properties — Displays options for defining the select set according to common
properties. The properties for the originally selected item are displayed by default.
Alphabetic — Lists properties in alphabetical order.
Categorized — Displays properties grouped by specific categories. By default the

properties are displayed categorically. Categories are defined and properties are assigned to
those categories in Data Dictionary Manager.
Preview — Highlights in the Drawing view the items that are selected according to common
properties in the Properties List of this dialog box.
Properties List — Allows you to choose common properties for your select set. You can select
more than one property in this list by using the CTRL or SHIFT keys.
Create a Select Set from a Line

1. Select a single line segment or inline component in the drawing.
2. Click Edit > Select Connected Items.
3. On the Select Connected Items dialog box, you can change the scope of the select set by
changing the display in the Scope list.
4. You can change the scope to include inline components or exclude lines, too, by using the
Include Runs and Include Components buttons.
5. At any time, you can select a different line segment or component in the drawing in order to
change the properties displayed in the dialog box.
The properties for the new selection are displayed in the Select Connected Items
dialog box, but the display of the Properties window itself is not updated until you click OK.

6. If you want to construct a select set based on common properties, select those properties
from the Properties list in the Matching properties area of the dialog box.
 You can use the CTRL or SHIFT keys to select more than one property value.
 You can choose an empty property value for matching criterion, too.
 If no properties are displayed in the dialog box, select a line segment or component in
the drawing that already has a property value you know you are interested in.
7. Click the Preview button to see the items that qualify according to the matching criteria
chosen in the previous step. The matching items are highlighted in the Drawing view.
8. Once you have selected the items you want for your select set, click OK. The selected items
are centered in the Drawing view.
9. Use the Selected Items list in the Properties window to display the common properties for
the select set. For more information, see Customize the Properties Window (on page 71).
If you click Cancel, the Select Connected Items dialog box closes, and the original item
is selected in the drawing.
Modifying Item Properties

You can review and edit the properties of an item in the Properties window. You can open the
Engineering Data Editor of the drawing data and in the cells of the table, edit properties of
items that belong to the active drawing, other drawings, and stockpiles. You can edit the
contents of some cells directly in the table if the corresponding property is not read-only or
generated strictly by validation; you can copy, cut, and paste properties, too, with the same
restriction. In the Properties window you are also constrained to edit only those properties that
are not read-only.
Once you have populated the properties of an item you can, for instance, run reports that
display the items and their properties, or create filters and control Drawing views so that only
items with specified properties are displayed.
See Also
Editing Item Properties in the Engineering Data Editor (on page 40)
Equivalent Diameter and Cross Section Area Properties

These properties apply to duct runs, ducting components, as well as to inline instruments and
nozzles with ducting points. The properties are calculated as follows:
Equivalent Diameter = 1.3 * (Duct Height * Duct Width)^0.625 / (Duct
Height + Duct Width)^0.25
Cross Section Area = (Duct Height * Duct Width)
The Equivalent Diameter and Cross Section Area properties are read-only.
Modify Pump Properties by Importing a SmartPlant P&ID Report

1. Open a drawing that includes a pump.

2. Run the Equipment List report. For more information on generating reports, see Generate
a Report for an Active Drawing (on page 224).
3. In the resulting report, change the property values as desired by updating the cells in the
appropriate columns.
If a desired property does not appear in the report, you can add it to the report
template. For more information, see Define the Contents of Your Report Template (on page
243).
4. Click File > Save.
5. Click File > Close.
6. In SmartPlant P&ID, click File > Import > Data file.
7. Browse to the Equipment List report that you just created and modified.
8. Click Open.
Description Dialog Box

Opens when you click the ellipses next to the Description property in the Properties
window, allowing you to enter long text descriptions for items.
Description — Allows you to type a description for the item. This box can contain a link to a
Web address, formatted like this: http://www.intergraph.com. You can also link to a file on your
file system by entering the UNC path like this:
file://servername/sharename/directory/document.extension.
Very long descriptions are not displayed in their entirety in labels, reports, and so forth.
Hold Status Text Dialog Box

Opens when you click the Hold Text calculation button and allows you to enter a text value.

Web address, formatted like this http://www.intergraph.com (http://www.intergraph.com/). You
can also link to a file on your file system by entering the path like this:
file://UNC_path/share/document.extension.
Labels do not display very long descriptions in their entirety.
Insulation Spec Dialog Box

Opens when you click the ellipsis for the Insulation Spec property in the Properties
window, allowing you to specify an insulation specification for the selected item or items. You
can choose a specification from either of the following lists.
Matching — Lists all insulation specifications that match any already chosen values, such as
Insulation Type or Insulation Purpose.
All — Lists all the insulation specifications in the plant insulation specification file.
The path to the plant insulation specification file is defined in Options Manager. Any
modifications to insulation specifications are carried out in Insulation Specification Manager.
Assign an Insulation Specification

1. Select the item that you want to add an insulation specification to.
2. Click the Insulation Spec property box in the Properties window.
3. Click the Calculation button .
4. On the Insulation Spec dialog box, choose a specification from either the Matching or the
All lists.
If you have already specified other insulation properties, such as the insulation
temperature, type, or purpose, then the Matching list contains only those insulation

specifications that agree with the properties already chosen; nonetheless, you can choose a
specification from the All list.
If you assign a heat tracing to an item before you assign insulation properties, your
choices of insulation properties and specifications are restricted.
Note Text Dialog Box

Opens when you click the Note Text calculation button in the Properties window, and
allows you to enter a text value in an item note.
file system by entering the path like this: file://UNC_path/share/document.extension.
Very long descriptions are not displayed in their entirety in design labels.
Revision Text Dialog Box

Opens when you click the Revision Text calculation button and allows you to enter a text
value.
file system by entering the path like this: file://UNC_path/share/document.extension.
Labels do not display very long descriptions in their entirety.
Stream Number Dialog Box

Opens when you click the ellipses next to the Stream Number property in the Properties
window, allowing you to specify the stream number for your pipe run.
Browse — Allows you to search for a file on your computer or network.
File Name — Specifies the file from which stream data is imported. You can click Browse to
find the file on your computer or the network. Stream data is generally imported from an Aspen
Basic Engineering stream data file.
Stream ID List — Lists the values found in the text file specified in the File Name box.
Moving Stockpile Items

You can move the items that reside in stockpiles (the Stockpile, which belongs to the Plant or
the active project, or drawing stockpiles) from one stockpile to another, or you can delete them
from the model altogether.
You view the items in a stockpile in the Engineering Data Editor. In particular click Stockpile
to view items in the Stockpile, or click Active Drawing Stockpile to view items in the
stockpile of the active drawing. Be sure that the other item buttons on the Engineering Data
Editor toolbar (that is, the Active Drawing or Other Drawings buttons) are not active when you
want to view stockpile items alone.

In the Engineering Data Editor, the Actions menu contains the following commands for
manipulating stockpile items:
 Delete Stockpile Item Command (on page 49)
 Move to Different Stockpile Command (on page 50)
You can also access these commands from the shortcut menu, which opens when you
right-click in the Engineering Data Editor. For more information, see Engineering Data Editor
Shortcut Menu (on page 59).
You can import items into the Stockpile, too, by importing reports with the File > Import > Data
File command on the main toolbar.
Move to Different Stockpile Dialog Box

Opens when you right-click a stockpile item icon in the Engineering Data Editor and select
Move to Different Stockpile. You can move your selected stockpile item into the drawing
stockpile of another drawing.
Tree view — Allows you to navigate in the plant hierarchy in order to display the drawing into
which stockpile you want to move the selected item.
List view — Displays a list of available drawings that can accept the selected stockpile item.
Move a Stockpile Item to the Stockpile of Another Drawing

1. In the left-most column of the Engineering Data Editor, right-click the icon of the stockpile
item that you want to move.
Be sure you have chosen a stockpile item in your Engineering Data Editor, not a
drawing item.
2. On the shortcut menu, click Move to Different Stockpile.
3. On the Move to Different Stockpile dialog box, choose a drawing from the list and click
OK.
 Plant item groups, such as instrument loops, packages, safety classes, and so forth,
frequently reside in a stockpile with their members residing on drawings. Moving the plant
item group itself to another stockpile has special limitations:
 From a drawing stockpile to the Stockpile — No constraints apply. This action can
occur at any time.
 From the Stockpile to a drawing stockpile — If the plant item group contains only
items in the destination drawing or does not contain items in any drawing, this action is
allowed.
 From a drawing stockpile to another drawing stockpile — Same constraint as above
applies.

Using Reports to Import Items into the Stockpile

You can use the Equipment List and the Pipe Run List to import new items into the stockpile.
This capability allows you to define values for an item that does not yet exist in the database.
Both of these reports have hidden columns that store some key information that is necessary for
importing this information.
Also, you can use a report to import information for items that already exist in the database. You
must first run the report, add or edit property values for the items returned in the report, and then
import the items back into the drawing. The property values for the items are updated. Valid
reports are Equipment List, Equipment Nozzle List, and Pipe Run List.
XML Tags and Descriptions

Tag Description
<?xml version="1.0"?> Identifies the XML file and the version used
<Preamble> Ignored by SmartPlant P&ID
<Items> Indicates beginning of the list of all item types and

properties to be imported, and must have corresponding
</Items> tag
</Identification> Defines Classification and Symbol File: Classification -

Database Item Type, Symbol File - Path to symbol to be
created in stockpile
<ContextSpecificIdentifier Ignored by SmartPlant P&ID.

ContextId
<Item Attributes> Indicates the beginning of the list of properties to be

imported for the item type
<Item Attribute> Imported property for the item type: AttributeName -

Derived from the Data Dictionary Manager property name,
not the display name, and must be in double quotes;
Attribute Value - Must be in double quotes, and specify
the actual value, not the index number, even for select-
listed values; AttributeUnits - Specify if the property has
units of measure, and must be a valid format; ITEMTAG -
must be one of the properties listed.
 The log file for import activities is called SPImport.log and is saved to your local Temp
directory.
 For examples of importing pumps into the database using the Equipment List, click Related
Topics.

Populate the Stockpile from a Spreadsheet

1. Click File > Import > Data File.
2. Browse to the location of your spreadsheet, select it, and click Open.
 The status bar at the bottom of the SmartPlant P&ID window displays the progress of
the import activity.
 You can populate the stockpile with items from Aspen Basic Engineering exported
spreadsheets and some SmartPlant reports.
3. On the Import Log dialog box, you can click Report in order to open the log file and view
notes on the import process, or you can click Close.
If a format change is made to an exported Aspen Basic Engineering report, you
must make modifications to the import code to accommodate the changed report layout.
 Aspen Basic Engineering spreadsheets in either Microsoft Excel or XML format are
supported. These spreadsheets include the Vessel Equipment List, Pump Equipment List,
and Heat Exchanger Equipment.
 Stockpile items that come from importing Aspen Basic Engineering data can be easily
updated by re-importing a data file. Previously imported items, whether they remain in the
stockpile or have already been placed in the drawing, are updated with data from the newly
imported file.
 Importing Aspen Basic Engineering XML data files allows greater flexibility when importing
data into the software. All three reports: Equipment, Pumps, and Exchangers, are included
in a single XML report so that only one file has to be imported.
 You can use the Equipment List, Pipe Run List, and Equipment Nozzle List Reports to
define properties of items already placed in the drawing, too. Items must have an assigned
item tag prior to definition or modification of properties. In addition, these reports can create
occurrences of items in the stockpile.
 For more information on import code and other importing parameters, see the Import
Implementation Customization topic in the SmartPlant P&ID Programmer's Guide. To view
this file, on the Start menu, click Intergraph SmartPlant P&ID > Programming Help.
Create a New Pump by Importing a SmartPlant P&ID Report

into the Stockpile
1. Open a drawing that includes a pump with an item tag, for example, P-100A.
2. Run the Equipment List report. For more information on generating reports, see Generate
a Report for an Active Drawing (on page 224).
3. In the resulting report, change the value in the Item Tag cell by highlighting the last column
in the report and the column right next to it, then clicking Format > Column > Unhide. The
path name of the associated symbol is available in column T. Columns Y, Z, and AA display
the Tag Prefix, Tag Sequence Number, and Tag Suffix properties, respectively.

5. Click File > Close.

6. In SmartPlant P&ID, click File > Import > Data file.
7. Browse to the Equipment List report that you just created and modified.
8. Click Open.
 Importing new pipe runs using the Pipe Run List report is a little different because it also
includes SP_ID and Fluid Code columns. The method above is valid, but you must be
careful with row copy and paste because the layout is a little different. Additionally, you must
clear the SP_ID value.
 The delivered Item Tag format for pipe runs is unit code - tag sequence number - tag suffix -
fluid code.
Typicals
A typical is a user defined, graphical representation, of a group of objects and their
relationships. On a drawing, a typical marks the position of where similar groups of objects
should appear but have been hidden from view. For example, on a drawing a typical that
contains a series of pipes, a pump, and valves, informs the viewer that at this position on the
drawing there is more than one group of objects that consist of a series of pipes, a pump, and
valves, but have been hidden from view to make the reading of the drawing clearer. To know
exactly what the hidden objects are the viewer needs to switch views, from the primary view to
the typical view. In the typical view the viewer sees all the typicals and their attributes. Though
only the primary typical appears on the primary view, all the typicals and their relationships with
the primary view are maintained. A typical can be repeated any number of times and can
contain any objects/symbols depicted in the P&ID symbol catalog used to convey the logical
plant model, including off-page connectors.
Auxiliary Graphics cannot be viewed on the Typical layer.
Typicals Common Tasks

The following tasks are used when you create and use Typicals in your process drawings.
Select a View
When creating a typical after selecting the Create Typical command, the software automatically
switches to the typical view. This procedure shows you how to switch between the primary and
typical views, to view already created typicals, and how to view the primary and typical views at
the same time.
For more information, see Select a View (on page 175).
Comparing Drawings and Typicals

You can compare between different versions of a drawing and its typicals using the Tools >
Compare and Refresh command in SmartPlant P&ID (after creating a new version in
SmartPlant P&ID Drawing Manager), or the Version and Compare functions of SmartPlant
P&ID Drawing Manager. For more information on comparing drawings with SmartPlant P&ID
Drawing Manager, see Working with Drawing Versions and Revisions in the SmartPlant P&ID
Drawing Manager User's Guide.

For more information on comparing drawings with SmartPlant P&ID, see Comparing and
Refreshing Versions (on page 199).
Print a Typical View

This procedure shows you how to print typicals as they appear in the typicals view. You can
print the view from within SmartPlant P&ID or using SmartPlant P&ID Drawing Manager.
For more information, see Print a Typical View (on page 176).
Create Typical Command (Edit Menu)

Creates a typical from the selected items in the primary view, and opens the typical view for
placement.
Select a View
1. To select the primary view, do one of the following:
 Select View > Show Primary.
 Right-click, and from the shortcut menu select Show Primary.
 On the Typicals toolbar, click

2. To select the typical view, do one of the following:
 Select View > Show Typical.
 Right-click, and from the shortcut menu select Show Typical.

3. To select both views, do one of the following:
 Select View > Show Both.
 Right-click, and from the shortcut menu select Show Both.
 Depending on the selected view, Primary, Typical, or Both is displayed in the status
bar, also the respective menu commands and icons on the Typicals toolbar are grayed
out.
 When viewing in the Both view you can identify which items are typicals and which are
not, by selecting an item and looking at the Is Typical property in the Properties
window. If the value is True, the selected item is a typical.

Show Primary Command (View Menu)

Displays the primary view sheet.
This command is only active when the typical view or both views are active.
Show Typical Command (View Menu)

Displays the typical view sheet.
This command is only active when the primary view or both views are active.
Show Both Command (View Menu)

Displays the both the primary and typical view sheets overlaid one on the other.
 This command is only active when the primary or typical view is active.
 The AutoGap and the Gap Now commands are disabled in this view.
Move to Primary Command (Edit Menu)

Moves selected objects from the typical view to the primary view.
Move to Typical Command (Edit Menu)

Moves selected objects from the primary view to the typical view.
Print a Typical View

Print from SmartPlant P&ID
1. Display the typical view you want to print.
2. Click (Print).
3. Select the required settings on the Print dialog box. For more details, see the Print dialog
box.
4. Click OK.
Print from SmartPlant P&ID Drawing Manager

1. From the List view, select the drawing containing the typical view you want to print.
2. Click (Print).
3. On the Print dialog box, select the Typicals only check box.

4. Select the required settings on the Print dialog box. For more details, see Printing
Multiple Drawings in SmartPlant P&ID Drawing Manager Online Help.
5. Click OK.
Gapping Lines
A gap in a drawing is a condition that exists when two lines intersect graphically in the drawing
but not physically in the plant.
AutoGap Command (Tools Menu)

Turns automatic gapping on or off in the drawing. Gapping refers to the condition that exists
when two lines intersect graphically on the drawing but do not physically intersect in the plant.
Gap Now Command (Tools Menu)

Performs gapping on the current drawing, that is, on the entire drawing. Gapping refers to the
condition that exists when two lines intersect graphically on the drawing but do not physically
intersect in the plant.
System Editing
System Editing allows propagation of property values between related items. If you select
Tools > System Editing and a check mark displays by the command, the function is
active. You can also turn on System Editing by clicking . When the command is active and
you make changes to properties in a drawing, those changes are propagated according to
relationships and rules. If the Enable System Editing setting is set to Yes in Options Manager,
then every P&ID drawing in the plant will have System Editing enabled. You can turn System
Editing off but when you turn it back on, it does not attempt to propagate any prior drawing
changes.
Editor display is automatically updated.
 System Editing is not supported from or to plant item groups such as loops and packages.
The flow of property values is as follows.
 Properties — The properties that can flow across this relationship are those that are listed
as consistency criteria in all of the applicable rules.
 Copy and Propagate — A property value can be copied in either direction across the new
relationship and is propagated outward.
 For new items, existing values are not overwritten by this process unless one item contains
a Null property value. For example, if different nominal diameter values exit on both sides of

a new connection, the existing nominal diameter values are not automatically changed to
match unless one of the values is set to Null.
When a directional property, for example, Flow Direction and Slope Direction, is propagated, it is
not enough to set the same value on all items the propagation scope. The direction of the
underlying geometry must be compared to the direction of the geometry of the start item. One
of the possible property values must be selected based on the direction of the geometry. In
cases where the direction of the geometry cannot be compared (such as a midpoint branch
condition) no propagation is possible.
The Scope of System Editing

Connectivity — All objects that are connected to the selected object are candidates for
inclusion in the propagation (System Editing) process.
Rules — The consistency criteria specified in rules define which properties are propagated and
in which direction. The propagations scope can be expanded across a relationship if there is an
applicable rule for the property being modified.
Inconsistencies — The propagation scope is not expanded past an existing inconsistency for
the property being modified. Using System Editing does not resolve inconsistencies. You
must resolve the inconsistency.
Breaks (Break Labels) — Propagation breaks can be defined for specified properties at
specified relationships in a design. The propagation scope is not expanded past a break for the
property being modified.
Break Components — Components can be defined with an option to break the nominal
diameter or with a filter defining other specified properties that will break at that item. The
propagation scope is not expanded past a break component for the property being modified.
Access Control — When working in a project, the propagation scope only includes objects that
have been claimed.
Highlighting — All items that will be changed when a user is ready to change a certain property
(clicking in a particular property field in the Properties window or picking a solution in the
Consistency Check Solutions list) will be highlighted so that the user can see the scope of the
items for which the particular property will be changed. This scope can vary according to the
particular property being modified.
When making a graphical selection of a pipe route, initially only the connector piece of a
pipe run is highlighted. However, because the data is stored by pipe run, even if system editing
is switched off, the entire pipe run will have its data changed. To see how far a particular pipe
run extends, you can turn system editing off and click in the Properties window on any property
of that pipe run. The software will then highlight the entire pipe run.

System Editing and Consistency Checking

You can effectively propagate a changed property value across drawing boundaries. If a
changed property value is propagated and it reaches an OPC, it simply stops at that point. An
inconsistency indicator at the OPC shows that the value in the active drawing is inconsistent
with the value on the connected pipe in the continuation drawing. To resolve this type of
inconsistency, the user must open the continuation drawing. With the continuation drawing
open, the user can double click on the inconsistency indicator to display the Consistency
Check dialog. One of the solutions available for resolving inconsistencies is to copy the property
value from the first drawing into the active drawing. When this solution is used, the property
value from the pipe run in the first drawing is copied to the pipe run in the active drawing and
spreads outward from there according to the standard propagation rules. Thus, property values
can be propagated across document boundaries.
Inconsistencies — System Editing never expands across an inconsistency for the property
being propagated. For a given set of connected items with a consistent property value, System
Editing allows you to easily change that value to a new value. However, if the items are not
consistent to begin with (inconsistencies exist), then System Editing will not automatically make
them consistent. Other tools are available (such as Solutions on the Consistency Check
dialog box) for resolving inconsistencies.
Break Components — Some components inherently limit the copying and suppress the
consistency checking of certain properties. For example, a reducer is a break component for the
Nominal Diameter property. When changing the Nominal Diameter in a pipeline, the spread of
that change is limited by any reducers that exist in that pipeline. The consistency checking that
would normally be done between the connected pipes is also suppressed at the reducer.
A break component can be created for any property or collection of properties of a pipe run. To
create a break component, you must first create a special filter. This filter must apply to pipe
runs and must include the properties to be broken as criteria in the filter. The value for each
property in the filter is not important. The final step in creating a break component is to open the
symbol in Catalog Manager and select the Property Breaks command to select the filter.
Break Labels — The consistency criteria specified in the rules define the general behavior of
the properties. Break labels provide a way to define exceptions to the general rules. A break
label provides a visible and plottable symbol that signifies the end of one property value
condition and the beginning of a new condition along a pipe. A changed property value is never
propagated across a break label for that property. A break label also suppresses consistency
checking for the property it breaks.
A break label can be created for any property or collection of properties of a pipe run. A break
label is created in the Catalog Manager just like any other label, except that the Label Type
property is set to Attribute Break. A SmartText field must be created for each property that is to
be broken. In many cases the graphical shape of the label indicates which properties are
broken. In these cases the Visible flag on the SmartText is set to False so that the text is not
visible. It is also normal to turn the leader line on within the Catalog Manager so that it is
automatically displayed at placement time. All of the symbols under Piping\Segment Breaks in
the delivered catalog are break labels.

System Editing and Projects

When working in a project, the system enforces the rule that unclaimed objects cannot be
modified. If you select an unclaimed object, the Properties window does not allow you to enter
new values for its properties. Similarly, System Editing does not allow property values to flow to
unclaimed objects.
If you have a claimed object that is connected to some unclaimed objects, and if you change a
property on the claimed object, propagation will not change the property value on the unclaimed
objects. The items in the propagation scope are initially collected using the standard
propagation rules. However, all unclaimed items are removed from the propagation scope
before any property values are changed.
Items that are claimed for relationship are treated as unclaimed for the purpose of propagation.
System Editing Command (Tools Menu)
When System Editing is enabled for a plant, changed property values are automatically spread
or propagated to related items according to the currently defined consistency criteria. In certain
cases, you may want to set a property value on one item only and not allow it to be propagated
to any related items. The System Editing command (on the Tools menu and the toolbar) allows
you to turn off the propagation functionality temporarily during a design session. After the
change has been made, you can use this same command to turn it back on again. System
Editing is always turned on when you start a new design session.
System Editing can be enabled or disabled for the entire plant by means of the Enable System
Editing setting that is exposed through Options Manager. For new plants, the value of this
setting is True by default. For upgraded plants, the value of this setting is False. This allows you
to enable System Editing for an upgraded plant at the time of your choosing.
Enable System Editing

 Select Tools > System Editing or click .
System Editing can be turned on or off for an entire plant for as long as desired or for a
single design session.
Using Filters to Create and Apply Display Sets

Apply Display Set Command (View Menu)
Opens the Apply Display Set dialog box, where you can specify which symbols display in the
Drawing View.
Clear Display Set Command (View Menu)

Removes the results displayed by selecting the Apply Display Set command.

Apply Display Set Dialog Box

Specifies which symbols display in the Drawing View. You can create filters that define which
symbols you want to display. Click View > Apply Display Set to open this dialog box. You can
save these filters and share them with other users working in the same Plant. You can also
define colors and widths for display items. If a display set is currently active, its name displays
in the lower right-hand corner of the product.
To remove the results displayed by selecting the Apply Display Set command, select View >
Clear Display Set.
Any display tabs created in previous versions of SmartPlant P&ID can be converted to a
display set using the macro UpgradeTabsCMD.dll. The new display set will display in My
Display Sets folder.
Add Folder — Adds an empty folder to the Tree. You can use Rename to define a name
for the folder. These folders can be used to organize display sets.
Add Display Set — Creates a new display set. You can use Rename to define a name for
the new display set.
Add Filter — Displays the Select Filter dialog box. Select any displayed filter to add it to
the current display set.
Save — Saves the selected display set.
Cut — Removes the selected display set and places it in memory.
Copy — Copies the selected display set into memory.

Paste — Pastes any values that are currently stored in memory.
Delete — Deletes the selected item.
Rename — Allows you to click on an item in the Tree and rename it.
Move Up — Allows you to move the selected filter name up in the list.
Move Down — Allows you to move the selected filter name down in the list.
Properties — Displays the properties of the filter.

Filter Name — Displays a list of filter names. These filters are defined using the Add Filter
command.
Color — Displays the color of the selected item for your display set. You can click in the Color
field to display a color palette and then select any color to define a new color for any selected
item(s). The default color square is defined with the crosshatch pattern. Default is the
color value specified in Options Manager for the item type's symbology.
Width — Displays the selected display width of items defined in the selected filter. A wider
display width would cause the item to be more visible. Default is the width value specified in
Options Manager for the item type's symbology.
Apply — Applies the active display set on the drawing.
For a display set that contains one or more asking filters, on clicking Apply, the Asking
Filters dialog box opens with the default values for each asking filter, allowing you to change the
operators and values of each asking filter's attributes, if desired. The attribute values you
selected are used when saving or printing the drawing and those values are retained until the
display set is cleared for that drawing. This applies on a per drawing basis; therefore if the same
display set is applied to more than one drawing, you can enter different attribute values for each
asking filter and those values are retained independently for each drawing.

Define a Display Set

1. Click View > Apply Display Set.
2. Select the My Display Sets folder or the plant folder, and on the toolbar, click Add Display
Set .
3. Type a name for the display set.
4. Right-click the display set and on the shortcut menu, click Add Filter.
5. On the Select Filter dialog box, do one of the following:
 Browse to an existing filter and click OK to add that filter to the display set.
 Browse to the desired folder and click New to create a new filter under that folder.
For more information about creating filters, see the SmartPlant Filter Manager User's
Guide topics: Create a New Simple Filter and Create a New Compound Filter. (The
SmartPlant Filter Manager User's Guide is available in the SmartPlant Engineering Manager
installation.)
6. For a new filter, do the following:
a. On the New Filter dialog box, select whether to create a simple or compound filter.
b. Create the filter with the desired properties.
c. Click OK to close the Add Filter dialog box for each simple filter that you create.
7. Click OK to close the Select Filter dialog box and return to the Apply Display Set dialog
box with the selected filter added to the display set.
8. For each filter in the display set, select the desired color and width of the drawing item lines
to be applied by that filter.
To hide an item on the drawing sheet, select None for the color.
Filtering behavior for label colors depends on the value of the Filter for property in the
label filter and the Do not show labels for filtered items check box setting on the View
Properties dialog box Display tab (the Labels check box must always be selected to enable
the Do not show labels for filtered items check box). The following table summarizes the
behavior.
'Filter for' value 'Do not show Resultant Behavior when Applying Display Set
labels...' setting
Label: Model Item Selected Label colors are independent of model item colors;
labels are hidden when model items are hidden.
Label: Model Item Cleared Label colors are independent of model item colors;
labels display when model items are hidden.
Label: Catalog Item Selected or cleared Label colors are the same as the model item
(optional) colors; labels are hidden when model items are
hidden.

Apply a Display Set

1. Open a drawing.
2. Click View > Apply Display Set.
3. On the Apply Display Set dialog box, under the My Display Sets folder or the plant folder,
select the desired display set.
4. If desired, change the color and width of the drawing item lines to be applied by the filters in
the display set.
To hide an item on the drawing sheet, select None for the color.
5. Click Apply.
 Filtering behavior for label colors depends on the value of the Filter for property in the label
filter and the Do not show labels for filtered items check box setting on the View
Properties dialog box Display tab (the Labels check box must always be selected to
enable the Do not show labels for filtered items check box). The following table
summarizes the behavior.
'Filter for' value 'Do not show Resultant Behavior when Applying Display Set
labels...' setting
Label: Model Item Selected Label colors are independent of model item colors;
labels are hidden when model items are hidden.
Label: Model Item Cleared Label colors are independent of model item colors;
labels display when model items are hidden.
Label: Catalog Item Selected or cleared Label colors are the same as the model item
(optional) colors; labels are hidden when model items are
hidden.
 When specifying line widths for display sets, you can set label graphics and leader lines to
appear in the default width of the labels regardless of the line width value specified for model
items. This option is specified by using a key 'IgnoreDisplaySetWidthOnLabels' under the
'Options' section of the SmartPlantPID.ini file (located in the users\<username> folder) as
shown:
[options]
WaterMarkWhileWorking=True
WaterMarkWhilePrinting=True
undosteps=0
autogapping=False
ConsistencyChecks=True
.
.
.
IgnoreDisplaySetWidthOnLabels=1

The following table shows how the values assigned in the SmartPlantPID.ini file affect the
output.
Key Value Resultant Behavior when Applying Display

Set
IgnoreDisplaySetWidthOnLabels=1 Label line widths are independent of model item

line widths; label line widths are set to default
value for labels.
Label line widths are independent of model item
line widths; line widths of label graphics and
leader lines are set to the default value for labels.
IgnoreDisplaySetWidthOnLabels=0 Label line widths, including graphics and leader

lines, are the same as the model item line widths.
No key Label line widths, including graphics and leader

 For a display set that contains one or more asking filters, on clicking Apply, the Asking
Filters dialog box opens with the default values for each asking filter, allowing you to change
the operators and values of each asking filter's attributes, if desired. The attribute values you
selected are used when saving or printing the drawing and those values are retained until
the display set is cleared for that drawing. This applies on a per drawing basis; therefore if
the same display set is applied to more than one drawing, you can enter different attribute
values for each asking filter and those values are retained independently for each drawing.

Asking Filters Dialog Box

This dialog box appears when you apply a display set that contains at least one asking filter to a
drawing. For each asking filter in the display set, you can choose the operator and value of the
filter's attributes.
Select filter to edit

Displays all asking filters defined for the selected display set. Select a filter to display its details
in the right pane.
Filter details
Displays the details of the selected asking filter. Name, Item type, Match all / Match any, and
Attributes fields are read-only. You can change the Operator and Value for each attribute as
desired.
Update Symbology Command (Tools Menu)
Updates the line width and color symbology for your active drawing.
Linking and Embedding Objects

For SmartPlant P&ID Engineering, it is not possible to link or embed objects, therefore the
commands on the Insert menu are disabled.

Insert > Image Command (Edit Menu)

Opens the Insert Image dialog box.
Insert > Object Command (Edit Menu)

Opens the Insert Object dialog box.
Links Command (Edit Menu)

Opens the Links dialog box.
Check Symbol Paths

1. Click Tools > Custom Commands.
2. On the Custom Commands dialog box, double-click CheckFilePathCmd.dll.
You can find this macro in the ..\SmartPlant\P&ID Workstation\bin folder.
The CheckFilePathCmd macro checks the directory paths in the file names of all symbols
used in the plant, and it creates a log file that reports all symbols missing from the current
catalog. The log resides in your Temp directory and is named CheckFilePathsFor_yourplant.log.
Working with Assemblies

An assembly is a group of items that you can place in a drawing at one time. Assemblies can
save time because you do not have to keep creating commonly-occurring groups of items.
Instead of copying and pasting each individual item into a drawing at several locations, you can
place the group of items: the assembly. An example of an assembly is a control valve with vents
on both sides, an instrument loop that controls the valve, and a piping bypass around the valve.
You can create an assembly by selecting several items in a drawing and saving as an assembly.
The file extension for an assembly is .pid, which is the same file extension as a drawing. If you
want to retrieve the assembly from the Catalog Explorer tree view, you must save the
assembly where the other symbols are located. The Save as Assembly command prompts you
to save the assembly in the correct directory, which is specified in Options Manager.
Placing assemblies is like placing any other item from Catalog Explorer into a drawing. When
you want to place an assembly into a drawing, you select the assembly from Catalog Explorer
and click a location in the drawing. Or, you can drag the assembly into the drawing. The
information in each label remains intact when you place the assembly. After you have placed an
assembly, the items in the assembly are treated as separate items. You can delete just one item
without concern that the software deletes the entire assembly.
Assemblies cannot be placed inline. You must place the assembly first and then route piping to
it, if required.

Assemblies can be created in one plant and used in another. However, the file structure
and symbols must be identical. If you try to place an assembly into a plant that uses a different
file structure, you get an error message that the software cannot find your reference files. The
assembly placement quits. Move the symbols that cannot be found to the location indicated in
the error message.
When creating or placing assemblies, a log file is created for each action. The log files are
placed in the Temp directory and are named <AssemblyName>_CreAsm.log and
<AssemblyName>_PlaAsm.log.
The following is an example of the log file created when creating assemblies.
Source Drawing Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\Drawings\38\38-PI- 0001.pid
Assembly Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\RefDatA\P&ID Reference
Data\Symbols\Assemblies\Equipment\VesselAssembly.pid
Number of graphic items processed = 1
Number of database items processed = 1
Number of attributes processed = 15
Finished creating assembly.
The following is an example of the log file created when placing assemblies.
Assembly Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\RefDatA\P&ID Reference
Data\Symbols\Assemblies\Equipment\VesselAssembly.pid
Target Drawing Name: \\sppid-
training\Site_4_3_25_1\Plant_4_2_36_1A\Drawings\38\38-PI- 0001.pid
Number of graphic items processed = 1
Number of database items processed = 1
Number of properties processed = 15
Finished placing assembly.
Save as Assembly Command (File Menu)

Saves selected items as an assembly.
. For SmartPlant P&ID Engineering, this command is disabled.
Create an Assembly
1. Select several components in the drawing.
 You can select more than one item at once by dragging the pointer to fence objects.
 To remove an item from the selection, click it while pressing CTRL.
2. Click File > Save as Assembly.
3. Use the red target that appears at the end of your pointer to specify the origin of the
assembly for placement.
You can only use a standalone symbol as the origin of an assembly. For example, you
cannot use labels, pipe runs, signal runs, or child items; however, you can use unattached
ends of pipe runs.

4. On the Save as Assembly dialog box, enter the file name.

5. Click Save.
 Any graphics that have been band-aided should be deleted and replaced prior to using this
command.
 The file extension for assemblies is .pid.
 You can save an assembly in any directory that you want, but the default assembly path is
specified in Options Manager. If you use the default folder, then you can retrieve the
assembly from Catalog Explorer. In order to save assemblies, you must have write
permissions to the folder defined in Options Manager.
 Assemblies can be created in one plant and used in another. However, the file structure and
symbols must be identical. If you try to place an assembly into a plant that uses a different
file structure, you get an error message that the software cannot find your reference files.
The assembly placement quits. Move the symbols that cannot be found to the location
indicated in the error message.


SECTION 5
Working with Drawings in Projects

After enabling and creating projects in SmartPlant Engineering Manager, use Drawing Manager
to manipulate the drawings. Actual design work is still accomplished in SmartPlant P&ID;
however, managing and setting out that work is largely controlled from the Drawing Manager
interface. Only the project can use the commands on the Project menu in Drawing Manager to
fetch, check in, and check out drawings.
Once projects are enabled in SmartPlant Engineering Manager, the As-Built can no longer
create drawings; drawings are created inside projects. However, any drawings that might have
existed in the plant before projects were enabled remain in the As-Built. All drawing versions in
the As-Built are read-only drawings when projects are enabled, but these drawings can still be
deleted in the As-Built, unless the drawing is either fetched or checked out to a project. If the
plant is registered in SmartPlant Foundation, drawings can be created and edited in the As-Built,
except for drawings that are checked out to a project.
When you are using projects inside SmartPlant P&ID, remember that the reference data
belongs to the Plant and is used by projects of the As-Built. You cannot change reference data,
such as table layouts or formats or rules, at the project level.
Projects and Claiming

One of the main capabilities associated with using projects in an integrated environment is the
ability for a project to claim a drawing object. When a project claims an object, the project
controls modifications to that object. A project cannot modify objects it has not claimed. All the
modifications and claiming of objects is carried out in the design software, but the claim states of
objects inside drawings do have ramifications for drawing manipulation and for completing
projects. You do not need to check out a drawing to claim items on it; you can claim items on a
fetched drawing.
 Projects claim objects in either Exclusive (default) or Shared mode. If you plan to use the
project in an integrated environment, Shared mode is mandatory. Use the Settings view in
Options Manager to set the Claim Mode before creating a project.
 When publishing from a project, an instruction container, which contains all the claimed
objects, is created within the tombstone file. Therefore, if you create a new item in a project
and you want that item to be included in the instruction container, you must first merge that
item to the As-Built and then claim it back to the project.
 You can change the Claim Mode to Shared at any time. However, you can change the mode
to Exclusive only when there are no claims in any project in the Plant.

Working with Off-Site Projects

SmartPlant P&ID uses standalone workshare functionality to implement off-site projects. For
details, see Using Workshare in the SmartPlant P&ID Drawing Manager User's Guide.
Claiming Items
A project in the Plant frequently deals with a subset of items within a drawing. The Claim
functionality provided by SmartPlant P&ID allows you to grant control of an item to a project.
Since claiming makes it possible for a project to work on an item-by-item basis, claiming fosters
an ability to define the scope of work as narrowly as necessary.
However, when an existing drawing is fetched or checked out to a project, none of the items on
that drawing are initially claimed. Before you can modify any of those items, you must claim
them.
After you have claimed an item, you can modify it using the same methods that you would use in
a plant that is not project enabled.
Properties of items that are not claimed by the active project cannot be changed. The
Properties window and the Engineering Data Editor do not allow editing of properties on items
that are not claimed: the properties are read-only as if the drawing is in a read-only state. No
other explicit prompts let you know that you cannot edit an item that you have not claimed.
However, you can manipulate the Drawing view properties so that the claim state of items is
visually apparent.
You do not need to check out a drawing to claim objects; you can fetch a drawing with read/write
permissions and claim its objects. Claim commands appear on shortcut menus in the Drawing
view, in the Engineering Data Editor, and on the Edit menu.
Releasing Claims
From inside a project, you can invoke a claim at any time to expand the scope of your project,
and any new item created in a project is automatically claimed by that project. You can also
release a claim at any time, but you cannot release the claim that is automatically created when
your project creates a new item.
Claims are automatically released on all drawing items when that drawing is checked into the
Plant; however, a drawing cannot be checked in if any objects that are not claimed differ from
the Plant.
Claim Mode
The claim mode can be set to either Exclusive or Shared by using the Settings option in
SmartPlant P&ID Options Manager. The claim mode controls how items are claimed by
concurrent projects.
If the claim mode is set to Exclusive, only one project can claim an item at any given
time. Exclusive mode enforces the rule that concurrent projects do not overlap at the object
level. With this setting, conflict resolution at check in time is simplified.
If the claim mode is set to Shared, a single item can be claimed to more than one
project. Shared mode allows concurrent projects to overlap at the object level. This setting

may be required for plants that have overlapping projects. Conflict resolution at check in time
will be more complex.
Invalid Claims
When an item is claimed by a project, it must be consistent with the state of the item in the
Plant. Otherwise, an invalid claim exists. Invalid claiming can happen only for Plants that support
shared claiming of database items. Invalidly claimed items differ from the Plant items in that you
cannot modify them and check a drawing into the Plant without first establishing a valid claim.
When the Plant uses Shared claim mode and a project checks in a drawing, the claims made by
other projects to objects on that same drawing are now invalid if the project that checked in the
drawing also changed an item claimed by a different project.
You can determine the validity of a claim by using the Claim Status command. Invalidly claimed
items cannot be modified.
If an invalid claim is found but the item in question matches the item in the Plant, run Verify for
Check In to resolve the situation. This process automatically sets the claim to valid and allows
the check in to occur.
Partial Claim
When an item has a relationship with another item that has been claimed, but is not itself
explicitly claimed, it is said to have Partial Claim status, denoted by . Partial claim only
applies to objects connected to pipe runs (inline components such as instrumentation and piping
components).
Partial claim works automatically when a claimed pipe run is ‘broken’. There is a routine that
determines which side of the broken pipe run gets the new GUID and which side maintains the
original GUID. Inline components on the side that gets the new GUID receive Partial Claims
status, which is only for the purpose of changing their database relationship to the pipe run with
new GUID. Data cannot be edited on items that are ‘claimed for relationship purposes’.
 A list of claimed items is automatically published to SmartPlant.

 Claim commands are not available when you open a fetched drawing with read-only
permissions.
 Claiming of labels is ignored.
 Drawing Manager is the only tool for checking in, checking out, and fetching drawings.
 You must have full control user access permissions for P&ID Objects before you can claim
objects. For more information about setting user access permissions, see SmartPlant
Engineering Manager Help.
 Remember that objects are claimed by the project, not by a single user. Once a project
claims an item, it can be modified by anyone with the appropriate permissions in that project.
 In Exclusive claim mode, the software allows the user to claim all the selected items that
were not already claimed by other projects. The claim log shows which items could not be
claimed because they were already claimed by other projects.
 Claiming items clears the Undo stack. Thus claiming is not a command that can be
undone.

See Also
Claim Command
Gives control of the selected items to the current active project. The Claim dialog box opens,
allowing you to confirm the "claim-ability" of the items and enter claim comments. Claim
comments can be viewed later by anyone in the Plant when the claim status is displayed.
This command can only be used for items that belong to the active drawing.
See Also
Claim Dialog Box

Opens when you select an item and click Edit > Claim on the main menu bar and displays
details of the items that you select for claiming. You can discover if the selected items are
already claimed by your project or another project. The Claim command checks first if your
project already has a valid claim on a selected item. Next it checks if the items are claimed by
another project, and if the Plant uses exclusive sharing, this step can produce an error display
on the Claim dialog box. Finally the command compares the selected items against the same
items in the Plant and displays a warning if an object either differs from that item in the Plant or if
the object does not exist in the Plant.
Items to be claimed — Lists the items that are selected in the Drawing view or Engineering
Data Editor and their details. These are the items that you claim to your project when you click
OK. You can select multiple elements of this list and record comments for this claim operation.
In this list, you can also see if a selected item is already claimed or has any other claim errors or
warnings associated with it.
Comments — Allows you to record comments for the claim operation that you are currently
undertaking.
Claim a Drawing Item

1. In the Drawing view or Engineering Data Editor, select the items that you want to claim.
2. Click Edit > Claim.
3. On the Claim dialog box, record comments about this claim operation. In the Items to be
claimed list, fill in the Comments box. The comments will be applied to all the items in the
Items to be claimed list.
 Remember that objects are claimed by the project, not by a single user. Once a project
claims an item, it can be modified by anyone with the appropriate permissions in that project.
 In Exclusive claim mode, the software allows the user to claim all the selected items that
were not already claimed by other projects. The claim log shows which items could not be
claimed because they were already claimed by other projects.
 Claiming items clears the Undo stack. Thus claiming is not an undoable command.
 You can only claim an item in the Engineering Data Editor if that item belongs to the active
drawing.

Enforcing Claims
Whether you are using shared or exclusive claiming mode, claiming objects to your project
involves many special relationships. The following topics discuss some of the ways that claiming
restricts your activities.
The claim mode (Exclusive or Shared) is defined in Options Manager for the Plant and all
its projects. When you claim an item, it is claimed to your active project. No items are ever
claimed by the Plant.
See Also
Controlling Access (on page 195)
Modifying Properties (on page 195)
Controlling Access
Each command in the software checks your permissions for the items that it modifies. When
possible, commands simply do not allow the operation to proceed if you do not have the
necessary permissions.
You must have full control permissions on P&ID Objects before you can claim any drawing
items. For more information, see User Access in SmartPlant Engineering Manager Help.
Modifying Properties
Claiming impacts properties modifications in the following manner.
Properties Window
When you select a claimed item, the Properties window allows the properties of that item to be
viewed and modified. When you select an item that has not been claimed, the Properties
window allows the properties to be viewed but not modified. The properties of unclaimed items
are read-only.
When you select a line segment, the Properties window displays the properties of the
associated pipe or signal run. If the run has been claimed, the properties can be edited;
otherwise, the properties are read-only.
When you select multiple items, if they are all claimed, the Properties window allows them to be
modified. If any of the selected items are not claimed, the Properties window treats the whole
group as read-only.
Engineering Data Editor (EDE)

If the item has been claimed, you can edit its properties through the EDE; otherwise, the EDE
treats the item properties as read-only. The EDE behaves similarly to the Properties window.
Consistency Check Dialog Box

The Solutions section of the Consistency Check dialog box allows you to copy property
values from one item to another. For the selected solution, if the destination item is not claimed,
the Apply button is not available.

Implied Items
When a drawing item is claimed, it means that you can modify that model item and all of its
implied items. If a model item is not claimed, the user cannot modify any of the implied items
that the model item owns.
Moving Between Stockpiles

The Move to Different Stockpile command in the Engineering Data Editor allows you to move
an item from one stockpile to a different stockpile. The selected model item must be claimed
before you can use this command (if you are using a Project).
See Also
Validating Properties
The software uses validation functions before setting properties on items. The software checks
the claim status before setting any values. If the item is claimed, the property can be changed. If
the item is not claimed, the property cannot be changed. For more information about validating
properties, select Start > Programs > Intergraph SmartPlant P&ID > Programming Help and
see the Extending the Capabilities of SmartPlant P&ID and Logical Model Automation
Reference topics.
From version 2009, you can use the validation and calculation functions on drawing item
type. The software uses the same automation interface managing all other item types.
To Do List and Correlating Items

Claiming impacts the To Do List and other SmartPlant commands in the following manner.
For SmartPlant P&ID Engineering, it is not possible to run Create or Delete tasks.
Create Task — Running a Create task creates a new item in the stockpile. The new item is
claimed automatically as soon as it is created.
Update Task — Running an Update task sets or changes some properties of an existing item.
The item to be updated must be claimed before it can be updated. If it is not claimed, the task
status is set to Error and a note is added to the Notes area on the General tab of the Task
Delete Task — Running a Delete task causes the target item to be deleted. The item to be
deleted and possibly other related items must be claimed before the task can do its work. If all of
the necessary items are not claimed, the task status is set to Error and a note is added to the
Notes area on the General tab of the Task Properties dialog box.
Correlate Items — The SmartPlant > Correlate command correlates pipe runs to the same
design basis as an existing pipe run that is already correlated. Properties are copied from the
primary pipe run to the other pipe runs. You must claim the pipe runs to be modified. If they are
not claimed, they cannot be correlated.

Release Claim Command

Displays the Release Claim dialog box and allows you to relinquish control (by your project) of
the selected items. This dialog box also displays when you attempt to unclaim an item that has
been modified in the project. Claims must be released before projects can be completed or for
other projects to be able to check in drawings with changes.
 If you are working in SmartPlant environment and there are any differences between an item
in the Project and an item in the As-Built, the claim cannot be released. If you are not
working in the SmartPlant environment, the claim can be released. Also, items that display
no warnings or errors are released.
 This command can only be used for items that belong to the active drawing.
Release Claim Dialog Box

Opens when you select an item and click Edit > Release Claim on the main menu bar and
displays details of the items that you select to be released from claiming.
Items to be released — Lists the items that are selected in the Drawing view or Engineering
Data Editor and their details. These are the items that you release from your project when you
click OK. You can select multiple elements of this list if desired. In this list, you can also see if a
selected item has not been claimed nor does it have any other errors or warnings associated
with it.
Release a Claim
1. In the Drawing view or Engineering Data Editor, select the items for which you want to
release claims.
2. Right-click the item or select set and click Release Claim. If there are any errors or
warnings during the release, the Release Claim dialog box displays. Review any warnings
and error messages about each item.
3. Click OK to complete the claim release operation.
 You cannot release the claim on an item that is claimed to your project if it is a new item that
was created in your project.
 You can also release claims on items when you display their claim status. For more
information, see Display the Claim Status of a Drawing Item (on page 199).
 You can only release the claim on an item in the Engineering Data Editor if that item
belongs to the active drawing.

Claim Status Command

Opens the Claim Status dialog box, which displays the details of the claimed state of the
selected items and enables you to claim items, release the claims to items, and so forth. You
must select the items in the Drawing view or the Engineering Data Editor before using this
command.
Opens when you select one or more items and click Edit > Claim Status on the main menu bar.
You can review the details of the claimed state of the selected items, claim items, release the
claims to items, and discover other details of the claim status. To perform an action on an item
(claim, release claim, or show details), you must first select the row of the item. Hold down
CTRL or SHIFT to select multiple items.
Item Tag — The tag that identifies the item. If a selected item that appears in this dialog box
does not have an item tag, the value is blank.
Item Type — The item type to which the item belongs, for example: Mechanical, Nozzle,
PipingComp, SignalRun.
Claimed — Indicates the claim status of items claimed in the current project. An item claimed
by your active project is denoted by ; an item with an invalid claim on it is denoted by ; an
item which has a relationship with another item that has been claimed, but which itself was not
explicitly claimed is denoted by (partial claim); otherwise, this field is blank.
Claimed by Others — Indicates the claim status of items claimed by other projects. The
symbols are the same as for the Claimed column. If you are working in 'Exclusive mode', you
cannot claim an item that is already claimed by another project.
Claim — Opens the Claim dialog box, where you can claim the item and record claim
comments.
Release Claim — Releases the claim from your project. A confirmation message is displayed;
choose Yes to release the claim.
Details — Opens the Details dialog box, where you can discover what project has claimed the
selected item, the user that claimed it, and any claim comments that were entered when it was
claimed.
See Also
Details Dialog Box

Displays details about the claim status of the item that you selected in the Claim Status dialog
box. You can discover the project that has the claim, the user that claimed the item, and claim
comments that were entered when the claim was made. Since newly placed items are
automatically claimed by the project that places them, their claim comments are always "New
Item". This dialog box opens when you click Details on the Claim Status dialog box. You can
select all the items in the list by using CTRL + A, and clicking CTRL + C makes the selected
items available to paste into another document.
The New Item entry is automatically added to the comments for an item that is new to the
drawing. New items are automatically claimed to the project that created them.

Display the Claim Status of a Drawing Item

1. In the Drawing view or Engineering Data Editor, select the items for which you want to
display the claim status.
2. Click Edit > Claim Status.
3. On the Claim Status dialog box, review the information in the list of items.
4. To claim the items to your project, select elements in the list and click Claim.
5. To relinquish claims on those items by your project, select elements in the list and click
Release Claim.
6. To see more detailed information about the claim status of that item, the project that has
claimed the item, the user who claimed it, and any related comments, select an element in
the list and click Details.
Show Claims Command (View Menu)

Sets the appearance of drawing objects as it is specified in the Claims tab of the View
Properties dialog box. You can use this command to switch the claim symbology on and off.
Using the options on the Claims tab causes only the color and line weight to change, not the
line pattern.
Display Claim Status in the Drawing Symbology

1. Click View > Show Claims.
2. Click View > Show Claims again to turn off the display of claim status in the symbology of
drawing items.
 You define the line color and weight used to designate claim status on the Claims tab of the
View Properties dialog box.
 If you turn on the display of claim status in the drawing, then when you print the drawing, the
claim status will be plotted.
Comparing and Refreshing Versions

When more than one version of a drawing exists, you can view two versions side-by-side and
examine their differences by using the Tools > Compare and Refresh command. You can
compare two versions from inside your own Plant or project database, or you can compare a
version in your database to a version in the Plant or another project database. Keep in mind that
you can compare a drawing only against a version of itself; that is, you cannot compare one
drawing to another drawing.
Differences between drawing versions are assigned to logical change groups, which are listed
on the Change groups area of the Compare and Refresh dialog box. Differences display in
the following two categories.
 Graphic refers to an item that has changed only in its graphical representation in the
design; that is, the item is moved or otherwise graphically manipulated in the drawing.

 Data refers to a mismatch in the properties assigned to an item that exists in both drawings;
that is, a change, addition, or deletion of a property in the Properties window or
Engineering Data Editor in SmartPlant P&ID or through automation.
Every change grouping and every changed item is assigned a category, and if more than one
category applies (for instance, if you move an item and change one of its properties), then the
highest priority category is displayed.
Change details displays information about selected groups in the Change groups
area. Values for the Change details include the following.
 Add — Indicates that the selected group will be added to the version displaying on the right.
 Delete — Indicates the selected group will be removed from the version displaying on the
right.
 Modify — Indicates the selected group will be modified on the version displaying on the
right.
The two versions are displayed in two Drawing views, described as left and right views. The
relationship between the two views depends on whether you are comparing two versions in your
own database or comparing your version to a version in another database.
 Two versions are in the active database — The left-hand view is the older version, and the
right-hand view is the newer version. That is, they are displayed in time-order from left to
right.
 Two versions exist in different databases — The right-hand view is reserved for the version
in your active Plant or project database, and the left-hand view belongs to the version in
another database because you cannot be assured that time-order is the logical order to
display the versions.
You can also compare the differences between the typicals of either drawing. Using the select
list situated in the drawing name bar of each view, you can display the primary, typical, or both
views of the selected version.
 For SmartPlant P&ID Engineering, the refresh action is not allowed.

 When a plant item group is sent to the Plant Stockpile and after creating a new version of
the drawing, that plant item group is assigned to a piece of equipment or an instrument, the
Change column displays the value Delete. Plant Item Group types that are affected by this
behavior are: Contract Package, Hydro Test Package, Package, Instrument Safety Class,
Test System, and Hydraulic Circuit. If the plant item group is sent to the drawing stockpile,
the behavior is identical; however, the Change column displays the value Modify.

Compare and Refresh Command (Tools Menu)

Allows you to refresh the active drawing with data from another version of the drawing. The
differences display in what is known as a change group. If you accept the changes, the drawing
refreshes to display the changes.
To refresh a project drawing, you use the drawing in the plant. Change groups are marked if it
affects items you have claimed. Be sure to refresh all of the changes that do not involve
claimed items because these are the changes that have been checked in by other
projects. You want to include these changes in your drawing so they will not be lost when you
perform a check in.
In SmartPlant P&ID Engineering, this command is enabled; however, it is only possible to
view the differences between drawings — you cannot refresh the display.
See Also
Compare With Dialog Box

Opens when you click Tools > Compare and Refresh allowing you to select a drawing version
to compare against the version that you currently have open and active.
Available Databases — Lists all the different databases that currently have a version of the
drawing you chose on the Show History dialog box.
History — Lists all the versions of the chosen drawing in the database you named in the
Available Databases list.
See Also
Compare and Refresh Dialog Box

This dialog box opens when you click Tools > Compare and Refresh, displaying two versions
of the same drawing and indicating the differences between them. You can also refresh the
data to show any changes that were made while this dialog box is open.
You cannot do anything else in the SmartPlant P&ID modeler while this dialog box is open.
Toolbar Commands
The toolbar commands apply to the Drawing views.
For icons that display a drop down-arrow, you can apply the command to either the right
or left view.
Compare Options — Opens the Compare Options dialog box, which allows you to
customize the colors that the various comparison states are displayed in. That color coding is
then displayed in the status bar as a static reminder.
Print — Prints the Drawing view or views.
Generate Report — Opens Microsoft Excel and creates a report of the information
contained in this comparison session. This report lists the same information that is displayed in

the Change groups and Change details lists (change groups, item types, claim statuses, and
so forth).
Find in List — Zooms to the Change details list entry that corresponds to an item you
select in either Drawing view. In general, if you select a drawing item that exists in the list,
then the list display automatically zooms to that entry.
Find in Drawings — Manipulates the Drawing views so that the selected element is listed
in the Change details and the Change groups list is centered in the appropriate Drawing view.
You must first select an item in either the Change groups or Change details area.
Zoom Area — Enlarges the selected area in one or both Drawing views by allowing you to
draw a fence around the area.
Zoom In — Enlarges the selected area where you click.
Zoom Out — Reduces the display of the selected area where you click.
Fit — Fits all the drawing elements into the visible viewing area of the active
drawing. Selecting part of the drawing and clicking Fit fits the selected area into the visible
viewing area of the active drawing.
Pan — Allows you to move the display in any direction from a specific point in one or both
Drawing views in order to see other areas of the view by dragging the pointer across the
display.
Select — Changes the pointer to an arrow allowing you to select an item.
Help — Opens the Online Help.
Drawing Views
The left and right drawing views display the two versions of your drawing being compared. The
display above the drawing view shows the drawing name and the version. The select list in the
display allows you to choose the drawing layers to be compared and can be selected
individually for each version. Possible select list values are Primary, Typical, or Both.
If you compare two versions from different projects, the version that belongs to the other project
appears in the left Drawing view and the version that belongs to your active Drawing Manager
project appears in the right Drawing view. If you compare two versions from your active
project, then the latest version appears in the right Drawing view.
At the top of each Drawing view, the Plant or project, the name of the drawing, and the version
is displayed explicitly. You can move the bars between the different views according to your
needs. If you double-click on the divider between the left and right Drawing views, then the
software automatically adjusts the two views to be the same-size.
Properties Window
Displays two columns of properties for an item selected in a Drawing view or in the Change
details list. The left-hand and right-hand columns correspond to the left and right Drawing
views. If a deleted item is selected (the item exists in left view, but not the right view), the
properties for that item are listed in the left-hand column and the right-hand column is empty. If a
modified item is selected, values from both versions show in their respective columns in the
Properties window. If a new item is selected, that is, the item exists in right view, but not the left

view, the properties for that item are listed in the right-hand column and the left-hand column is
empty.
Properties Commands
Allows you to customize the properties that are displayed in the Properties window.
Alphabetical — Lists properties in alphabetical order. This button acts as a toggle and is
available when properties are displayed categorically.
Categorized — Displays properties grouped by specific categories. Categories are

defined and properties are assigned to those categories in Data Dictionary Manager. This
button acts as a toggle and is available when properties are displayed alphabetically.
Show Modified — Toggles the display of only those properties of the selected drawing item
that are different in the versions. This button applies only to modified items that exist in both
versions; for added and deleted items, all properties are listed.
Change groups
Lists the changed items in groups. A listed item contains all the items this change effects. You
can sort the list be clicking the column headings.
For SmartPlant P&ID Engineering, the refresh action is not allowed.
Check box column — Displays colors in the drawings as defined using Compare Options. If
not selected, the Default items color displays.
Number — Displays an arbitrary number that is assigned to a logical change group when this
dialog box is opened. The number has no intrinsic meaning and may apply to a different group
the next time you open this dialog box.
Action — Defines which action is to be taken involving the selected change. Options include:
 No Action — No drawing changes are applied.
 Refresh — Applies any drawing changes to the open drawing version.
Identifier — Lists item tags for the principal member of the change group, if an item tag is
assigned to that object. For instance, if a change group centers around data differences for a
vessel and its nozzles, then the item tag for the vessel is displayed in this column.
Category — Displays the category of the change, listed in order of highest to lowest priority.
Options include:
 Data — Indicates that a property value has changed (for example, a property value for a
vessel).
 Graphic — Indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays an overview of the claim status of the individual items in the group.
Possible values are All, Some, or None.
Valid Claim — Indicates that the claimed item is a valid claim.
Change details
Lists all the individual items that belong to the group that you select from the Change groups
list. You can sort this list by clicking on any of the column headings.

Result — Displays one of three possible values: Left-Only, Right-Only, and Different.
Left-Only denotes an item that exists in the left-hand version only, implying that the item is
deleted from the right-hand version. Right-Only denotes an item that exists in the right-hand
version only, implying that the item was added to the right-hand version. Different denotes a
difference between the properties or graphical elements of an item that exists in both versions.
Change — Describes what action is required to make the drawing in the right frame match the
drawing in the left frame. Actions include:
 Add — Adds the listed item to the version on the right.
 Delete — Removes the listed item from the version on the right.
 Modify — Changes the listed item in the version on the right.
When a plant item group is sent to the Plant Stockpile and after creating a new version of
the drawing, that plant item group is assigned to a piece of equipment or an instrument, the
Change column displays the value Delete. Plant Item Group types that are affected by this
behavior are: Contract Package, Hydro Test Package, Package, Instrument Safety Class, Test
System, and Hydraulic Circuit. If the plant item group is sent to the drawing stockpile, the
behavior is identical; however, the Change column displays the value Modify.
Item Type — Describes the item type, such as Instrument, PipeRun, or Nozzle.
Specific Item Type — Displays the specific type of item, such as 3-Way Ball Valve, Piping, or
Flange Orifice.
Item Tag — Displays the item tag of the individual item in question if a tag has been assigned to
the item.
Category — Displays the highest priority category of change that applies. Possible categories
are:
 Data — Indicates that a property value has changed (for example, a property value for a
vessel).
 Graphic — indicates that a change has been made to an item in the drawing (for example,
a vessel has been moved).
Claimed — Displays the claim status of the object:
 — Valid claim
 — Invalid claim
 Not claimed.
Stockpile or — Denotes whether the selected item is stored in the stockpile.

View — Displays the status of the selected item in relation to its placement in the primary or
typical view, and between the selected versions. The following statuses are displayed:
 Added to Primary
 Added to Typical
 Moved to Typical
 Moved to Primary

 Removed from Typical
 No Change in Typical
 Removed from Primary
 No Change in Primary
Status bar — Displays the currently defined colors for illustrating comparison status. You can
change the color scheme by clicking the Compare Options button on the toolbar and
defining options on the Compare Options dialog box.
See Also
Compare and Refresh Dialog Box Properties Window Toolbar

Allows you to customize the properties that are displayed in the Properties window of the
Compare dialog box.
Alphabetical — Lists properties in alphabetical order.
Categorized — Displays properties grouped by specific categories. Categories are defined

and properties are assigned to those categories in Data Dictionary Manager.
Show Modified — Toggles the display of only those properties that are different between
the properties that belong to a selected drawing item. This button only applies to modified items
that exist in both versions; for added and deleted items, all properties are listed.
See Also
Compare Options Dialog Box

Opens when you click Compare Options on the Compare dialog box toolbar and allows
you to customize the colors that the various comparison states are displayed in. The active color
scheme is displayed in the Compare dialog box status bar.
Left-only — Allows you to choose a color for the display of objects that exist in the left-hand
Drawing view only. Dark green is the default color for this option.
Right-only — Allows you to choose a color for the display of objects that exist in the right-hand
Drawing view only. Red is the default color for this option.
Different items — Allows you to choose a color for the display of items that exist in both views
but differ from each other for any number of reasons (for example, modified properties). Blue is
the default color for this option.
Identical items — Allows you to choose a color for the display of drawing items that are
identical in the two views. Black is the default color for this option.
Highlight items — Allows you to choose a color to denote that a drawing object is highlighted,
for instance, when an item is within your locate zone.
Selected items — Allows you to choose a color to denote items that are selected in one or both
of the Drawing views.

Compare and Refresh Drawing Versions

1. Click Tools > Compare and Refresh.
In SmartPlant P&ID Engineering, this command is enabled; however, it is only
possible to view the differences between drawings — you cannot refresh the display.
2. On the Compare With dialog box, select a database using the Available databases
drop-down list box.
3. In the History list box, select the drawing you want to compare your current drawing with.
4. Click OK.

5. On the Compare and Refresh dialog box, review the information in the Change groups
and Change details areas. Your current drawing displays on the right side of the
screen. The version you are comparing it to displays on the left.
6. In the Change groups area, click in the Action column.

7. Using the drop-down list, select No Action or Validate. Validate will display as an option
only if you have an Invalid Claim.
8. Click OK to refresh the drawing and accept any changes or Cancel to dismiss the dialog
box.

Compare and Refresh Examples

The following examples provide details for reconciling data and graphic differences between
your current drawing and a previously created version of that drawing.
For SmartPlant P&ID Engineering, the refresh action is not allowed.
Data Example
In this example, a jacketed tower exists in the version to be selected for the compare. The
current version contains the same jacketed tower but a change has been made to the Cleaning
Requirements property. When the current version is compared to the selected version, a data
change is found during the compare.
The current version appears on the right and the version it is compared to appears on the
left. Change groups indicates that there is only one group and a data change was located. All
items in the group are valid claims. Change details indicates that the comparison located a
different property value (Cleaning Requirement) in the current version.
Graphic Example
In this example, a jacketed tower exists in the version to be selected for the compare. The
current version contains the same jacketed tower but it has been moved to a new
location. When the current version is compared to the selected version, a graphic change is
found during the compare.

The current version appears on the right and the version it is compared to appears on the
left. Change groups indicates that there is only one group and a graphic change was
located. All items in the group are valid claims. Change details indicates that the comparison
located a graphic modification to a vessel (Jacketed Vessel) in the current version. If you
refresh the version, the graphic modification will be accepted as shown in the Change
column. Clicking in the Action column of the Change groups data allows you to take no action
or refresh (accept the previous location of the vessel). The settings are not applied to a version
until you click OK.
Data and Graphic Example

In this example, a jacketed tower with a nozzle exists in the version to be selected for the
compare. The current drawing contains the same jacketed tower and nozzle. The original
nozzle has been moved, a new nozzle has been added, and a property for the jacketed tower
has been changed. When the current drawing is compared to the selected version, a data and
graphic change is found during the compare.
The current drawing appears on the right and the drawing it is compared to appears on the
left. Change groups indicates that there are three groups of differences. All items in the
groups are valid claims. Change details indicates that the comparison located an existing
nozzle that was moved (Graphic) and a property value change (Data) in the current drawing.
Clicking in the Action column of any of the three Change groups allows you to select either No
Action or Refresh. If you select Refresh for any of the three groups, the action described in
the Change column will be performed when you click OK.
See Also


SECTION 6
Consistency Checking
Consistency checking verifies the suitability of work that a designer performs while creating the
drawing. The software verifies, in real-time, if the composition of a drawing and the underlying
data model satisfy rules that your company has defined. The software includes pre-defined
standard industry design propagation: for example, pipe runs inherit properties from nozzles.
Additional consistency checking and design propagation are defined in Rule Manager.
Consistency checking continuously monitors your work when you change items on a drawing.
The software displays all the inconsistencies, describes specific problems, and offers hints.
Using these solutions, you can decide the best method to resolve an inconsistency. One
solution is to approve a warning and thereby remove the inconsistency from the drawing.
Another solution is to copy the same value from one side to the other side and then propagate.
This illustration shows the inconsistency indicators that highlight incorrect relationships at a
junction of items in a drawing. An error appears where the pipe run connects to the pump nozzle
(A). A warning appears at the point where the valve and pipe run intersect (B). An approved
warning accompanies the off-page connector (C).
Consistency Checking and Break Labels

A property break is a point in a connected network of objects where a property value changes. A
property break is an exception to the consistency criteria defined in a rule. A property break
defines a limitation to the spread of the propagation scope. Whereas rules provide the general
definition of the scope, property breaks provide specific limitations of the scope.
The Consistency Check dialog box shows the consistency criteria that apply at the selected
relationship indicator. All of the properties that are copied and compared across this connection
are shown. After placement of a break label, the copy and compare columns show icons that
indicate that no copy and compare operations are performed for the properties in the label.
Break labels can be created in the Catalog Manager environment. A break label is created just
like an ordinary label, except that the Label Type property must be set to "Attribute Break". A
SmartText field must be created for each property that the break label is intended to break. A
break label can break one or more properties. This functionality is all currently supported by the
Catalog Manager. No new functionality is required.
Redundant breaks do not appear as inconsistencies on drawings. To identify these, you
must use the Find Redundant Breaks command. Redundant breaks are break components,

attribute breaks, and pipe segment breaks where those properties for which a discontinuity is
expected are the same on either side of the break.
Show Inconsistencies Command (View Menu)

Turns on or off the display of indicators that identify inconsistent relationships in the active view.
The software does not mark consistent, error-free relationships.
Show Inconsistencies
1. Click View > Show Inconsistencies. When this option is selected, inconsistent relationship
indicators appear in the drawing.
2. If you do not want the inconsistencies to appear, click View > Show Inconsistencies again
to clear the selection of the option.
Also, you can right-click in an empty portion of the drawing in order to display a shortcut
menu. Select Show > Inconsistencies to toggle the display of inconsistencies off and on.
Consistency Check Command (Edit Menu)

Right-click an inconsistency indicator and choose Consistency Check to display the
Consistency Check dialog box. As you create a drawing, consistency checking monitors your
drawing for design discrepancies. If a location in the drawing has only one or multiple
inconsistencies, you can correct the problems by reviewing them on the Consistency Check
dialog box.
Consistency Check Dialog Box

Opens when you display the properties of an inconsistency indicator, and lists the
inconsistencies, their specific problem area, and solutions for resolving the inconsistency. The
dialog box also displays the consistency criteria and propagation breaks that apply at the
selected relationship indicator.
You open this dialog box by right-clicking an inconsistency indicator and choosing Consistency
Check from the shortcut menu. You can also select Edit > Consistency Check. When this
dialog box first appears, the software automatically selects the first item in the list. Other
sections of the dialog box provide details that are specifically related to the selected
inconsistency.
All inconsistencies that occur at a junction, regardless of severity, are listed on the Consistency
Check dialog box. When you select one of the inconsistencies in the list, the software displays
information specific to that inconsistency in the Solutions box. A specific example of this type
can involve data inconsistencies for nominal pipe diameter, normal operating temperature, and
alternate design pressure between a piping component and pipe run. This represents three
different problems but at the same junction.

The Consistency Check dialog box contains the Inconsistencies Tab and the Consistency
Criteria Tab.
Inconsistencies Tab (Consistency Check Dialog Box)

All of the properties that are compared by consistency checking and copied across this
connection by propagation are shown on these tabs. The information shown here is very similar
to the information shown on the Consistency tab of the Rule Properties dialog in the Rule
Manager. Open the Consistency Check dialog box by selecting Edit > Consistency Check.

Item 1 — Displays the inconsistency, item type, and item tag for the first item that is connected
by the active relationship. When the Consistency Check dialog box first appears, all items
involved in the inconsistency are selected.
Relationship — Displays the number for the active relationship and allows you to select the
relationship to be reviewed. The drop-down list contains a number for each relationship that
exists at the selected point. The graphic relationship indicator that corresponds to the number
shown in this control is highlighted.
Item 2 — Displays the inconsistency, item type, and item tag for the second item that is
connected by the active relationship. When the Consistency Check dialog box first appears,
all items involved in the inconsistency are selected.
Highlight item 1 — Place a check mark in the check box to highlight the item in the
drawing. This helps you to quickly locate the selected object. By default, this option is not
selected.
selected.
Inconsistencies — Displays the inconsistencies at the selected relationship. For each
inconsistency, the status, severity and description are displayed. The icons used for the status
column are the same as the icons used for inconsistencies in the Drawing View. The first
inconsistency in the list is automatically selected. You can select any of the inconsistencies with
a mouse click or the arrow keys.
Description — Displays the actual error or warning. For a lengthy error or warning, a ToolTip
appears to reveal the entire description. You cannot change the inconsistency description, which
is provided for information only.
Solutions — Displays the list of available solutions for the selected inconsistency. The same
solution that was previously selected is automatically selected again. If none was previously
selected, the first solution in the list is automatically selected. Some of the solutions copy a
property value across the relationship and initiate propagation. When one of these solutions is
selected, the propagation scope is highlighted. This shows the items that will be changed before
they are modified. After selecting an inconsistency from the Inconsistencies list, you can
select the correct solution from this list, and after clicking Apply, the selected solution is
performed.
Apply — Performs the solution you choose from the Solutions box. The inconsistencies are
then re-evaluated and the dialog box is updated.

Consistency Criteria Tab (Consistency Check Dialog Box)

All of the properties that are compared by consistency checking and copied across this
connection by propagation are shown on these tabs. The information shown here is very similar
to the information shown on the Consistency tab of the Rule Properties dialog in the Rule
Manager. Open the Consistency Check dialog box by selecting Edit > Consistency Check.
Consistency Criteria — This list view shows all of the properties to be compared and copied at
this relationship. These consistency criteria come from the rules that apply to this relationship.
The consistency criteria for each rule are originally specified within the Rule Manager. The name
of the source rule is shown in the first column. The remaining columns are the same as shown in
the Consistency tab of the Rule Properties dialog box in Rule Manager. Single selection
mode is supported.
Item 1 — Displays the inconsistency, item type, and item tag for the first item that is connected
by the active relationship. When the Consistency Check dialog box first appears, all items
involved in the inconsistency are selected.
Relationship — If there are multiple relationship indicators at the same location, all of them are
loaded into the Consistency Check dialog box. Each relationship indicator is assigned a
number. The numbers are loaded into the drop- down list on the Relationship control. You can
review each one individually by selecting from the entries in the drop-down list.
Item 2 — Displays the inconsistency, item type, and item tag for the second item that is
connected by the active relationship. When the Consistency Check dialog box first appears,
all items involved in the inconsistency are selected.
selected.
selected.

Rule Name — Displays the name of the rule.

Item 1 Property — Displays the name of an Item 1 property to be copied and/or compared is
displayed in this column. Only those properties that are listed are copied across the relationship
(propagated) and compared to the value in the related item (consistency checked).
Copy — The copy action to be performed is displayed in this column. This column controls how
the software copies the property values at placement time when a property value is changed.
The following table describes the possible values and their meanings.
Copy Action Symbol Copy Action Name Property Modification
<> Copy Bi-directional The value can be copied in either

Always direction during propagation.
< Copy 2 to 1 Always The value from Item 2 is copied to Item

1 during propagation.
> Copy 1 to 2 Always The value from Item 1 is copied to Item

2 during propagation.
<> Copy Bi-directional if Null The value can be copied in either

direction during propagation but only if
the current value on the target item is
Null.
< Copy 2 to 1 if Null The value from Item 2 is copied to Item

1 during propagation but only if the
current value on Item 1 is Null.
> Copy 1 to 2 if Null The value from Item 1 is copied to Item

2 during propagation but only if the
current value on Item 2 is Null.
| None The property is not propagated across

this relationship.
Compare — Displays how the property values from Items 1 and 2 are compared. The
comparison occurs whenever any property on either item is changed. The following table
describes the possible values and their meanings
Comparison Operator Meaning
None No comparison
= Equal
< Less than
<= Less than or equal to

Comparison Operator Meaning
> Greater than
>= Greater than or equal to
<> Not equal to
Item 2 Property — Displays the name of an Item 2 property to be copied and/or compared.
Typically, this property name is the same as the Item 1 Property. However, there are some
cases where the property names are different. This property must have the same data type as
the property listed for Item 1.
Review an Inconsistency
1. Open a drawing.
2. Double-click an inconsistency indicator.
In addition, you can right-click an inconsistency indicator and select Consistency
Check.
3. On the Consistency Check dialog box, review the list of possible problem areas at the
junction.
 The options for solving the inconsistency in Solutions vary depending on the type of
inconsistency.
 Consistency Check identifies the type of problem with these symbols:
Errors.
Warnings.
Approved warnings.
 To alert you to possible problems, the Drawing view offers different inconsistency indicators:
Warning for suspicious construction in the Drawing view.
Error in the Drawing view that warrants your inspection and

correction.

Resolve an Inconsistency
1. Open a drawing.
2. Double-click an inconsistency indicator.
Or you can right-click an inconsistency indicator to review its properties.
3. On the Consistency Check dialog box, select the inconsistency that you want to correct in
the list.
4. Chose the appropriate solution from the Solutions list.
 An example of a solution is Copy property value Item 1 => Item 2, which could involve
inconsistent nominal diameters of a pipe and nozzle, for example. If you determine that
this solution is the best one, you can select it and click Apply. Or you can use the
Properties window to change the nominal diameter of either the pipe or nozzle.
Changing the diameter confirms that the values are consistent with the information that
exists in Rule Manager.
 The options in the Solutions list vary, depending on the type of inconsistency.
5. Click Apply.
 Consistency Check identifies the type of problem with these symbols:
Errors
Warnings
Approved warnings
 A Drawing view also offers graphical symbols to alert you to possible problems:
Warning for suspicious construction in the Drawing view
Error in the Drawing view that warrants your inspection and

correction

Find Redundant Breaks Command (View Menu)

Opens the Find and Replace dialog box on the Find tab with the Find what field displaying the
entry Redundant Breaks. With this option, the software highlights break components, attribute
breaks, and pipe segment breaks where those properties for which a discontinuity is expected
are the same on either side of the break.
Find Redundant Breaks

Redundant breaks are break components, attribute breaks, and pipe segment breaks where
those properties for which a discontinuity is expected are the same on either side of the break.
1. Click View > Find Redundant Breaks. The Find and Replace dialog box appears with the
Find tab active.
2. Choose an option from the Search in list.
 Click Find to move to each redundant break in turn.
 Click Find All to display a message with the total number of redundant breaks on the
drawing. The software highlights all the redundant breaks.
If a break component also behaves as a reducer (that is, its IsReducing property is
'True'), it will be identified as a redundant break if all the break properties or the all reducing
properties are the same on both sides of the component. In the case where both sets of
properties are the same, the component is only counted once as a redundant break.


SECTION 7
Importing Drawing Data

There are several ways you can import data into SmartPlant P&ID. You can import data and
items into the database using reports and other files. Also, you can also populate or redefine
pipe run properties by importing an Aspen Basic Engineering stream data file. During the import
process, you can assign the stream and its associated engineering data to the pipe run.
For SmartPlant P&ID Engineering, importing from SmartSketch is not allowed.
Data File Command (File > Import Menu)

Allows you to import data and items into the database from reports and other files.
Relationships between items cannot be imported, only items and their properties.
Import Log Dialog Box

Shows the progress of the data importation process and allows you to review the log file. This
dialog box opens when you use the File > Import > Data File command.
Import log — Lists the results of the file importing process. These results are also available in
SPImport.log, which is saved to your local TEMP folder.
Import > SmartSketch Command (File Menu)

Allows you to import data from SmartSketch into SmartPlant P&ID.
Importing Aspen Basic Engineering Stream Data

You can populate or redefine pipe run properties by importing an Aspen Basic Engineering
stream data file. During the import process, you can assign the stream and its associated
engineering data to the pipe run.
You can easily update stockpile items that originate from importing Aspen Basic Engineering
data by re-importing a data file. Previously imported items, whether they remain in the stockpile
or have already been placed in the drawing, are updated with data from the newly imported file.
If a format change is made to an exported Aspen Basic Engineering report,
modifications must be made to the import code to accommodate the changed report layout.
For more information, see the SmartPlant P&ID Programmer's Guide.

Importing Drawing Data
Import Aspen Basic Engineering Stream Data

1. Select a pipe run from the drawing to display the Properties window for the pipe run.
If the Properties window is not open, you can click Edit > Properties after you select
the pipe run.
2. Click the Calculate button next to the Stream No. cell to display the Stream Number
dialog box.
3. Click the Browse button and select the Aspen Basic Engineering stream data .txt file from
the appropriate folder.
4. Click the Stream ID list and select a stream ID.
5. Click OK to populate the Properties window with the selected stream ID.

SECTION 8
Generating Reports
Reporting is the process of retrieving information from the database and displaying the
information as formatted output. At any time during the design creation process, you can create
a report. Each report consists of a Microsoft Excel workbook and a report definition, which
describes the data to collect and how to organize the data in the workbook.
Each report that you create is based on an item type. This item type serves as the starting point
for collecting data for your report. Examples of item types include equipment, nozzle, instrument,
and pipe run. Several default report templates already exist; however, reports are fully
customizable. You can create your own reports that contain the information that you want to see
in a format you choose.
The relationships that exist between the various item types constitute additional available
information for a report. For example, a nozzle is related to the equipment with which it is
grouped. When creating your report, only items that have a relationship with your selected item
type can be used as input. In order to discover how items and their properties are related, and
thereby how you can map the properties that you want into your report templates, see the
Properties Glossary, which is included in the glossaries attached to SmartPlant P&ID Online
Help.
Your report definition contains one or more report items organized in a tree hierarchy. Each
report item is based on an item type. Each report contains at least one report item to define the
item type of the report. For example, a report based on the equipment item type contains a
report item named Equipment. This report item makes the properties associated with each
piece of equipment available for inclusion in your report; however, you do not have to include
every available property in your report if it is not appropriate. You can define additional report
items to access more properties for more item types. For example, a nozzle report item can be
added to access data about nozzles because nozzles and equipment are related.
The location of a report item in the tree hierarchy affects the properties that are collected for the
associated item type. For example, if a nozzle is added as the top-level item in the tree, all
nozzles in the database are collected for your report. If the nozzle is added as a child of
Equipment: Mechanical, only the information about nozzles that are associated with pumps is
collected.
When you generate a report, the software performs the following tasks:
1. Microsoft Excel starts. The report template is copied to the report output folder, and then the
Excel workbook opens.
2. Your report definition is retrieved from the Excel workbook.
3. Your data is retrieved based on the report item definitions of the report template.
4. Data prints to the Microsoft Excel workbook using the cell mapping data in your report
definition.
 To create a Plant wide report, use the Engineering Data Editor commands View > Plant
Reports or My Reports.

Generating Reports
 You must have Microsoft Excel installed on your computer to display reports.
 When generating a report, the software displays all report templates with unique names. If
templates with the same name exist having .xlsm and .xls formats, the software displays
only one of these templates in the format that depends on the installed version of Excel:
.xlsm for Excel 2007 or later and .xls for earlier versions of Excel.
 The software stores the reports that you generate in your Windows directory under
\Profiles\username\My Reports\Output.
Generate a Report for an Active Drawing

1. In the Drawing view, select the items that you want to include in the report.
If you select no items, the software gives you the option to report on all items.
 Click Reports > Plant Reports to select a report that was released to the Plant.
 Click Reports > My Reports to select a customized report that you defined already.
3. On the Plant Reports dialog box or the My Reports dialog box, select the report that you
want to generate.
4. In the Report using area, choose the items that you want to report on.
 Before running any Line List report, verify that every line in the selection has an Item Tag.

Generating Reports
 When applying an AutoFilter, if the number of data records in the Engineering Data Editor
exceeds the maximum, the Query Results dialog box opens indicating the total number of
rows found before the AutoFilter was applied. If you choose to continue with the query in
applied.
You can then generate a report based on the AutoFilter results. The AutoFilter is honored
for the report until another item type is selected in the list or the AutoFilter is turned off.
Generate a Report for the Plant

1. In the Engineering Data Editor, select the items that you want to include in the report.
If you select no items, the software gives you the option to report on all items.
2. Click the down-arrow next to the View menu button and do one of the following:
 Click Plant Reports to select a report that was released to the Plant.
 Click My Reports to select a customized report that you defined already.
3. On the Plant Reports dialog box or the My Reports dialog box, select the report that you
want to generate.
4. In the Report using area, choose the items that you want to report on.
 When applying an AutoFilter, if the number of data records in the Engineering Data Editor
exceeds the maximum, the Query Results dialog box opens indicating the total number of

Generating Reports
rows found before the AutoFilter was applied. If you choose to continue with the query in
applied.
You can then generate a report based on the AutoFilter results. The AutoFilter is honored
for the report until another item type is selected in the list or the AutoFilter is turned off.
Generate Reports for Selected Drawings

1. In the Engineering Data Editor, select Plant Item from the list.
2. Click the down-arrow next to the View menu button and click Edit View.
3. Click Advanced.
4. Under Edit, from the Property list, select Rep Drawing Name.
5. From the Operator list, select =.
6. In the Value box, type <Drawing name 1>.
7. For additional drawings, enter Rep Drawing Name = <Drawing name 2>, and so forth.
For multiple entries for drawing names, be sure to select Match any.

Generating Reports
Plant Reports Command (Reports Menu)

Opens the Plant Reports dialog box, which displays a list of all plant-level reports associated
with the current plant. This list is alphabetical. The location of these report templates is defined
in Options Manager. Selecting a plant report from this list and specifying the items that you want
to report on generates the associated report in Microsoft Excel.
This command is available on the Reports menu on the main toolbar and also on the View
menu in the Engineering Data Editor. If you have a drawing in the Design window and you
want to report on items in that drawing, use this command from the Reports menu. If you want
to run a report based on items in your Engineering Data Editor, use this command from the
View menu of the Engineering Data Editor.
The Engineering Data Editor is the area where you can view stockpile items
Plant Reports Dialog Box

Allows you to choose a report and specify what items to report on. This dialog box opens either
when you click Reports > Plant Reports on the main toolbar or when you click View > Plant
Reports on the Engineering Data Editor toolbar. If you want to run a report on drawing items,
use the Reports menu; if you want to run a report on table items, use the Engineering Data
Editor View menu.

Generating Reports
Current Selection — Produces a report containing the items currently selected in your drawing
or table. This option is not available if no drawing or table items are selected. You cannot
choose the Include items in drawing stockpile option when you choose Current Selection.
Entire drawing — Produces a report containing the contents of the entire drawing. This option
is available only when you use the Reports menu command.
Include items in drawing stockpile — Allows you to specify whether or not you want items
that reside in the drawing stockpile in your report. This option is available only when you use the
Reports menu command.
My Reports Command (Reports Menu)

Opens the My Reports dialog box which lists all user-level reports. They can be stored on your
local workstation. This list is alphabetical. If you want to run a report based on drawing items,
access this command from the Reports menu on the main toolbar; if you want to run a report
based on table items, access this command from the View menu on the Engineering Data
Editor toolbar.
You can define the location for storing user-level report templates by clicking Tools >
Options and then selecting the Files tab.
My Reports Dialog Box

Allows you to choose one of your custom reports and to specify what items to report on. This
dialog box opens either when you click Reports > My Reports on the main toolbar or when you
click View > My Reports on the Engineering Data Editor toolbar. If you want to run a report on
drawing items, use the Reports menu; if you want to run a report on table items, use the
Engineering Data Editor menu.
Report using — Displays options for specifying the scope of your report. The options that
appear in this area depend on whether the Drawing view or Engineering Data Editor is active
when you access this dialog box.
Current Selection — Produces a report containing the items currently selected in your drawing
or table. This option is not available if no drawing or table items are selected. You cannot
choose the Include items in drawing stockpile option when you choose Current Selection.
Entire drawing — Produces a report containing the contents of the entire drawing. This option
is available only when you use the Reports menu command.
Include items in drawing stockpile — Allows you to specify whether or not you want items
that reside in the drawing stockpile in your report. This option is available only when you use the
Reports menu command, not the Engineering Data Editor command.

Generating Reports
Creating and Editing Report Templates

Although the software includes several default report templates, such as Equipment List and
Pipe Run List, you create your own custom report templates or modify the delivered templates in
order to gather and display the specific information that you want. So the software allows you to
define report templates in several different formats and with all manner of information from the
design database.
You can create report templates in three different formats:
 Tabular Format Report (on page 231)
 Fixed Format Report (on page 233)
 Composite Format Report (on page 233)
The delivered report templates are all tabular format reports. Fixed format templates allow the
greatest amount of freedom in formatting your report, and composite report templates, as the
name suggests, combine tabular and fixed formatting.
Not only can you completely control the format of your report, but you can control the content of
the template also. Each report is based on a unique item type, and the properties that are
associated with that item type are readily available to include in your report. In addition, any item
that is related in any way to the basic item type of your report makes its properties available to
include in the definition of your template, too. For instance, the properties of inline components
and instruments can be used in a pipe run report because inline components are related to their
pipe runs. In order to discover how items and their properties are related, and thereby how you
can map the properties that you want into your report templates, see the Properties Glossary,
which is included in the glossaries attached to SmartPlant P&ID Online Help.
Portable report templates

In previous versions of the software, when a property is mapped to a report template, the
template file stores an internal identifier for that property; thus, that report template is tightly
linked to the plant that creates the property. Now the property name is mapped into the report
template; therefore, as long as all plants use the same property name, the same report template
is valid.
When creating a new report template, the software saves the file in the format that
depends on the installed version of Excel: .xlsm for Excel 2007 or later and .xls for earlier
versions of Excel.
Improve the Performance of Custom Reports

From Version 2009 SP2, new VBA code was added to all shipped reports, resulting in
significantly improved generation time. In order to enable similar performance improvements for
your custom reports, you must add this VBA code to each report template.
This code does not improve the performance of reports that previously took
approximately 10 seconds or less to generate.
1. Open the desired Excel report template.
2. Display the Microsoft Visual Basic environment by pressing ALT + F11.

Generating Reports
3. In the Project pane, under Microsoft Excel Objects, select ThisWorkbook.
4. Add the following code to the Excel report workbook code sheet:
Public Sub RunWorkbook()
' The objRunWorkBook object creates a separate connection for Excel.

' This object holds the DataPile object for later use within the report.
' You can get the DataPile object by calling the property get
objRunWorkBook.DataPile
' This code does not improve the performance of reports that took
approximately 10 seconds or less to generate.
On Error GoTo mErr
Dim objRunWorkBook As Object
Set objRunWorkBook = CreateObject("RunWorkBook.clsRunWorkBook")
objRunWorkBook.RunWorkbook Me
Set objRunWorkBook = Nothing
Exit Sub
mErr:
MsgBox Err.Description
Application.Quit
End Sub

Generating Reports
Tabular Format Report

All the delivered report templates are tabular format reports. When the report is generated, all
properties populate the report by using the same format defined for the first row. In other words,
tabular format reports are row-based. The Options command on the SmartPlant Reports
toolbar is important for setting aside space for the header and empty rows between lines in the
report because the placement of report item properties is restricted in the tabular format report
template.
For example, the report template for an Equipment List can appear like this:
Equipment Name Equipment Description Equipment Type
#Equipment::Name# #Equipment::Description# #Equipment::Type#
When the report is generated, the output appears like this:
Equipment Name Equipment Description Equipment Type
D-100 Horizontal Drum 100 Horizontal Drum
T-100 Potable Water Tank Vertical Tank
Define the Layout of a Tabular Format Report Template

You can edit your tabular format report template in Microsoft Excel and specify how the labels
and data are displayed.
1. On the SmartPlant Reports toolbar, click Options.
2. On the Options dialog box, choose the size of your report header.
 The header is part of the tabular format report template where data is not mapped
based on rows. That is, you are free to type a label and map report item properties
anywhere in the lines that you designate for your header.
 The header is a good place to put information that applies to all the items in your report,
such as Unit or Plant Name.
 Also, you can add graphics in your report header.
 Be sure to include space in your header for the labels of your columns.
3. Choose the number of empty lines that you want between rows in your report. Each row is
filled with properties for one item.
Some report templates, for example some Line List reports, designate two rows of
data for each report item and then an empty row.

Generating Reports
4. If you want to sort the map properties, under 'Map Properties' sort order, click Ascending
or Descending.
 When sorted in ascending or descending order, the properties that have sub-properties
appear first sorted alphabetically, followed by the properties that do not have
sub-properties, sorted alphabetically.
 For a summary report, the list entry Report Item Group Total that appears at the lowest
level is always at the bottom of the list, regardless of the sort order selected.
5. Click OK to close the Options dialog box.
6. Complete general labels and graphics, if needed, in your header.
7. Complete column headings in the last row of your header.
8. Select a cell in your report template where you want to map a particular property.
This cell can be either in the body of the report or in the header.
9. Choose the property that you want to map to your cell from the Map Properties menu. The
items on this menu are chosen when you define the contents of your template. For more
information, see Define the Contents of Your Report Template (on page 243).
 You only have to map properties for one item. Properties for all the items follow the
format you map for the first one.
 Only one property can be mapped to a given cell, although the same property can be
mapped to more than one cell.
10. Repeat the previous steps until you have mapped all the properties that you want to map on
this report template.
11. Save the template and quit Microsoft Excel.
 Because the delivered report templates have a tabular format, if you create a template
based on an existing template, the format of your report template is also tabular. Select
Blank as your source template if you want to create a fixed or composite format report
template.
 The location of plant-level report templates is specified in Options Manager. The location for
user-level templates is defined on the Files tab of the Options dialog box (Tools >
Options).
 When you add any property value in the header, a new Microsoft Excel worksheet is
created, and the header is saved on the new sheet because the entire header no longer fits
in the space allotted on the first sheet. You can customize the number of rows in the report
header by using the Options command on the SmartPlant Reports toolbar and choosing a
larger value in the Rows in report header option in the Options dialog box.

Generating Reports
Fixed Format Report

The fixed format report creates one Microsoft Excel worksheet for each item. When defining the
report template, you only edit the first worksheet. When you generate your report, all fixed
format worksheets, one for each item of the report item type, follow the format of the first
Microsoft Excel worksheet. The Options command on the SmartPlant Reports toolbar is not
available for editing a fixed format report template because you are free to place headers and
data anywhere you want on your worksheet.
Define the Layout of a Fixed Format Report Template

You can edit your fixed format report template in Microsoft Excel and specify how the labels and
data are displayed.
1. Choose a cell on your Microsoft Excel worksheet and type labeling information into it.
A label is not a required feature of a fixed format report template. You can simply map
properties to cells without any labeling if you want.
2. Choose a cell where you want the property associated with the labeling to appear.
3. On the SmartPlant Reports toolbar, click Map Properties and from the menu select the
property that you want to map to the cell you chose in the previous step.
The properties on the Map Properties menu are specified when you define the
contents of your report. For more information, see Define the Contents of Your Report
Template (on page 243).
4. Repeat the previous steps until you have labeled and mapped all the needed report item
properties to the corresponding locations in your template. When you generate a fixed
format report, the data for each report item appears in its own worksheet, and the layout for
each worksheet matches the layout defined for the first worksheet.
You use the Options command on the SmartPlant Reports toolbar to designate space
for your header and to specify the number of blank lines that you want between rows of data on
your report. The Options command is not available for fixed format report templates because
you are free to place headers and data anywhere on your worksheet.
Composite Format Report

The composite format report template is a combination of fixed and tabular format reports. In
your Microsoft Excel workbook, the first sheet contains the fixed format report and the second
sheet contains the tabular format report. You choose your report format on the Report
Because the delivered report templates are tabular format, choose Blank from the
Source template list if you want to create a composite format template.

Generating Reports
Define the Layout of a Composite Format Report Template

You can edit your composite format report template in Microsoft Excel and specify how the
labels and data are displayed.
1. Define the layout of the first Microsoft Excel worksheet. In a composite format report
template, the first worksheet automatically uses the fixed format. For more information about
defining fixed format report templates, see Define the Layout of a Fixed Format Report
 Each item in the report has its own page. The properties of the first item are displayed
on the first worksheet, but the properties for subsequent items in the report are
displayed starting with the third sheet because the second worksheet is tabular format.
 On the SmartPlant Reports toolbar, you use the Options command to designate
space for your header and to specify the number of blank lines that you want between
rows of data on your report. The Options command is not available for fixed format
report templates because you are free to place headers and data anywhere you want to
on your worksheet; however, the Options command is available for you to use in the
tabular portion of the composite report template.
2. Define the layout of the second Microsoft Excel worksheet. In a composite format report
template, the second worksheet is automatically tabular format. For more information about
defining tabular format report templates, see Define the Layout of a Tabular Format Report
3. After you have defined the layout for the first and second worksheets in your report
template, save the template and quit Excel.
 You can map only one property into a given cell, although you can map the same property
to more than one cell.
 When you add any property value in the header, a new Microsoft Excel worksheet is
created, and the header is saved on the new sheet because the entire header no longer fits
in the space allotted on the first sheet. You can customize the number of rows in the report
header by using the Options command on the SmartPlant Reports toolbar and choosing a
larger value in the Rows in report header option.
New Command
Displays the New Report Template dialog box. This dialog box provides options for defining
plant-level and user-level templates. You can assign source templates, names, formats, and
descriptions for your report template and define the item type upon which you base your report.
You do not have to edit the report template when you first create it.

Generating Reports
New Report Template Dialog Box

Displays options for creating plant-level and user-level report templates. This dialog box opens
when you click Reports > New on the main menu bar.
Source template — Lists the names of all existing report templates and Blank. You select a
user-level template, plant-level template, or Blank. The Blank option creates a Microsoft Excel
workbook with no predetermined formatting information. If you chose Blank, you must specify
an item type; whereas, if you do not choose Blank, the software automatically displays the item
type that corresponds to your source template. Templates in this list appear in alphabetical
order.
Name — Allows you to enter a meaningful name to describe the report that you are creating.
This name matches your Microsoft Excel workbook. The software appends .xls to the name
when you save the Excel workbook.
Item type — Defines the item properties available in your report. If you do not select a Blank
source template type, then the Item type option automatically displays the item type that
corresponds to your source template.
Report Type — Specifies your report format. Available options include fixed, tabular, and
composite. All delivered report templates are tabular format.
 Fixed format — Creates one Microsoft Excel worksheet for each item. You only edit the first
worksheet, but all fixed format worksheets, one for each item of the report item type, follow
the format of the first worksheet when you generate your report. The Options button on the
SmartPlant Reports toolbar is not available for editing a fixed format report template
because you are free to place headers and data anywhere you want on your worksheet.
 Tabular format — Formats your report in a table. That is, the properties of each item
included in your report begin on a unique row, or the template format is row-based. All
delivered reports are tabular format.
 Composite format — Formats your report in a combination of fixed and tabular formats.
The first sheet in the workbook is Fixed format; the second sheet is Tabular format.
Subsequent fixed format worksheets are created after sheet two for each item of your report
item type when you generate your report.
Description — Describes the report type that this template produces. You can assign any
description.
Create a New Blank Report Template

You can define a new report template which is not based on a pre-existing template.
1. Click Reports > New.
2. On the New Report Template dialog box, select Blank from the Source template list.
 You can create a new report template based on an existing template by specifying a
source template also. For more information, see Create a Report Template Based on an
Existing Template (on page 236).
 Since delivered reports are all in tabular format, you must choose Blank if you want a
fixed or composite format report template. You can select Blank for a tabular format
report template, nonetheless.

Generating Reports
3. In the Name box, type a meaningful name to describe the report template you are creating.
This entry is the name of your Microsoft Excel workbook. When you save the template,
the software appends the .xls extension to the name.
4. In the Item type box, select an item type.
5. In the Report type box, choose template format.
These options are only available when you choose Blank from the Source template
list.
6. In the Description box, type a description for the template.
7. If you want this template to be available at the plant-level, select the Add to plant reports
option.
You must have the appropriate permissions, granted in SmartPlant Engineering
Manager, to create plant-level report templates.
8. Click OK to create the template.
9. When the software gives you the option to edit your new template in Microsoft Excel, click
OK and define the layout and contents of the template. For more information about these
procedures, see the following topics:
 Define the Layout of a Tabular Format Report Template (on page 231)
 Define the Layout of a Fixed Format Report Template (on page 233)
 Define the Layout of a Composite Format Report Template (on page 234)
 Define the Contents of Your Report Template
When creating a new report template, the software saves the file in the format that
depends on the installed version of Excel: .xlsm for Excel 2007 or later and .xls for earlier
versions of Excel.
Create a Report Template Based on an Existing Template

You can define a new report template by using another template as a source.
1. Click Reports > New.
2. On the New Report Template dialog box, select an existing template from the Source
template list.
In the list, the software displays all report templates with unique names. If templates
with the same name exist having .xlsm and .xls formats, the software displays only one of
these templates in the format that depends on the installed version of Excel: .xlsm for Excel
2007 or later and .xls for earlier versions of Excel.
3. In the Name box, type a name for the new report template.
4. In the Description box, type a description for the new report template.
5. Click OK.
6. When the software gives you the option to edit your template, click OK to open Microsoft
Excel and define the contents and layout of your report. For more information about these
procedures, see the following topics:

Generating Reports
Edit Command
Opens the Edit Report Template dialog box. This dialog box lists all the available report
templates. You can select a template and view its properties and edit it in Microsoft Excel.
You must have valid privileges to edit a report template.
Edit Report Template Dialog Box

Displays a list of available report templates and opens the selected report template in Microsoft
Excel so that you can make changes to it. Click Properties to view and update properties for a
report template. This dialog box opens when you click Reports > Edit on the main menu bar.
Available reports — Lists all report templates available to edit or customize. Select a template
from the list.
Properties — Displays the Report Properties dialog box where you can modify the description
and the report template format.
Open — Displays the selected template in Microsoft Excel.
You must have the correct privileges, granted in SmartPlant Engineering Manager,
to edit plant-level report templates.
Report Properties Dialog Box

Displays properties for plant-level and user-level report templates. This dialog box opens when
you click Properties on the Edit Report Template dialog box. All fields other than Report type
and Description are read-only.
Source template — Displays the name of the report template used for the report. The source
template can be a user-level template, plant-level template, or Blank.
Name — Displays the name of the report. The name matches your Microsoft Excel workbook.
The software appends .xlsm to the name when you save the Excel workbook.
Item type — Displays the item type that determines which properties are available to populate
your report.
Report Type — Specifies your report format. Available options include fixed, tabular, and
composite.
 Fixed format — Creates one Microsoft Excel worksheet for each item. You only edit the first
worksheet, but all fixed format worksheets, one for each item of the report item type, follow
the format of the first worksheet when you generate your report. The Options button on the
SmartPlant Reports toolbar is not available for editing a fixed format report template
because you are free to place headers and data anywhere you want on your worksheet.

Generating Reports
 Tabular format — Formats your report in a table. That is, the properties of each item
included in your report begin on a unique row, or the report format is row-based. All
delivered report templates are tabular.
 Composite format — Formats your report in a combination of fixed and tabular styles. The
first sheet in the workbook is fixed format; the second sheet is tabular format. When you
generate your report, the software creates subsequent fixed format worksheets after sheet
two for each item that matches your report item type.
Description — Describes the report type that this template produces. You can assign any
description.
Edit a Report Template

to be able to edit a report template.
1. Click Reports > Edit.
2. On the Edit Report Template dialog box, select a report from the Available reports list.
3. Click Properties on the Edit Report Template dialog box in order to edit template
properties on the Report Properties dialog box.
Because you are modifying a template that already is defined, changing the Report
type option and the description are the only available actions on the Report Properties
dialog box.
4. Click Open on the Edit Report Template dialog box to display the report in Microsoft Excel
so that you can edit the layout and contents of your report template. For more information
about these procedures, see the following topics:
If the SmartPlant Reports toolbar (on page 240) is missing when editing report templates
in Microsoft Excel, then on the Excel menu bar, click Tools > Macro > Visual Basic Editor and
do the following:
1. Select View > Immediate Window.
2. Type Sheet1.Application.CommandBars("SmartPlant Reports").Delete in the
Immediate window.
3. Quit Excel, and the toolbar is displayed the next time a report is edited.

Generating Reports
Display the Properties of a Report Template

You can inspect some of the properties that are currently in force for your template, such as the
report item type and the report format.
2. Select a report from the Available reports list on the Edit Report Template dialog box.
3. Click Properties.
Delete Command
Displays the Delete Report Template dialog box, which allows you to select and delete a report
template.
You must have valid privileges, granted in SmartPlant Engineering Manager, to delete a
report template.
Delete Report Template Dialog Box

Displays a list of available report templates. You can delete a selected report template if you
have the proper privileges, granted in SmartPlant Engineering Manager. This dialog box opens
when you click Reports > Delete on the main menu bar.
Available Reports — Lists all available report templates.
Delete a Report Template

to be able to delete a report template.
1. Click Reports > Delete on the main menu bar.
2. On the Delete Report Template dialog box, select a report from the Available reports list.
3. Click OK to delete the report template.
4. Click Close.

Generating Reports
SmartPlant Reports Toolbar
Appears when you are editing or creating a report template in Microsoft Excel.
Define Command (on page 240)
Options Command (on page 245)
Map Properties Command (on page 248)
If the SmartPlant Reports toolbar is missing when editing report templates in Microsoft
Excel, then click Tools > Macro > Visual Basic Editor in Excel and follow the steps below:
1. Select View > Immediate Window.
2. Type Sheet1.Application.CommandBars("SmartPlant Reports").Delete in the
Immediate window.
3. Quit Excel, and the toolbar is displayed the next time a report is edited.
Define Command
MS Excel > SmartPlant Reports Toolbar > Define
Opens the Define Report Contents dialog box, which allows you to define a report template
specifying the layout and contents of your report. This template is a Microsoft Excel workbook
that contains cells and worksheets. You map properties to the individual Microsoft Excel cells to
define the content and layout of your report.
To create a report definition (a list of report item properties available to include in your template),
use the Define Report Items dialog box, which opens when you click Define on the Define
Report Contents dialog box. A report definition describes how to collect the properties data and
how to format it in a report. Each report item is based on an item type (equipment, nozzle, pipe
run, instrument, and so forth) and controls how the properties of that item type, or item types
related to it, are retrieved from the database.
Use the Options command on the SmartPlant Reports toolbar to designate space for your
header and to specify the number of blank lines that you want between rows of data on your
report. The Options command is not available for fixed format report templates because you are
free to place headers and data anywhere you want on the worksheet.
In order to define the layout of the report item properties, you assign properties to particular
cells. Select the cell and then select the property from the Map Properties menu on the
SmartPlant Reports toolbar.
In order to generate From and To data for all Microsoft Excel worksheets, click Tools >
Macro > Macros > PrintFromToDataForAllSheets in Excel. Choose the
PrintFromToDataForActiveSheet macro to generate this data for only the active worksheet.

Generating Reports
Define Report Contents Dialog Box

Defines new items to include in your report and selects the cells to include for the new items.
This dialog box opens when you click Define on the SmartPlant Reports toolbar.
Define — Displays the Define Report Items dialog box. For the selected item in the Report on
tree, you define the properties that you want available for inclusion in your report template.
Delete — Removes an item from the tree view and from your report structure. Its properties are
no longer available for your report template.
New — Displays the New Items dialog box. You use this dialog box to specify new item types to
include in the Report on tree. If you add a new item type, its properties are available for
inclusion in your report template.
Report on — Displays a tree view of item types whose properties are available for inclusion in
your report template. To include the properties, you must select an item from the Report on list
and click Define. Then you can map the properties that you select to cells in your report
template.
The level into which you add an item type affects the properties that you can access for
your template. That is, a new item type added into the hierarchy under another item type does
not give you access to the same properties that you have if the item type is higher in the
hierarchy. For instance, if you add the equipment item type under nozzles, the equipment item
type only reports on equipment associated with a nozzle, and equipment without nozzles is not
reported.
New Items Dialog Box

Opens when you click New on the Define Report Contents dialog box and displays a list of
items that are related to the item that you selected there. Select an item type to make its
properties available to include in your report.
Apply — Adds the selected item type to the Report on tree on the Define Report Contents
dialog box. The software adds this item type as a child of the item type selected on the Define
Report Contents dialog box.
The level into which you add an item type affects the properties that you can access for
your template. That is, a new item type added into the hierarchy under another item type does
not give you access to the same properties that you have if the item type is higher in the
hierarchy. For instance, if you add the equipment item type under nozzles, the equipment item
type only reports on equipment associated with a nozzle, and equipment without nozzles is not
reported.
Items related to — Displays a list of item types related to the item type that you selected in the
Report on tree on the Define Report Contents dialog box. Select item types from this list to
include in your report template. The properties of the new item types are then available to use in
your report.
Name — Displays the name of the selected item type. You can rename the item. If you have
duplicate item type names in your report item type hierarchy, the software prompts you to
rename the new item type uniquely.

Generating Reports
Define Report Items Dialog Box

Specifies the report item properties available for your report. Select the properties to include for
each report item type and define sorting and filtering for those properties. This dialog box is
accessed by clicking Define on the Define Report Contents dialog box, which, in turn, is
accessed by clicking Define on the SmartPlant Reports toolbar.
Properties Tab (on page 242)
Filter Tab (on page 243)
Sort Tab (on page 243)
Properties Tab
Displays properties for a report item so you can select properties to use in your report template.
This tab is part of the Define Report Items dialog box, which opens when you click Define on
the Define Report Contents dialog box.
Group by the selected property — Automatically adds a special Report Item Group Total
property to the Map Properties menu on the SmartPlant Reports toolbar. The Report Item
Group Total property displays the number of items that have identical reported properties. If
you want to tally similar items in this way, be sure not to map unique properties, such as item
tags, onto your report. If you do, then items are never grouped together because a unique tag is
a property that items never share. For example, you can use this feature to give you the total
numbers of valves with 1" nominal diameter, 1.5" nominal diameter, 2" nominal diameter, and so
forth.
Repeat parent data — Displays the cells of parent item data in your report. For example, if your
report contains Unit then Drawing as a child of Unit, selecting this option for Drawing causes
repetition of Unit cells on any line that contains Drawing cells.
Available properties — Displays all properties for the report item you specified on the Define
Report Contents dialog box.
Selected properties — Lists the report item properties you have selected from the Available
properties list that are consequently available for inclusion in your report.
Left Arrow — Moves the selected item in the Selected properties list to the Available
properties list. You can select more than one item by using the CTRL and SHIFT keys and then
clicking the left arrow. Also, double-clicking an item in the Selected properties list moves it to
the Available properties list.
Right Arrow — Moves the selected item out of the Available properties list and into the
Selected properties list. You can select more than one item by using the CTRL and SHIFT
keys and then clicking the right arrow. Also, double-clicking an item in the Available properties
list moves it to the Selected properties list.
Use short text — Displays the short text value, which is defined in SmartPlant Data Dictionary
Manager. Only select-listed properties can be displayed in their short value form. In a few cases,
the short value is longer than the regular value.
Use select list index — Includes the numerical index of the select entry along with either the
short value or select list value for that property. For more information about select lists and their
values and indices, see SmartPlant Data Dictionary Manager Help.

Generating Reports
Filter Tab
Defines the filter that you want to use for your report item. This tab is part of the Define Report
Items dialog box, which opens when you click Define on the Define Report Contents dialog
box, which, in turn, opens when you click Define on the SmartPlant Reports toolbar.
Applied filter — Displays your selected filter. To select a new filter, type a valid filter name or
click Browse to locate a filter.
Browse — Displays the Select Filter dialog box, which allows you to choose or to further define
item types for your report template.
Sort Tab
Defines the cells that you use to sort the report items and how. This tab is part of the Define
Report Items dialog box, which opens when you click Define on the Define Report Contents
dialog box, which, in turn, opens when you click Define on the SmartPlant Reports toolbar.
Available properties — Lists all the properties of your report item.
Down Arrow — Moves the selected item down in sorting priority.
Left Arrow — Moves the selected item in the Sort properties list to the Available properties
list. You can select more than one item and then click this button. Also, double-clicking an item
moves it to the Available properties list.
Order — Specifies the sorting order (ascending or descending) for the report data.
Right Arrow — Moves the selected item in the Available properties list to the Sort properties
list. You can select more than one item and then click this button. Also, double-clicking an item
moves it to the Sort properties list.
Sort properties — Displays the properties selected for sorting.
Up Arrow — Moves the selected item up in sorting priority.
Define the Contents of Your Report Template

1. On the SmartPlant Reports toolbar in Microsoft Excel, click Define.
2. Select the node in the Report on hierarchy under which you want the new item type to
appear to add a new report item type so that its properties are available to map onto your
report template.
3. Click New.
 When you click New on the Define Report Contents dialog box, you can choose from
only those items that are related to the item you selected in the Report on hierarchy.
 The highest node in the Report on hierarchy under which you can add a new item is the
node that belongs to the report item type that you base your template definition on. You
can add items under any nodes subordinate to the main report item type as long as they
have items related to them.
 Using the New command skillfully allows you to navigate in all directions in the plant
hierarchy and gather properties from throughout the plant database.
4. On the New Items dialog box, select the new item that you want to add to the hierarchy.

Generating Reports
5. Change the name of the item that appears in the hierarchy by typing text in the Name box.
If the item that you choose has the same name as an item elsewhere in the hierarchy,
you must type a different name for it in the Name box.
6. Click Apply.
7. When you have added all the items that you want from this list, click Close.
If you want to add more new items under another node in the hierarchy, choose that
node and repeat the previous steps.
8. On the Define Report Contents dialog box, select an item with properties that you want for
your report template.
9. Click Define.
10. On the Properties tab of the Define Report Items dialog box, choose the properties that
you want to map to your report template.
 If you want to sort the order in which your items are listed when you generate a report,
choose the property or properties to sort on by using the Sort tab.
 If you want to change the filter that finds your report items, use the Filter tab. For
instance, you can switch from a filter that displays all pumps to a filter that displays only
active pumps.
11. Click OK.
The Define Report Contents dialog box remains open, and so you can repeat the
previous steps to continue adding more items and specifying their properties.
12. When you have selected all the properties that you want in your report, click OK on the
Define Report Contents dialog box.
 All the properties that you have made available to map into your template are now displayed
when you click Map Properties on the SmartPlant Reports toolbar. Now you can use the
properties you have specified in the layout of your template.
 If a certain property is not available in the import code, the import code also needs to be
updated. For more information on import code and other importing parameters, see the
Import Implementation Customization topic in the SmartPlant P&ID Programmer's Guide. To
view this file, on the Start menu, click Intergraph SmartPlant P&ID > Programming Help.
 In order to generate From and To data for all Microsoft Excel worksheets, click Tools >
Macro > Macros > PrintFromToDataForAllSheets in Excel. Choose the
PrintFromToDataForActiveSheet macro to generate this data for only the active
worksheet.

Generating Reports
Options Command
MS Excel > SmartPlant Reports Toolbar > Options
Opens the Report Options dialog box, which provides options for defining header and spacing
details in your report template. The Options button on the SmartPlant Reports toolbar is not
available for editing a fixed format report template because you are free to place headers and
data anywhere you want to on your worksheet.
Report Options Dialog Box

This dialog box allows you to set various options for a report template. You can specify the
number of blank lines between each row between in your report, the number of rows in your
report header, and sort the map properties.
This dialog box opens when you click Options on the SmartPlant Reports toolbar in Microsoft
Excel.
Skip lines between rows — Defines the number of blank lines between each row in your
report. You can enter a value in the box or use the scroll buttons to select a value. The
maximum value allowed is 1000.
Rows in report header — Specifies the number of rows in your report header.
The Options command is available for tabular and composite format report templates
only. It is not available for fixed format report templates because you are free to place captions
and properties in any configuration that you want. In fixed format report templates, you are not
constrained to have a header or rows at all.
'Map Properties' sort order — Allows you to sort the properties in the report the report
template. These properties are available when you click Map Properties on the report template
toolbar.
 Ascending — Sorts the list of properties in the report template in ascending alphabetical
order.
 Descending — Sorts the list of properties in the report template in descending alphabetical
order.
 None — Leaves the properties in the original order in which they appear in the list.
 When sorted in ascending or descending order, the properties that have sub-properties
appear first sorted alphabetically, followed by the properties that do not have sub-properties,
sorted alphabetically.
 For a summary report, the list entry Report Item Group Total that appears at the lowest
level is always at the bottom of the list, regardless of the sort order selected.
Prompt for alternative format — Select this check box to display a prompt for an alternative
format when reporting on a property that has units of measure. When cleared, the property will
display using the format specified in the Properties window.

Generating Reports
Select Alternative Format for Display Dialog Box

This dialog box appears when, on the Report Options dialog box, the Prompt for alternative
format check box was selected.
Property — Shows the display name of the selected property.

Format — Select the desired format from the list. The default format is always selected initially.
Display units of measure — Select this check box to display the selected units of measure in
the report. Clear the check box to display the property values without units of measure.
 Formats with primary, secondary, and tertiary units are truncated to the primary value with
no rounding when the units are not displayed. Therefore if you clear the Display units of
measure check box, you may not get accurate results when using such a format. If you do
not want to display units of measure, consider using a format that has primary units only.
 Use caution when importing a report that contains numerical values without units of
measure. In such cases, these numerical values will be imported using the plant default
formats, potentially altering the items' properties. For example, if a report was created with a
temperature in Celsius without displaying the units (using an alternative format), a numerical
value of 100 in the report (intended as 100 ºC) will be imported as 100 ºF (37.78 ºC) into a
plant with ºF as the plant default.
Display Properties with Units Using an Alternative Format

This procedure explains how to specify a particular format for displaying in a SmartPlant P&ID
report the value of a property that has units of measure. The software displays the numeric
value in accordance with the conversion formula specified for the selected format. The user
can specify whether to include the units of measure with the displayed value.
2. On the Edit Report Template dialog box, select a report from the Available reports list.
3. Click Open to display the report in Microsoft Excel.
4. Click the Add-Ins tab, and in the Custom Toolbars area, click Options.

Generating Reports
5. On the Report Options dialog box, ensure that the Prompt for alternative format check
box is selected.
6. Click OK to close the Report Options dialog box.
7. Choose a cell where you want the property to appear.
8. Click the Add-Ins tab, and in the Custom Toolbars area, click Map Properties.
9. From the menu, select a property with units of measure that you want to map to the chosen
cell.
The properties on the Map Properties menu are specified when you define the
contents of your report. For more information, see Define the Contents of Your Report
10. On the Select Alternative Format for Display dialog box, do the following:
a. From the Format list, select the desired alternative format.
Initially, the default format is selected.

b. To include the units of measure of the alternative format in the display, select Display
units of measure.
 Formats with primary, secondary, and tertiary units are truncated to the primary
value with no rounding when the units are not displayed. Therefore if you clear the
Display units of measure check box, you may not get accurate results when using
such a format. If you do not want to display units of measure, consider using a
format that has primary units only.
 Use caution when importing a report that contains numerical values without units of
measure. In such cases, these numerical values will be imported using the plant
default formats, potentially altering the items' properties. For example, if a report
was created with a temperature in Celsius without displaying the units (using an
alternative format), a numerical value of 100 in the report (intended as 100 ºC) will
be imported as 100 ºF (37.78 ºC) into a plant with ºF as the plant default.
c. Click OK to place the property syntax in the cell.
If the format name mentioned in the report template does not exist in the active
plant, the cell will be left blank when the report is generated.

Generating Reports
11. Save the template and quit Microsoft Excel.
Example
Let us assume that the property you want to display is 'Design Max Pressure' and that the
default format is Pressure-psig.
 If the default format is chosen, the value of that property will be displayed in the report with
the units of measure defined for that format. The string that appears in the cell is:
#Pipe Run::Design MaxPress::ProcessDesign.Max.Pressure#
 If an alternative format named ‘Pressure-BarG’ was chosen to display the property, the
string that appears in the cell is:
#Pipe Run::Design
MaxPress::ProcessDesign.Max.Pressure[Pressure-BarG]#
 If the Display units of measure check box was cleared, the property will be displayed using
the numerical value of the format without showing the units of measure in the report, and the
string that appears in the cell is:
#Pipe Run::Design
MaxPress::ProcessDesign.Max.Pressure[Pressure-BarG::-1]#
Map Properties Command

Displays a menu of all properties associated with your report. This menu is populated with the
items that you define using the SmartPlant Reports toolbar Define command. The Map
Properties menu contains a subset of all the properties in the plant database.
You can select a cell in your report template and then assign a property from the Map
Properties list. The software places the corresponding property in the selected cell. You do not
have to map all the properties in the Map Properties menu, and you can add properties to the
menu by using the Define command again.
The SmartPlant Reports toolbar appears in Microsoft Excel when you create or edit a
report template.

SECTION 9
Printing Drawings
You can print your drawings on many different devices ranging from dot matrix printers to laser
printers and plotters. Except for the color settings and a few special effects, your drawing prints
exactly as it appears in the Drawing view. This stipulation applies to special settings like the
display of claimed items, inconsistency indicators, or filtered items.
 Print an entire drawing or specific views from a drawing.

 Set printing options, such as the range of sheets or number of copies to print.
The software supports plotting using standard Windows plotting capabilities. It also supports pen
plotters, subject to the limitations of the device driver. Items look the same on the screen and in
the printed drawing. However, the fonts you select can affect the match between what you see
on the screen and what appears on the printed page. Three kinds of fonts affect your work:
scalable fonts, printer fonts, and screen fonts. Use scalable fonts, such as TrueType® fonts, to
make sure that what you see on the screen is what appears on the printed page. If you use
printer fonts, you must have a corresponding screen font and font size to display each font on
the screen. If each screen font you use has a matching printer font, the screen display of the
drawing closely matches the printed drawing.
Printing Part of a Drawing

You can print selected sheets in a drawing or a selected area. This feature is handy if you are
working on a complex drawing and you want to print only certain parts to proof them. You can
print all views or certain views. You can print not only drawing items that are selected, but other
items that are in the view with the select set print.
Printing Time
Drawings can take some time to print. Expect longer print times when you have drawings that
contain a large number of the following items:
 Curved items
 Many fills that have complex colors, patterns, or textures
 Large bitmaps
 Links to various drawings
The type of printer you have also affects the printing time. PostScript® printers print faster than
LaserJet printers, because they can make the necessary calculations faster. Some older
versions of PostScript® printers are slower when compared to the newer ones. The type of
controller boards and the amount of RAM in the printer also affect your printing times.

Printing Drawings
Print Command (File Menu)
Sends a copy of the active drawing to a specified plotter, printer, or file. Options are available for
defining the printing area, range, number of copies, and other printing characteristics. This
command also opens the Print dialog box.
Before using this command, you must install and select a printer. For help on installing a printer,
see the printer documentation.
Print Dialog Box

Controls how a drawing is printed. This dialog box opens when you click File > Print on the
menu bar.
Name — Specifies the printer you want to use. You can select from a list of all the available
configured printers. The information below the Name box applies to the selected printer. The
printer you select in the Name box is the default printer for the rest of the current design session
until you specify a different printer.
Properties — Opens the Printer Document Properties dialog box, which allows you to specify
page setup and other printer settings.
Status — Describes the state of the selected printer, such as, busy or idle. This area is
read-only.
Type — Displays the type of printer currently selected. This area is read-only.
Where — Identifies the printer path, printer port, queue name, or physical location of the
currently selected printer. This area is read-only.
Comment — Displays any comments you entered during printer configuration. This area is
read-only.
Print to file — Stores your drawing in a file with extension .prn instead of sending it to a printer.
The Print to File dialog box appears when you select the Print to file option on the Print dialog
box and then click OK. You select a file name and location for the print file in the Print to File
dialog box. Then you can print from a computer that does not have the application installed or
print to a printer other than the one you currently have configured.
Drawing — Prints your entire drawing.
View — Activates the All and Active check boxes so you can then define the view or views to
print.
Selection — Prints the user-defined area. When you select this option, the Settings button at
the bottom of the Print dialog box is unavailable.
All — Prints each defined view associated with the drawing.
Active — Prints only the active view.
Fit to page — Prints your entire drawing on one page.
Print watermark — Prints a faint graphic in the drawing background.
Print black and white — Prints the drawing in black and white.

Printing Drawings
Number of copies — Displays the number of copies you want to print. Type the number or use
the scroll buttons to specify a number.
Collate — Prints the copies in proper binding order.
Settings — Opens the Settings dialog box, which allows you to view and edit the scale and
origin of your print area. This button is disabled when the Selection option in the Print range
group is selected.
Settings Dialog Box

Specifies the print layout for the drawings to be printed. These settings apply to all drawings you
have selected to print. This dialog box opens when you click Settings on the Print dialog box.
Scale
Controls the scale applied to the print area in a document.
Best fit — Scales the selected drawing sheets or print area to fit the printer paper for the
configured device.
Manual scale — Specifies the scale value to apply to the print range during printing. For
example, if the print range is a rectangle at 12 cm by 12 cm and you set a manual scale of 1:12,
then the printed range appears to be 1 cm by 1 cm on the printer paper. If you want a 1:1
drawing of the current sheet scale, you can set the Paper length option to 1 and the Design
length option to 1.
Paper length — Specifies the paper length for the document you want to print with respect to
the Design length option.
Design length — Specifies a design length (size of the printed graphic) with respect to the
Paper length option.
Origin
Adjusts the origin of the graphic area, thereby changing the location of the effective print area on
the paper.

Printing Drawings
Center — Positions the print area center to the center of the printer paper. If you do not set this
option, then the paper positions at bottom left to bottom left.
X origin — Sets a shift in the x-direction from the origin.
Y origin — Sets a shift in the y-direction from the origin.
Preview
Displays dynamically how the graphic prints on the sheet as you change other options on the
dialog box.
For many of the options on this dialog box such as, Design length, Paper length, X, Y,
and so forth, when you change an option, the red, blue, and black boxes in the Preview area
change to reflect your new values. Therefore, you have a dynamic representation of how your
graphic fills the printed sheet.
Print a Drawing
1. Click Print on the Main toolbar.
2. Select the printer that you want to use from the Name list.
3. In the Number of copies box, type the number of copies you want.
4. In the Print range box, specify the range of pages you want to print.
It is a good idea to save your drawing before you print it so that a printer error or other
problem does not cause you to lose any work completed since the last time you saved the
drawing.
 You can set other options for the printer by clicking the Properties button or the Settings
button on the Print dialog box.
 Click File > Page Setup to specify the drawing size (not available for SmartPlant P&ID
Engineering).
 You can display the drawing as it is to be printed. Click Tools > Options. On the General
tab, select the Display as printed option.
 Before you can print for the first time, you must connect the printer to the computer or
network, install a printer driver, and select the printer to print the drawing. For more
information about how to install a printer, see the printer documentation.

Printing Drawings
Print a Selected Area

1. Select the portion of the drawing for printing.
For more information on zooming in on an area of a drawing, see Zoom In on an Area
(on page 25).
2. Click File > Print.
3. On the Print dialog box, choose Selection from the Printer Range area.
Set Print Options

1. Click File > Print or the Print button on the Main toolbar.
2. Do one of the following.
To print Do this
The entire drawing Under the Print range option, select Drawing. The entire
drawing is printed.
All defined views Arrange the views you want to print, and then on the Print dialog
box, select View and All.
You can create more than one Drawing view by selecting
Window > New > Drawing and zooming or panning to the area
of the Drawing view that you want to print.
The active view Select View and then Active.
A selected area Select the item or portion of the drawing that you want to print.
Click Selection. The Settings button becomes unavailable. Click
OK on the Print dialog box.
To a file Select Print to file on the Print dialog box. Click OK. The Print
to File dialog box appears, and you can enter the file name and
select its location.
Multiple copies In the Number of Copies box, enter a number of copies. To sort
the sheets by sheet number, select Collate.
Drawing fit to 1 page Under Options, select Fit to page.
Watermark Under Options, select Print watermark.
Black and white Under Options, select Print black and white.
 You can set other options for the printer by clicking Properties or Settings on the Print
dialog box. You can set the paper size, source, and orientation.

Printing Drawings
 When specifying line widths for display sets, you can set label graphics and leader lines to
appear in the default width of the labels regardless of the line width value specified for model
items. This option is specified by using a key 'IgnoreDisplaySetWidthOnLabels' under the
'Options' section of the SmartPlantPID.ini file (located in the users\<username> folder) as
shown:
[options]
WaterMarkWhileWorking=True
WaterMarkWhilePrinting=True
undosteps=0
autogapping=False
ConsistencyChecks=True
.
.
.
IgnoreDisplaySetWidthOnLabels=1
The following table shows how the values assigned in the SmartPlantPID.ini file affect the
output.
Key Value Resultant Behavior when Applying Display

Set
IgnoreDisplaySetWidthOnLabels=1 Label line widths are independent of model item

line widths; label line widths are set to default
value for labels.
Label line widths are independent of model item
line widths; line widths of label graphics and
leader lines are set to the default value for labels.
IgnoreDisplaySetWidthOnLabels=0 Label line widths, including graphics and leader

No key Label line widths, including graphics and leader

 If you want to print more than one drawing, use SmartPlant P&ID Drawing Manager, which
has multiple drawing printing functionality.

Printing Drawings
Change Printer Properties

1. Click File > Print.
2. On the Print dialog box, click Properties.
3. On the Layout tab, view or change the Orientation option and choose the Duplex Printing
option if necessary.
4. On the Paper/Quality tab, view or change the Paper Source option and color quality
setting.
5. Click Advanced on the Printer Document Properties dialog box to specify more printing
options, such as, the Copy Count, Scaling, Paper Size options, and so forth.
6. Click Properties on the Print System Advanced Options dialog box to open the Halftone
Color Adjustment dialog box and further specify color, picture, style, and so forth.
Displayed tab names may vary depending on the type of printer you are using.
Print to a File
1. On the Main toolbar, click Print .
2. On the Print dialog box, select Print to file.
3. Click OK.
4. On the Print to file dialog box, select the folder to which you want to print to, and type the
name of the file.
The file is saved with a .prn extension.
Page Setup Command (File Menu)

Opens the Page Setup dialog box.

Printing Drawings

SECTION 10
Working with SmartPlant Integration

Integration standardizes and improves the communication among the various authoring tools
you use in the course of designing, constructing, and operating a plant. SmartPlant integration
manages data exchange among these authoring tools, which enables sharing and re-use of
plant information throughout the plant life-cycle. 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 Electrical, and Smart 3D.
Most of the commands that provide access to SmartPlant integration functionality exist in the
common user interface available on the SmartPlant menu in Engineering Manager, SmartPlant
Instrumentation, SmartPlant Electrical, SmartPlant P&ID, and Drawing Manager.
The following graphic displays what SmartPlant P&ID publishes and retrieves and shows the
flow of data and the different types of data.
SmartPlant P&ID interacts with SmartPlant Foundation by correlating items between the plant
database and the SmartPlant Foundation database, retrieving documents from SmartPlant
Foundation. Also, SmartPlant P&ID creates a set of tasks in the To Do List that you can run to
update the plant database. In SmartPlant P&ID, you can also use the commands on the

SmartPlant menu to publish documents and retrieve data, access the SmartPlant Foundation
Web Portal in order to browse in SmartPlant Foundation, and subscribe to change notifications
and compare documents.
You can only use the SmartPlant menu commands after your plant is registered. For
more information, see SmartPlant Engineering Manager Online Help.
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
SmartPlant Electrical or SmartPlant Instrumentation, you must register each plant in SmartPlant
P&ID with a SmartPlant Foundation database. The connection allows SmartPlant P&ID to use
the commands on the SmartPlant menu. A SmartPlant Engineering Manager administrator
typically registers a plant.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The system administrator must register each plant in the authoring tool once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.
Tool Requirements for Integrating SmartPlant P&ID

This topic describes rules and settings that allow SmartPlant P&ID data to be shared correctly
with Aspen Basic Engineering, Smart 3D, SmartPlant Instrumentation, and the other tools that
are part of an integrated environment. Other tools that are not listed here have no known
SmartPlant P&ID/SmartPlant integration issues.
General Integration Requirements

The following is a list of best practice scenarios for using SmartPlant P&ID so that data will
migrate correctly to other SmartPlant tools:
To enable publishing from a project, you must create a project in SmartPlant Foundation
with the same name (case-sensitive) as the P&ID project.
 When creating formats for use with SmartPlant P&ID publishing, the formats must be added
and mapped in SPPIDDataMap.xml using Schema Editor. The UID string of the custom
SPMapUOMDef map file must be of the form SPMU_<NN>_FormatName>, where 'NN'
represents the SPMapUOMListDef ID for the format type (for example Temperature = 5;
Pressure = 27). Since spaces or restricted characters are not allowed in the UID string,
custom format names must not include spaces or restricted characters.
 If you intend to publish select lists (enum lists) to SmartPlant Foundation, make sure that
you review the SmartPlant Adapter for SmartPlant P&ID Guide to understand the
requirements (see under Data Transformation Logic > Publish/Retrieve).
 If the SmartPlant P&ID item tag validation allows for duplicate tags, this may have an impact
on downstream tools such as SmartPlant Instrumentation, which does not allow duplicates.
In such cases, allowing duplicates in SmartPlant P&ID can cause problems in the retrieving
tool.

By default, SmartPlant P&ID item tag validation does not allow duplicate item tags for
loops or instruments.
Working with SmartPlant Instrumentation

Retrieving Documents
 If a SmartPlant P&ID drawing that includes items with a flow direction is to be retrieved by
SmartPlant Instrumentation, a flow direction of End 1 Upstream or End 1 Downstream
must be defined in SmartPlant P&ID. Bi-directional flow is not supported.
Connect to Process Lines

 Connect to Process lines are required for connecting instruments to equipment nozzles
and pipe runs in SmartPlant P&ID.
 All non-piped offline equipment instruments must be connected to vessels through
non-electric signal lines and nozzles in SmartPlant P&ID. This enables SmartPlant
Instrumentation to recognize that instruments are connected to vessels.
 If SmartPlant P&ID assigns an object to an intermediate level in the hierarchy and publishes,
SmartPlant Instrumentation will assign the object to the level in the hierarchy in SmartPlant
Instrumentation determined by their logic. Because instruments belong to units in
SmartPlant Instrumentation, an instrument assigned to the intermediate level in SmartPlant
P&ID will be assigned to the unit in SmartPlant Instrumentation. Panels will be assigned to
the plant. SmartPlant P&ID may get an update on retrieve to move the object to another
level in their hierarchy than where it was published based on the move done automatically
by SmartPlant Instrumentation. Panels will move to the top level; instruments will move to
the bottom.
Instrument Expansion
 A SmartPlant P&ID instrument or loop tag does not always have a 1:1 relationship with
instruments in SmartPlant Instrumentation. In some cases, a single item tag in a P&ID
corresponding to an instrument or loop needs to be expanded to create several instruments
when publishing the data for SmartPlant Instrumentation. For this purpose, the Expansion
Type property in SmartPlant P&ID specifies the expansion behavior when publishing an
instrument or loop. Each value of the property corresponds to a SmartPlant Instrumentation
rule that determines which instrument types and numbers are to be created in SmartPlant
Instrumentation when the SmartPlant P&ID tag is expanded and retrieved.
When retrieving data back to SmartPlant P&ID, the behavior of a particular
instrument created by expansion is determined by SmartPlant Instrumentation parameters.
For an expanded instrument, the state of the IRetrievableExpansion interface determines
whether that instrument will be retrieved by SmartPlant P&ID: if the IRetrievableExpansion
interface is realized, the instrument is retrieved, whereas if the IRetrievableExpansion
interface is not realized, the instrument is not retrieved. The 'parent' item tag is always
retrieved, regardless of the realization state of the IRetrievableExpansion interface.
Ports
 SmartPlant Instrumentation uses physical ports, while SmartPlant P&ID uses logical ports.
SmartPlant Instrumentation publishes the physical ports with the Dimensional Data Sheets
and not the Instrument Index. SmartPlant P&ID retrieves the Instrument Index and does
not retrieve the Dimensional Data Sheets.

When the workflow goes from SmartPlant P&ID to SmartPlant Instrumentation, followed by
SmartPlant Instrumentation publishing the Dimensional Datasheet, a Same As relationship
is created between the ports in the SmartPlant Foundation database. That Same As
relationship is required by Smart 3D to correctly match the design basis ports to the 3D
representation of the ports.
When the workflow goes from SmartPlant Instrumentation to SmartPlant P&ID, however, a
Same As relationship is not created in the SmartPlant Foundation database. Without the
Same As relationship created in the SmartPlant Foundation database, the result may be
additional ports in Smart 3D. To obtain the Same As relationship on the ports requires that
SmartPlant P&ID publish the P&ID with the instrument, this P&ID be retrieved by SmartPlant
Instrumentation and then having SmartPlant Instrumentation publish the Dimensional Data
Sheet.
Working with Smart 3D

General
 In Options Manager, ensure that under Settings, the Use Piping Specification setting
value is Smart 3D even if the P&ID plant is not validating piping specifications. This is to
ensure that the required Piping Component Select List entries are properly set to match the
PIP short codes expected by Smart 3D. For details, see Configure Piping Specification
Settings in SmartPlant P&ID Options Manager User's Guide.
Drawing Items
 For Smart 3D to properly determine flow direction in a process run, that process run must be
connected to at least 2 items.
 Some items that can be represented as single objects in SmartPlant P&ID, such as Vent
Detail, are modeled in Smart 3D as a set of separate objects. For full correlation to be
established between the two tools, ensure that these objects are modeled in SmartPlant
P&ID with the same configuration used to represent them in Smart 3D.
Properties
 Smart 3D handles temperature and pressure properties in pairs and does not support
having a temperature (for example, Normal Operating Temperature) without defining the
matching pressure (in this case, Normal Operating Pressure). While this is a valid condition
for SmartPlant P&ID, it should be a consideration when publishing for retrieval into Smart
3D. Without the Pressure / Temperature pair of values defined, the Smart 3D user will be
required to enter a value that was not defined in SmartPlant P&ID.

Working with Aspen Basic Engineering

 Basic Engineering data sheets can contain multiple objects and may be formatted in a
traditional data sheet view or list view (for example, as an equipment list). Data sheets
retrieved from Basic Engineering may include stream data, specialty piping data, or relief
valve data as required by business practices.
Using Workshare in an Integrated Environment

The following rules apply to using the Workshare functionality within an integrated SmartPlant
environment:
 You can enable and disable Workshare before or after registering a Greenfield plant.
 You can create satellites and connect to them after registering.
 You cannot register a satellite.
 You cannot retrieve a WBS document when Workshare is enabled.
Using the Integration Commands Within a Workshare Collaboration

The Workshare host can perform the following actions from within SmartPlant P&ID when
registered. For more information about these commands, see the SmartPlant P&ID User's
Guide.
 Publish — Any drawing can be published.
 Retrieve — Any SmartPlant document can be retrieved.
 Correlate — Reviewing correlation is available if the drawing is in a read-only state. It is
not possible to assign correlation in a read- only drawing.
 To Do List — Only available at the Workshare Host. To Do List tasks may be reviewed on
drawings for which the host does not have ownership, but these tasks may not be executed
unless ownership is assigned to the Host. The To Do List is not available at the Satellite.
Using the Catalog Index in SmartPlant P&ID and SmartPlant

Integration
When you select the Retrieve command, the software accesses the CatalogIndex.mdb and the
system performs the following actions:
1. Using the retrieved document, the object type and classification of the retrieved item is
determined.
2. Using the SmartPlant P&ID Map file, the ItemTypeName (Equipment, PipeRun,
PipingComp, Loops, and so forth), and codelist indices for Class, Sub-Class, and Type is
determined.
Catalog Index Lookup

The Catalog Index file is used to find a symbol in the catalog with type properties that match the
given values. The lookup is performed using the most specific information first. If a match is
found, that symbol is used. However, if there is no match, the more generic type information is

used for additional searches. In this way, a generic symbol will be returned if no specific symbol
is available in the catalog.
Search Based on Type Value — Searches the catalog index for all rows with matching
ItemTypeName and Type values and IsDefaultForType = True. If one or more rows are found,
the software uses the CatalogItemName from the first one. If no match is found, the software
performs the search based on Subclass.
Search Based on Subclass Value — Searches the catalog index for all rows with matching
ItemTypeName and SubClass values and IsDefaultForSubclass = true. If one or more rows are
found, the software uses the CatalogItemName from the first one. If no match is found, the
software performs the search based on Class.
Search Based on Class Value — Searches the catalog index for all rows with matching
ItemTypeName and Class values and IsDefaultForClass = True. If one or more rows are found,
the software uses the CatalogItemName from the first one. If no match is found, the software
returns an empty string.
Upgrade Schema Command (SmartPlant Menu)

Upgrades the existing SmartPlant schema associated with the active plant to a newer version.
The software upgrades the SPPIDDataMap.xml file, including user customizations, with the
latest version data from the files in the ..\SmartPlant\P&ID Workstation\bin folder path and
registers the schema version at the beginning of the .xml file.
The SmartPlant Adapter and Tool Schema

The tool schema implements a mapping between the objects in the SmartPlant P&ID data
model and the objects in SmartPlant schema. If you customize either the SmartPlant P&ID data
model or the SmartPlant schema, you may also need to customize the mapping contained in the
tool schema. The following describes the structure of the tool schema and how it is used by the
SmartPlant P&ID adapter in order to support the publish and retrieve functions.
Publish
When a P&ID drawing is published, the Adapter extracts data from the SmartPlant P&ID
database and converts it into a set of objects and relationships that are compatible with the
SmartPlant schema. These objects and relationships are written out to an XML file and are sent
to the SmartPlant Server for further processing. The adapter depends on the data in the tool
schema to support the publish operation.
For each published class in the tool schema, there is a code module in the adapter known as a
Class Publisher. The Class Publisher contains code for the following tasks:
 Query the P&ID Database — The Class Publisher queries the database to obtain the
collection of items to be published.
 Create a Data Object — For each item to be published, the Class Publisher creates a data
object in the document container. The class of this object is the SmartPlant schema class
related to the MapClass via the MapClassToClass relationship.

 Set the Property Values — The property values on the data object are set according to the
values on the SmartPlant P&ID item. The list of properties to be published is defined by the
list of MapProperties related to the current MapClass.
 Publish Relationships — The Class Publisher defines the types of relationships that are to
be published for each data object it publishes.
Retrieve
When a document from another authoring tool is retrieved, the adapter compares the objects in
that document to the data in the SmartPlant P&ID database and generates tasks in the To Do
List. A Create task is generated when a new item needs to be created. An Update task is
generated when an existing item needs to be modified. A Delete task is generated when an
existing item needs to be deleted. The adapter depends on the data in the tool schema to
support the retrieve operation.
Generation of Create, Update, and Delete tasks can, if desired, be suppressed for
specified document types, for example, for objects that are not correlated between the
publishing and retrieving tools. For details of how to do this, see Suppress Generation of Tasks
on Retrieve (on page 286).
For each retrieved class in the tool schema, there is a code module in the adapter known as a
Class Retriever. Each Class Retriever contains code for retrieving a class of objects.
When a document is retrieved, the adapter receives two containers of data.
1. The document container includes all of the published objects and relationships for that
document.
2. The tombstone container includes information about deleted objects and relationships.
The adapter iterates over all of the objects in the document container and performs these
actions:
 Use Identifying Interface to Determine Class — The incoming object is tested for an
identifying interface to determine which Class Retriever should handle the retrieval of that
object.
 Generate Update Task — The Class Retriever searches for an existing SmartPlant P&ID
item to update. If an item is found, it generates an Update task in the To Do List. The
properties of the incoming object are compared against the properties of the existing item.
When differences are found, property updates are added to the task. The list of properties to
be compared is defined by the properties in the tool schema.
 Generate Create Task — If no item is found to update, a Create task is generated in the To
Do List. Property updates are added to the task for each of the incoming property values.
The list of properties to be added is defined by the properties in the tool schema.
For SmartPlant P&ID Engineering, it is not possible to run Create tasks.
 Retrieve Relationships — The Class Retriever defines the types of relationships that are to
be retrieved for each data object.
The adapter iterates over all of the objects in the tombstone container and performs these
actions:
 Generate Delete Task — The adapter searches for an existing item in the SmartPlant P&ID
database that is correlated to the item that was deleted in the other application. If such an
item is found, a Delete task is generated in the To Do List.

For SmartPlant P&ID Engineering, it is not possible to run Delete tasks.
SmartPlant P&ID Mapping Rules and Limitations

 For properties that use enumerated lists to publish, you must add
EFAdapter.EnumConversions to the process criteria when you define the map property
definition in the tool schema.
 When you create a new enumerated list definition in the tool map file, you must replace the
system-generated UID for the list with SP_<Codelist_Index>, for example, SP_12001. The
codelist index is located in the Enumerations database table for the SmartPlant P&ID Data
Dictionary user in the SmartPlant P&ID database.
 When you create enumerated list entries in the tool map file, you must replace the
system-generated UID for each list entry with SP_<Codelist_Index>_<Codelist_Number>,
for example, SP_12001_1. The codelist index for the enumerated list and the codelist
number for the entry are located in the Enumerations and Codelists database table for the
SmartPlant P&ID Data Dictionary user in the SmartPlant P&ID database.
 If you want SmartPlant P&ID to create line numbers at publish time so that they match the
displayed labels on the P&ID, you can modify the process criteria for the ItemTag map
property definition in the publish map for the PipeRun tool class. To change the format for
line numbers, modify the process criteria for the ItemTag, and add the properties that you
want to include in the item tag inside angle brackets (<>) after
EFAdapter.PpConnNameConv. For example, EFAdapter.PpConnNameConv,
<OperFluidCode>- <TagSequenceNo>-<NominalDiameter>-
<PipingMaterialsClass>-<InsulPurpose>. The property names inside the angle brackets
must match property names in the map file.
 If you want SmartPlant P&ID to create the Pipe Run name at publish time so that it matches
the ItemTag value in the SmartPlant P&ID Properties window, you can remove the special
adapter method seen in the map file (as delivered it appears as
EFAdapter.PpConnNameConv, <NominalDiameter>-<OperFluidCode>-
<TagSequenceNo>-<PipingMaterialsClass>- <InsulPurpose>). This prevents the software
from performing name conversion when generating the Pipe Run name.
 You can specify for SmartPlant P&ID to create the Pipe Run name at publish time so that it
displays any pipe run properties that you desire. To do this, you add the properties that you
want to include in the item tag inside angle brackets (<>) after
EFAdapter.PpConnNameConv. However, note that the name conversion supports only
those properties that belong to the Pipe Run.
 For the Pipe Schedule property, SmartPlant P&ID uses the format: <Value> <Units>, for
example 0.5 ". The corresponding SmartPlant schema format is: <Value><Units> (no
space between the value and the units of measure), for example 0.5". To ensure that Pipe
Schedule data is published, you must specify the data using the SmartPlant schema format.

Tool Schema Location

The SmartPlant P&ID tool schema is named SPPIDDataMap.xml. This file must exist in the
folder specified by the SmartPlant ResourcePath setting in Options Manager. When a new plant
is created, you must define the value of this setting and ensure that the file exists in that folder.
During publish and retrieve operations, the adapter looks for that file in that location.
The Tool Schema Data Model

The following graphic displays a representation of the objects and relationships that are relevant
to the SmartPlant P&ID tool schema.
The rectangles on the left side of the graphic represent objects in the tool schema. The
rectangles on the right represent objects in the SmartPlant schema. The relationships that
connect objects on the left with objects on the right are the mapping relationships. The map file
contains both the tool schema objects and the mapping relationships.

MapClass
The MapClass object corresponds to the IMapClassDef interface in the Mapping Relationships
diagram. In general, there is a MapClass object in the tool schema for each SmartPlant P&ID
class (ItemType) that needs to be published or retrieved. MapClass is referred to as
SPMapClassDef in the Schema Editor. The properties and relationships for a MapClass can be
viewed in the Edit Map Class Definition dialog box.
General
Property Value
UID Must be unique. No other special requirements.
Name The internal name of the SmartPlant P&ID class (ItemType).

Required.
Process Criteria This property must be filled in for this MapClass to be used. The
format for this property is a comma delimited list of fields. The fields
are:
ProgID — The programmatic identifier of a class module within the
Adapter.
Expand Attributes Flag — A flag to indicate if the attributes should
be expanded.
Seq No — A number that indicates the sequence in which the classes
are processed. This field is used for Retrieve processing.
The user should not change any of these values. The default
values that come with the delivered Tool Schema should remain
unchanged. One exception to this is if you want to ignore the retrieval
of items in the desired class, as described in the example below.
To ignore an item for retrieval, delete all the parameters from the Process Criteria
property for the desired map class. For example, to prevent retrieval of PipeRuns, delete the
parameters for the EFAdapter.PipeRunDataExchanger map class.
Tool Schema Relationships

Relationship Comment
Map Properties The map properties associated with the MapClass must be defined
and related to it. (MapClassMapProperties in the diagram.)

Mapping Relationships
Publish to SmartPlant This relationship must be set to a class in the SmartPlant schema if
class this class is to be published. When this relationship is set, an instance
of the target class is published for each instance of the source class in
the drawing being published. (MapClassToClass in the diagram.)
Retrieve from The list of interfaces from which properties are to be retrieved must be
SmartPlant interface set if this class is to be used for retrieval. (ClassToMapClass in the
diagram.)
MapProperty
The MapProperty object corresponds to the IMapPropertyDef interface in the Mapping
Relationships diagram. In general, there is a MapProperty object in the tool schema for each
SmartPlant P&ID property that needs to be published or retrieved. The properties and
relationships for a MapProperty can be viewed in the Edit Map Property Definition dialog box
in the Schema Editor.
General
Property Value
UID Must be unique. No other special requirements.
Name The internal name of the SmartPlant P&ID attribute. Required.
Selection This field is used to specify the handling of process data properties on
Criteria PipeRuns.
Process Criteria For properties that require special handling, the ProgID of the appropriate
PropertyConversion class must be entered here. In some cases, additional
parameters are also supplied in this field. For simple properties with
matching data types, no value is required here. See the section on Property
Conversions for more information.

Exposed by map Every MapProperty must be related to a MapClass.

classes (MapClassMapProperties in the diagram.)
Scoped by If the data type of the property is enumerated, the MapProperty must be
enumeration related to a MapEnumList. If the data type of the property is UoM, the
MapProperty must be related to a MapUoMList. Otherwise, this
relationship is not needed. (MapPropertyMapEnumList in the diagram.)

Map property to This relationship defines the property in the SmartPlant schema to
property which this tool property is to be published. If this relationship is not
defined, the property will not be published. (MapPropertyToProperty in
the diagram.)
Property to map This relationship defines the property in the SmartPlant schema from
property which this tool property is to be retrieved. If this relationship is not
defined, the property will not be retrieved. (PropertyToMapProperty in
the diagram.)
MapPropertyToProperty and PropertyToMapProperty relationships may be set as being

'for documentation only'. For more information, see Define Mapping Relationships as 'For
Documentation Only' (on page 282).
MapEnumList
The MapEnumList object corresponds to the IMapEnumListDef interface in the Mapping
Relationships diagram. In general, there is a MapEnumList object in the tool schema for each
SmartPlant P&ID enumerated list associated with a property that needs to be published or
retrieved. The properties and relationships for a MapEnumList can be viewed in the Edit Map
Enumerated List Definition dialog box.
General
Property Value
UID The UID must be constructed using the following pattern:

UID = SP_<CodelistNumber>
<CodelistNumber> The numeric identifier for this enumerated list.
Name The name of the SmartPlant P&ID enumerated list.

Scoped map A MapEnumList must be related to the MapProperties that it scopes.

properties (MapPropertyMapEnumList in the diagram.)
Contains A MapEnumList can contain a variable number of MapEnum objects.

(MapEnumListMapEnum in the diagram.)
Constrains For hierarchical enumerated lists, the MapEnumList must be related to the
lower level list with the Constrains relationship.
(MapEnumListMapEnumList in the diagram.)

Constrained by For hierarchical enumerated lists, the MapEnumList must be related to the
higher level list with the Constrained by relationship.
(MapEnumListMapEnumList in the diagram.)
Maps to To support the publish operation, a MapEnumList that should be related to

the corresponding enumerated list in the SmartPlant schema by means of the
Maps to relationship. (MapEnumListToEnumList in the diagram.)
Mapped from To support the retrieve operation, a MapEnumList should be related to the
corresponding enumerated list in the SmartPlant schema by means of the
Mapped from relationship. (EnumListToMapEnumList in the diagram.)
MapEnum
The MapEnum object corresponds to the IMapEnumDef interface in the Mapping Relationships
diagram. In general, there is a MapEnum object in the tool schema for each SmartPlant P&ID
enumerated list entry that needs to be mapped. The properties and relationships for a MapEnum
can be viewed in the Edit Map Enumerated List Definition dialog box.
General
Property Value

UID = SP_<CodelistNumber>_<CodelistIndex>
<CodelistNumber> The numeric identifier for this enumerated list.
<CodelistIndex> The numeric identifier for this entry.
Name The text of the SmartPlant P&ID enumerated list entry.

Contained In Every MapEnum must be related to a MapEnumList. (MapEnumListMapEnum

in the diagram.)

Maps to This relationship defines the SmartPlant schema enumerated value to which
this P&ID enumerated value is to be published. If this relationship is not
defined, the enumerated value will not be published. (MapEnumToEnum in the
diagram.)
Mapped from This relationship defines the SmartPlant P&ID enumerated value to which this
SmartPlant schema enumerated value is to be retrieved. If this relationship is
not defined, the enumerated value will not be retrieved. (EnumToMapEnum in
the diagram.)
MapUoMList
The following graphic displays a representation of the objects and relationships that are relevant
to the mapping of units of measure (UoM). A MapUoMList is a specialized kind of MapEnumList.
Similarly, a MapUoM is a specialized kind of MapEnum. This is shown by the Implies
relationships in the graphic. A MapProperty with a UoM data type must be related to a
MapUoMList.
The MapUoMList object corresponds to the IMapUoMListDef interface in the graphic. In general,
there is a MapUoMList object in the tool schema for each SmartPlant P&ID format type
associated with a property that needs to be published or retrieved. The properties and
relationships for a MapUoMList can be viewed in the Edit Map Unit of Measure List Definition
dialog box in the Schema Editor.

General
Property Value

UID = SPMU_<FormatType >
<FormatType> This is a numeric value that uniquely identifies the format type and
therefore the UoM type within SmartPlant P&ID.
Name The name of the P&ID format type.

Scoped map A MapUoMList must be related to the MapProperties that it scopes.

properties (MapPropertyMapEnumList in the diagram.)
Contains A MapUoMList can contain a variable number of MapUoM objects.

(MapEnumListMapEnum in the diagram.)
Maps to To support the publish operation, a MapUoMList should be related to the

corresponding UoMListType in the SmartPlant schema by means of the Maps
to relationship. (MapEnumListToEnumList in the diagram.)
Mapped from To support retrieve, a MapEnumList should be related to the corresponding

UoMListType in the SmartPlant schema by means of the Mapped from
relationship. (EnumListToMapEnumList in the graphic.)
MapUoM
The MapUoM object corresponds to the IMapUoMDef interface in the Mapping Relationships
diagram. In general, there is a MapUoM object in the tool schema for each SmartPlant P&ID
format that needs to be mapped. The properties and relationships for a MapUoM can be viewed
in the Edit Map Unit of Measure List Definition dialog box in the Schema Editor.

General
Property Value

UID = SPMU_<FormatType >_<FormatName>
<FormatType> This is a numeric value that uniquely identifies the format type and
therefore the UoM type within SmartPlant P&ID.
<FormatName> This is a text value that identifies the name of the format and
therefore the UoM within SmartPlant P&ID.
Name The name of the SmartPlant P&ID format.

Contained In Every MapUoM must be related to a MapUoMList. (MapEnumListMapEnum

in the diagram.)
Maps to This relationship defines the SmartPlant schema UoM to which this
SmartPlant P&ID format (UoM) is to be published. If this relationship is not
defined, the UoM will not be published. (MapEnumToEnum in the diagram.)
Mapped from This relationship defines the SmartPlant P&ID format (UoM) to which this
SmartPlant schema UoM is to be retrieved. If this relationship is not defined,
the UoM will not be retrieved. (EnumToMapEnum in the diagram.)
Property Conversions
If the data type of the SmartPlant P&ID property does not match the data type of the mapped
property in the SmartPlant schema, a data type mismatch exists. In some cases, a property with
a data type mismatch can still be published and retrieved using specialized code. The code to
perform these data type conversions and other special handling is implemented in special
Property Conversion objects. The SmartPlant adapter is told about the need to use a Property
Conversion object by putting the ProgID of the Property Conversion class in the Process
Criteria option of the MapProperty. The list of available Property Conversion classes is shown in
the table below.
The ProgID for each of these classes is formed by prefixing the class name with the
string 'EFadapter'.

Property Conversion Class Description
BoolToEnumConv This property conversion supports the conversion needed to

publish and retrieve the SmartPlant P&ID SP_IsSpecialtyItem
property to/from the CommoditySpecialtyType property in the
SmartPlant schema.
CompFlowDirConv This class only publishes the special property called

IsFlowDirectional. There is no property named IsFlowDirectional
in SmartPlant P&ID. This information is derived from the Flow
Direction property value. If the Flow Direction on a component is
set, then this will publish IsFlowDirection as True; otherwise, it is
published as False.
EnumConversions This class implements the property conversion code for

Hierarchical Enumerated Lists.
EnumToBoolConv This class implements the property conversion code between

Enumerated to Boolean. This property conversion module is
specifically targeted to handle the StressAnalysisRequirement
property in SmartPlant P&ID.
EnumToStringConv This class implements the property conversion code between

Enumerated List to String. You can use any of the following
syntax options:
EnumToStringConv
EnumToStringConv.<Name>
EnumToStringConv.<Description>
Note that the class name or description string must be entered
exactly as shown. If you use either of the first two options,
SmartPlant P&ID publishes the Value of the property. If you use
the EnumToStringConv.<Description> syntax, SmartPlant P&ID
publishes the Short Value of the property, even if blank.
NominalDiameterConv Converts Nominal Diameter from an Enumerated List to a UoM

during publish and from a UoM to Enumerated List during
retrieve.
PortFlowDirectionConv Special property conversion to handle the publishing of

FlowDirection property on Connect Point. The Select List values
for FlowDirection for SmartPlant P&ID Piping Point and
SmartPlant PIDPipingPort do not match well. SmartPlant P&ID
uses only one Select List for FlowDirection for both
InlineComponent and PipingPoint whereas SmartPlant uses two
separate Select Lists.
PpConnNameConv This class implements the property conversion code for Piping
Connector Name property.

Property Conversion Class Description
TagPrefixConv This class implements the property conversion code for the
TagPrefix property. It populates the UnitName value for
instrumentation.
UoMToDoubleConv This class implements the property conversion code between

UoM and Double. This property conversion module is specifically
targeted to handle conversion of attributes without units (such as
Molecular Weight, CpCvRatio, Compressibility, SpecificGravity).
In SmartPlant P&ID these attributes are treated like UoM
attributes. However, in the SmartPlant schema they are simply
Double.
UoMToEnumConv This class implements the property conversion code between

UoM to Enumerated List.
Hierarchical Enumerated Lists

A hierarchical enumerated list is a complex data type in which there is a collection of related
enumerated lists and a value in a higher level list constrains the valid values in a lower level list.
When a hierarchical enumerated list is used, a separate property is created for each level in the
hierarchy.
Examples of hierarchical enumerated lists in SmartPlant P&ID are Equipment Class, Equipment
Subclass, Equipment Type, and Fluid System, Fluid Code. Examples in the SmartPlant
schema include: EqType0, ... , EqType6, and ConstructionStatus, ConstructionStatus2.
When mapping between SmartPlant P&ID and the SmartPlant schema, four cases must be
considered.
1. Simple enumerated list to simple enumerated list.
2. Simple enumerated list to hierarchical enumerated list.
3. Hierarchical enumerated list to simple enumerated list.
4. Hierarchical enumerated list to hierarchical enumerated list. When mapping between two
hierarchical enumerated lists, the number of levels in each hierarchy may not be the same.
EnumConversions — A special Property Conversion class is available to support publishing
and retrieving of enumerated properties. This class is called EnumConversions, and it is used
for all cases of mapping enumerated list properties.
Mapping Properties — Only the top level properties associated with a hierarchical enumerated
list are mapped. The lower level properties are left unmapped. The EnumConversions object
obtains all of the values from the set of related properties even though they are not explicitly
mapped.
Tool Schema Relationships — The MapEnumList objects that form an enumerated hierarchy
must be related to each other with the Constrains and Constrained By relationships. The
EnumConversions object relies on these relationships to get the job done.

Mapping Enum Values — An enumerated value within an enumerated list hierarchy can be
mapped to any value (at any level) in the target enumerated list hierarchy. There is no explicit
relationship between the levels of two hierarchies.
Catalog Index
During retrieval of a document, when a create task is generated, the adapter must select a
symbol to be used by the task. The adapter uses the Catalog Index to quickly find a suitable
symbol to be used. The Catalog Index lookup is based on the type properties. For example,
when generating a create task for Equipment, the Equipment Class/Subclass/Type properties
are used to perform the lookup. Before the Catalog Index lookup can take place, the incoming
SmartPlant type values must be converted into SmartPlant P&ID type values. This conversion of
a SmartPlant schema enum value into a SmartPlant P&ID enumerated value is performed by
the EnumConversions object just like any other enumerated property value. It depends on the
mapping of enumerated values found in the tool schema.
Drawing
There is a MapClass in the tool schema for Drawing. The MapProperties for this MapClass
define the properties that will be published from the SmartPlant P&ID Drawing item to the
SmartPlant schema PIDDrawing object. If new properties are added to the Drawing item type in
the Data Dictionary Manager, and corresponding new properties are added in the SmartPlant
schema, then they can be mapped by adding new MapProperties to this MapClass in the tool
schema using the Schema Editor.
Equipment
In SmartPlant P&ID there is an abstract class for Equipment with four subclasses for Vessel,
Exchanger, Mechanical and OtherEquipment. In the SmartPlant schema, there are four PID
equipment classes.
1. PIDProcessVessel
2. PIDHeatTransferEquipment
3. PIDMechanicalEquipment
4. PIDProcessEquipment
The tool schema has a MapClass for each of the four equipment subclasses in SmartPlant P&ID
and another MapClass for the abstract Equipment class.
Publish — The four MapClasses map the corresponding equipment classes in SmartPlant P&ID
and the SmartPlant schema. A SmartPlant P&ID vessel is published as a PIDProcessVessel in
SmartPlant; an Exchanger is published as a PIDHeatTransferEquipment, and so forth. The
MapClass for Equipment does not play any role in the publish operation.
Retrieve — When a document is being retrieved, each incoming object is tested for identifying
interfaces to determine what type of object it is. The object is first tested for the identifying
interfaces for Vessel, Exchanger, Mechanical and OtherEquipment. If the object has one of
these identifying interfaces, it is retrieved as that specific type of equipment (using the
MapProperties associated with the specific MapClass for that equipment class in the tool
schema). If the object is not recognized by its interfaces as any of these specific equipment
types, but it is recognized as Equipment, it is retrieved as generic equipment (using the
MapProperties associated with the generic Equipment MapClass in the tool schema).

Instrument
In SmartPlant P&ID there is one Instrument class.
In the SmartPlant schema, there are three PID instrument classes.
 PIDInstrument
 PIDInlineInstrument
 PIDControlSystemFunction
The tool schema has three MapClasses.
 Instrument
 InstrumentInline
 InstrumentCtrlSysFunc
The SmartPlant P&ID adapter has three separate Class Publisher/Retriever objects for these
three classes.
Publish — All SmartPlant P&ID instruments with Instrument Class equal to System Function
are published as PIDControlSystemFunction using the InstrumentCtrlSysFunc MapClass. All
SmartPlant P&ID instruments with IsInline equal to True are published as PIDInlineInstrument
using the InstrumentInline MapClass. All other SmartPlant P&ID instruments are published as
PIDInstrument using the Instrument MapClass.
Retrieve — All objects that have the IControlSystemFunction interface are retrieved as
Instruments using the InstrumentCtrlSysFunc MapClass. All objects that have the
IInstrumentOcc interface are retrieved as Instruments using the PIDInlineInstrument MapClass.
The InstrLoop map class in the tool schema is used for the instrument loop, which is
usually retrieved when retrieving the associated instruments. To retrieve instruments from
SmartPlant Instrumentation without their associated loops, for the InstrLoop map class
Process Criteria property, change the string 'EFAdapter.InstrLoopDataExchanger,False,7' to
'EFAdapter.InstrLoopDataExchanger,False,7,False' (add an extra 'False' parameter with a
comma separator at the end). For more details, see MapClass (on page 266).
PipeRun
In SmartPlant P&ID there is a single class for PipeRun. This class has properties describing
aspects of the physical pipe and other properties that describe the fluid flowing through that
pipe. In the SmartPlant schema there are two relevant classes: PIDPipingConnector for the pipe
itself and PIDProcessPoint for the process data. Furthermore, the SmartPlant schema has
several classes that are used to publish a stream and its associated process data on a PFD.
The SmartPlant P&ID tool schema has one MapClass for PipeRun.
Publish — Each SmartPlant P&ID PipeRun is published as a PIDPipingConnector and a
PIDProcessPoint with a relationship between the two. Some of the properties from the PipeRun
are mapped to the PIDPipingConnector and others are mapped to the PIDProcessPoint.
Retrieve — When an object is retrieved with the IPipingSystemConnector interface, it is
recognized as a Stream and is retrieved using the PipeRun MapClass to create or update a
PipeRun. The ProcessDataCaseComposition relationship is traversed to obtain objects that
realize the IProcessDataCase interface. From those objects, the ProcessDataBulkComposition
relationship is traversed to obtain objects that realize the IProcessDataBulkPhase interface.

Properties from all of these SmartPlant schema objects can be retrieved onto the SmartPlant
P&ID PipeRun object.
Select Criteria — In the Schema Editor, the Select Criteria option on the MapProperty is used
to indicate to the adapter how to handle each property for both publish and retrieve. The format
of the Select Criteria option is:
Select Criteria = <Retrieve Path>%<Publish Path>
 <Retrieve Path> — Indicates where the property comes from during retrieve. If this value is
empty, it means that the property comes from the primary object being retrieved
(IPipingSystemConnector). If a value exists, it means that this property comes from one of
the secondary objects that is related to the primary object by means of a relationship.
 <Publish Path> — This is a string that indicates where the property goes during publish. If
this value is empty, it means that the property is published to the primary object
(PIDPipingConnector). If this property is has a value (it should be equal to ProcessPoint), it
means that this property is published to the related PIDProcessPoint object.
PipeLine
In SmartPlant P&ID, graphical pipe runs indicate the schematic piping design. You can assign
naming properties to these pipe runs. All of the pipe runs with matching values for the naming
properties form a logical group. Such a group is sometimes called a pipeline and the values of
the naming properties represent the name of the pipeline. All of this is done without requiring
you to explicitly create a pipeline object.
In the SmartPlant schema there is an explicit PIDPipeLine class. Objects of this class must be
published with relationships to the associated PIDPipingConnectors. Some downstream
applications depend on the existence of the PIDPipeLine for their processing.
The SmartPlant P&ID adapter creates and deletes pipelines dynamically during the publish
operation. The pipelines and the relationships to the pipe runs are published as if they really
existed in the SmartPlant P&ID database. The tool schema contains a MapClass for PipeLine.
The MapProperties for the pipeline MapClass define the properties that are published to the
PIDPipeline object.
Special SmartPlant P&ID Mapping Procedures

The procedures in this section explain how to specify whether particular items or relationships
are to be included in or omitted from publish or retrieve actions.
 Publish with Instrument Expansion (on page 278)
 Retrieve Expanded Instruments (on page 281)
 Define Mapping Relationships as 'For Documentation Only' (on page 282)
 Publish the 'OwnsComponentOcc' Relation (on page 284)
 Suppress Generation of Tasks on Retrieve (on page 286)

Publish with Instrument Expansion

You can enable the expansion of a single published instrument from SmartPlant P&ID into a set
of instruments in SmartPlant Instrumentation (including the original instrument).
Instrument expansion is executed in SmartPlant Instrumentation in accordance with the

particular expansion type selected by the user in SmartPlant P&ID.
To enable data exchange with SmartPlant Foundation and other tools, the schema
version in use must include the following Interfaces:

1. In Data Dictionary Manager, add new entries in the Expansion Type select list, for example
as shown below.
The SP_ExpansionType property is mapped for the following classes:

 Instrument
 InstrumentCtrlSysFunc
 InstrumentInline
 InstrLoop
2. In Schema Editor, for each of these classes, do the following:
a. Right-click the SP_ExpansionType property and on the shortcut menu, click Edit
SP_ExpansionType.

b. Ensure that the following information is included.
3. In SmartPlant P&ID, select the instrument, control system, or loop that you want to expand,
and in the Properties window, select the desired value from the Expansion Type list.

Publishing should result in the following output:
Retrieve Expanded Instruments

When retrieving an instrument, any number of instruments that were generated by expansion
(from none to all of the expanded instruments) may also be retrieved. The actual number of
expanded instruments that are retrieved is determined by rules implemented in SmartPlant
Instrumentation.

To enable data exchange with SmartPlant Foundation and other tools, the schema
version in use must include the following Interfaces:
 The IExpandableThing.ExpansionType Interface holds the expansion rules list.

IExpandableThing is only realized for expanded instruments, but not for the original
instrument. The original instrument is always retrieved.
 The IRetrievableExpansion Interface determines whether the item is to be retrieved by
SmartPlant P&ID.
The following table summarizes how the realization of these interfaces determines whether or
not an instrument is retrieved.
IExpandableThing IRetrievableExpansion Result
Not realized Realized / Not realized Original instrument – always retrieved
Realized Not realized Expanded instrument is not retrieved
Realized Realized Expanded instrument is retrieved
Define Mapping Relationships as 'For Documentation Only'

MapPropertyToProperty or PropertyToMapProperty relationships that are set to 'for
documentation only' are included in tool schema mapping to show that mapping relationships
exist between the map property and the property definitions but that the support for these
mapping relationships is hard-coded (and is therefore only included in the mapping for
documentation purposes).
Set 'for documentation only' mapping relationships as follows:
1. In Schema Editor, open the Edit Map Class Definition dialog box.

2. Click the Publish or Retrieve tab.
The 'for documentation only' mapping relationships appear as dashed arrows

(instead of solid arrows which indicate standard mapping relationships).
3. To change the setting, select the desired rows from the bottom pane, and click an arrow in
the Map Type column.
4. On the dialog box that opens, toggle the For documentation only? value between True
and False as desired.
If you set a value to True, the application adapter ignores the mapping relationship
and uses hard-coded logic which should already be defined.

Publish the 'OwnsComponentOcc' Relation

OwnsComponentOcc is a relation between a pipe run and piping component that is used to
determine which pipe segment the piping component is related to. To include this relation when
publishing, the user must update the map file as described below.
1. Open the Tool schema in the Schema Editor.
2. Open the SPPIDDataMap.xml on the Tool Schema tab.
3. Under the SPMapRelDef node, right-click OwnsComponentOcc and on the shortcut menu,
click Edit OwnsComponentOcc.
4. On the Edit Map Relationship Definition dialog box, beside Maps to, click the ellipsis
button and from the list of EFSchema RelDef items, select OwnsComponentOcc.

5. Click OK to return to the Edit Map Relationship Definition dialog box with the mapping
assigned.
The next time you publish a document from SmartPlant P&ID, it will include this relationship.

Suppress Generation of Tasks on Retrieve

When retrieving documents in SmartPlant P&ID Engineering, it is possible to suppress the
generation of Update tasks for specified document types by adding code in the Select criteria
field for the appropriate MapClass object (SPMapClassDef).
To ensure the maintenance of data integrity in other tools, once you have made the
definitions in a particular MapClass object for suppressing the generation of tasks and you
subsequently publish drawings, do not change or remove those definitions during the course of
the integrated project.
1. Open the Tool schema in the Schema Editor.
2. Open the SPPIDDataMap.xml on the Tool Schema tab.
3. Expand the SPMapClassDef node.
4. Scroll down to the PipeRun map class and right-click the node.

5. On the shortcut menu, click Edit PipeRun.
6. On the Edit Map Class Definition dialog box, click the Advanced tab.

7. In the Select criteria field, enter the code for suppressing the generation of tasks for the
document types you specify.
A special DocType called "Deleted and Unclaimed Objects" may be published by

applications. This DocType contains published objects which were moved and then later
deleted – for example, all objects in the Instrument Index in SmartPlant Instrumentation
could be published once and then subsequently published with a filter applied. The
software now identifies those objects excluded by the filter as moved (unclaimed). If you
then delete any of those unclaimed objects and publish again, the objects will appear in the
"Deleted and Unclaimed Objects" DocType. To ensure that "Deleted and Unclaimed
Objects" are included when suppressing the generation of Delete tasks, you should include
in the Select criteria field "Deleted and Unclaimed Objects", with the understanding that this
document will be retrieved automatically from all applications when necessary.
Code Syntax
Use the following code syntax for suppressing task generation:
NoDeleteTasksForDocTypes=[DocType1;DocType2;...;DocTypeN]/NoCreateTa
sksForDocTypes=
[DocType1;DocType2;...;DocTypeN]/NoUpdateTasksForDocTypes=[DocType1;
DocType2;...;DocTypeN]
where the code elements are as follows:
 NoDeleteTasksForDocTypes — Suppresses generation of Delete tasks for the
specified document types.

 NoCreateTasksForDocTypes — Suppresses generation of Create tasks for the

 NoUpdateTasksForDocTypes — Suppresses generation of Update tasks for the
 For SmartPlant P&ID Engineering, it is not possible to run Create or Delete tasks.
 A forward slash (/) separates the commands for each task type (Delete, Create, Update).
 For each task type, the document type names or IDs are separated by a semicolon (;) as
shown:
In this example, EE82 is the ID for PFD documents, and EE84 is the ID for Instrument Index
documents.
 To find the name or ID of a document type, go to the retrieved document and use the
‘DocType’ property value of the IDocument interface.
Code Example
The following code is used to suppress generation of Create and Delete tasks for PFD and
Instrument Index documents (using document type names and IDs) including Delete tasks for
deleted and unclaimed objects:
NoCreateTasksForDocTypes=PFD;EE82;Instrument
Index;EE84/NoDeleteTasksForDocTypes=PFD;EE82;Instrument
Index;EE84;Deleted and Unclaimed Objects

SmartPlant P&ID Mapping Examples

The sections that follow provide mapping examples for SmartPlant P&ID. For more information
and mapping examples, see the SmartPlant Mapping User's Guide.
Examples Starting in SmartPlant P&ID

 SmartPlant P&ID Example: Mapping a New String Property Starting in the Tool (on page
290)
 SmartPlant P&ID Example: Mapping a New Complex Property Starting in the Tool (on page
297)
Examples Starting in the SmartPlant Schema

 SmartPlant P&ID Example: Mapping Equipment Classes to Publish Process Data (on page
307)
 SmartPlant P&ID Example: Mapping New Enumerated List Entries Starting in the
SmartPlant Schema (on page 314)
SmartPlant P&ID Example: Mapping a New String Property

Starting in the Tool
The following sections illustrate how to add and define mapping for a simple string property
called System Code for SmartPlant P&ID starting in Data Dictionary Manager. This property
does not have an enumerated list associated with it.
Before You Extend the SmartPlant P&ID Database

1. Make a backup of the SmartPlant Foundation site database and any vaults for the site.
2. Create a backup of SmartPlant P&ID, including a database backup from the plant level with
reference data, an application-level data dictionary template (DDT), and a backup of the
SPPIDDataMap.xml file located in the SmartPlant resources directory.
Create the New SystemCode Property in Data Dictionary Manager

1. Click Start > All Programs > Intergraph SmartPlant Engineering Manager > Data
Dictionary Manager.
2. Connect to the appropriate plant server for SmartPlant P&ID.

3. In the Database Tables list, select Plant Item.
4. On the toolbar, click Add Property .

5. In the Add Property dialog box, define information for the System Code property, and click
OK. Be sure to select String in the Data Type list.
6. Click File > Save to save your changes in Data Dictionary Manager.

7. Click File > Exit.
Launch Schema Editor and Load the SmartPlant P&ID Tool Map Schema
The ICustomInterface must be realized by the class definitions that represent objects in this
authoring tool that will be publishing or retrieving the custom property. If you have not configured
ICustomInterface, see the Schema Editor User's Guide for more information.
1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.
2. Right-click the CMF file, and then click Edit > Check Out.
3. Click OK in the Check Out dialog box.
4. In the New Items window, right-click the new version of the CMF file, and select Launch
Schema Editor.
5. On the Set Active Configurations dialog box, select the schema version that you want to
view.
6. Click OK to set the configuration.
 For more options, click Advanced on the Set Active Configuration dialog box.
 By default, changes to the SmartPlant Schema are written to all versions managed by
the CMF file. You can choose to write changes to only selected versions; however, that
is not recommended.
 If you choose to view one version of the schema (Specify configurations to display
window), but write changes to all versions (Set Configurations for new objects
window), an information window appears when you click OK, indicating that you will be
prompted with every change to the schema to confirm that you want to write the
changes to all versions. Click OK to continue.
The CMF file must be checked in to SmartPlant Foundation before users can publish
from an authoring tool.
7. In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and
select SMARTPLANTPID in the list of authoring tools to load the SmartPlant P&ID tool map
schema.

8. Under Startup options, select the Load map schema and Connect to application schema
check boxes, and click OK.
9. In each row in the Synchronize dialog box, the values in the tool database and tool map
schema columns indicate actions to correct inconsistencies between the tool metadata and
tool map schema. Select the appropriate action in each row, and then click OK.
 Each row represents a discrepancy between the tool database and the tool map
schema.
 Default actions are blue when the Synchronize dialog box appears. However, if you
select a different option, it will become blue instead.

 In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata
adapter can add the property to the tool map schema, but it cannot remove the property
from the tool database.
Because the SmartPlant P&ID tool map schema does not have a map class definition
called Plant Item, the new property that you added appears on several map class definitions
that inherit from Plant Item, such as equipment component and instrument loop.
Open the Instrument Loop Map Class Definition

Once the tool map schema is synchronized with the database, the Map Environment window
appears, providing tools for creating mapping relationships to be stored in the tool map schema
file.
1. In the Map Environment, expand SmartPlant P&ID > Loaded Map Schemas >
SmartPlant P&ID Tool Schema.
2. Expand the Map Classes node, and right-click InstrLoop.
3. On the shortcut menu, select Edit InstrLoop.
4. In the Edit Map Class Definition dialog box, select the Publish tab.
The Schema Editor creates a dynamic view definition that is used to display the
SmartPlant schema properties. Selecting the mapped class will show all of the property
definitions contained in the view definition.

Create the SystemCode Property in the SmartPlant Schema and Map

1. Click New Property Definition on the toolbar above the Unmapped SmartPlant
properties section on the right side of the dialog box.
2. In the New Property Definition dialog box, define the new SmartPlant schema
SystemCode property.
 In the Exposed by interface definitions dialog box, click Browse, and select
ICustomInterface as the interface definition that exposes this property.
 In the Scoped by property type box, select string.
3. Click OK.
4. Under Unmapped application properties, select SystemCode.
5. Under Unmapped SmartPlant properties, select SystemCode.

6. On the toolbar, click Map .
7. Click OK.
If the SystemCode property does not appear in the Unmapped SmartPlant properties
list after you created and exposed it on the ICustomInterface interface definition, check the
ICustomInterface definition to make sure that it is realized by the PIDInstrumentLoop class
definition and implied by the IInstrumentLoop interface.
The view definition that creates the list of unmapped properties is generated by the
software the first time you access the Edit form for a map class for each Schema Editor session.
So, if you view the list, leave it, and make changes, such as adding additional interfaces to the
class definition to which the map class is mapped, the changes you made will not appear when
you return to this form because the view definition is not updated or regenerated. You will see
the changes during your next Schema Editor session.
Map the SystemCode Property for Additional Map Class Definitions

Because multiple SmartPlant P&ID classes inherited the SystemCode property, you can create
additional mapping so that other objects can publish the property.
1. In the Map Environment tree view, right-click Instrument, and then select Edit Instrument
on the shortcut menu.
2. Select the Publish tab.
3. Under Unmapped application properties, select SystemCode.
4. Under Unmapped SmartPlant properties, select SystemCode.

6. Repeat steps 1-5 in this section to map the SystemCode property for any SmartPlant P&ID
map class definitions that represent objects for which you want to publish this property.
To create a retrieve mapping relationship for a property, follow the same steps on the
Retrieve tab.

Save the Tool Map Schema and SmartPlant Schema Changes

 Click File > Save All Modified Files to save the SmartPlant schema changes (CMF file)
and the tool map schema.
 When you close the Schema Editor, the software prompts you to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes
in the message box to save the session file so that you can use it to return to this working
environment. However, you should not open a session file after launching the CMF file from
the Desktop Client.
 If you save changes to the CMF file or a tool map schema but did not validate the changes
before exiting, the software displays an information message to remind you that the file
contains changes that have not been validated. Click OK to dismiss the message.
 If you make changes to the SmartPlant schema, you must load the changes into the
SmartPlant Foundation database. For more information, see the SmartPlant Schema Editor
User's Guide.
 Additionally, if you made changes to the SmartPlant schema, you should regenerate the
component schemas for the site before testing any publish or retrieve mapping relationships.
For more information, see the SmartPlant Schema Editor User's Guide.
SmartPlant P&ID Example: Mapping a New Complex

Property Starting in the Tool
The following sections illustrate how to add and define mapping for a new complex property
called Engineering System and its enumerated list entries starting in Data Dictionary Manager.

Create the New Engineering System Property in Data Dictionary Manager

Dictionary Manager.
3. Click Select List on the left side of the Data Dictionary Manager window.
4. In the first empty row in the Select List table, type EngSys as the name.
5. Select None from the Dependent List.
6. Click Select Entry on the left side of the Data Dictionary Manager window.
7. Under Selected List, select EngSys.

8. In the first empty row, create a new entry with a value of AA and a short value of Steam
Gen & Fired Htr, Water/Steam Side.
9. Click Add Row, and enter the following values, creating a new row for each:
Value Short Value
BA Steam Generator and Fired Heater, Air/Gas Side
CA Ammonia/Urea
DC Crude Oil Production
EA Auxiliary AC Power Systems
10. Click Database Tables on the left of the dialog box, and select Plant Item from the list in
the middle.

11. Click Edit > Add Property .

12. In the Add Property dialog box, create a new property with the following information:
Property Value
Name EngSystem
Display Name Engineering System
Data Type Select List
Select List EngSys
Default Value None
Category Process

13. Click OK.

15. Click File > Exit.
Launch Schema Editor and Synchronize the Tool Map Schema

The ICustomInterface must be realized by the class definitions that represent objects in this
authoring tool that will be publishing or retrieving the custom property. If you have not configured
ICustomInterface, see the Schema Editor User's Guide for more information.
Schema Editor.

view.
is not recommended.
In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and
schema.
schema.

Add the New Enumerated List to the SmartPlant Schema and Map
2. Expand Map Enumerated Lists, and right-click EngSys.
3. On the shortcut menu, select Edit EngSys.
4. In the Edit Map Enumerated List Definition dialog box, select the Advanced tab.
5. At the bottom of the dialog box, click New SmartPlant Enumerated List with Correlated
Entries.
This process creates an enumerated list in the SmartPlant schema with the same
name and values as the list in the tool map schema. Additionally, the software will

automatically map all the enumerations for publish. A dialog box will suggest that you can
map the enumeration for retrieve as well. Click Yes to create both publish and retrieve
mapping relationships, or No to create only publish mapping relationships.
6. Click OK in the Create Enumerated List and Entries dialog box.
Depending on your selections on the Set Active Configurations dialog box when you
launched the Schema Editor, you may be prompted to confirm that you want to create the
new list and enumerations in multiple versions of the schema.
7. In the Edit Map Enumerated List Definition dialog box, click OK.
8. In the Map Enumerated Lists node, right-click EngSys.
9. On the shortcut menu, select Edit EngSys.
10. In the Edit Map Enumerated List Definition dialog box, select the Publish tab.
11. Under SmartPlant in the upper right window, right-click EngSys.
12. On the shortcut menu, select Edit <UID>.
13. Click each entry, and under Overview, edit the number to match the values in the following
table:
Name/Short Description Number
AA 10111
BA 10112
CA 10113
DC 10114
EA 10115

14. Click OK.

The modification of the Number value of each enumeration is required for Smart 3D,
which will determine the actual value assigned to each enumeration. No other authoring tools
use this value.
Add the New Property to the SmartPlant Schema

1. In the Map Classes node, right-click InstrLoop.
2. On the shortcut menu, select Edit InstrLoop.
4. Above Unmapped SmartPlant properties on the right side of the dialog box, click New
Property Definition on the toolbar.

5. In the New Property Definition dialog box, define the new SmartPlant schema
EngineeringSys property.
 In the Exposed by interface definitions box, click Browse, and select

ICustomInterface as the interface definition that exposes this property.
 In the Scoped by property type box, select EngSys.
6. Click OK.
7. Under Unmapped application properties, select EngSystem.
8. Under Unmapped SmartPlant properties, select EngineeringSys.

If the EngineeringSys property does not appear in the Unmapped SmartPlant
properties list after you created it and exposed it on the ICustomInterface interface definition,
check the ICustomInterface definition to make sure that it is realized by the PIDInstrumentLoop
class definition and implied by the IInstrumentLoop interface.
The view definition that creates the list of unmapped properties is generated by the
software the first time you access the Edit form for a map class for each Schema Editor session.
So, if you view the list, leave it, and make changes, such as adding additional interfaces to the
class definition to which the map class is mapped, the changes you made will not appear when
you return to this form because the view definition is not updated or regenerated. You will see
the changes during your next Schema Editor session.

Map the EngSys Property for Additional Map Class Definitions

Because multiple SmartPlant P&ID classes inherited the EngSystem property, you can create
additional mapping so that other objects can publish the property.
1. In the tree view, right-click Instrument, and then select Edit Instrument on the shortcut
menu.
3. Under Unmapped application properties, select EngSystem.
4. Under Unmapped SmartPlant properties, select EngineeringSys.

6. Repeat steps 1-5 in this section to map the EngSys property for all SmartPlant P&ID map
class definitions that represent objects for which you want to publish this property.
To create a retrieve mapping relationship for a property, follow the same steps on the
Retrieve tab.

the Desktop Client.
User's Guide.

SmartPlant P&ID Example: Mapping Equipment Classes to

Publish Process Data
The following mapping example describes how to map process data for the four Equipment
classes – Equipment Other, Exchanger, Mechanical, and Vessel. The following example
explains how to map process data for the Vessel class; however, a similar procedure applies to
all the Equipment classes listed above.
The following must exist in the PIDComponent schema:
 IProcessPoint and IProcessDataCaseComposition are realized by PIDProcessVessel,
PIDMechanicalEquipment, PIDProcessEquipment, and PIDHeatTransferEquipment.
 IProcessDataCaseComposition is implied by IPIDMechanicalEquipmentOcc,
IPIDProcessVesselOcc, IPIDHeatTransferEquipmentOcc, and IEquipmentOcc.
 PIDProcessVessel, PIDMechanicalEquipment, PIDProcessEquipment, and
PIDHeatTransferEquipment must realize the interface that exposes the SmartPlant property
definitions to which you want to map. For example, in this topic, you will map
ProcessOperatingMaxTemperature to PhaseTemperatureMax, which is exposed by
IBulkMaxProcessPoint. To map a ProcessOperatingMaxTemperature property to
PhaseTemperatureMin, the class definition should realize IBulkMinProcessPoint.

Launch the Schema Editor and Load the SmartPlant P&ID Tool Map Schema
2. Right-click the CMF file, and select Launch Schema Editor.
3. On the Set Active Configuration dialog box, select the version of the schema that you
want to view.
4. Click OK to set the configuration, and open the Schema Editor.
schema.
schema.

Create and Map the MapProperty

2. Expand the Vessel node, and right-click MapProperties.
3. Select Create SPMapPropertyDef to create a new tool property and associate it to the
Vessel class.
4. Define the property, for example, ProcessOperatingMaxPressure, in the Edit Map Property
Definition dialog box.

5. Type %ProcessPoint in the Select criteria field, and then click OK.
6. Right-click the Vessel node, and select Edit Vessel.

7. On the Advanced tab, edit the value in the Process criteria box to
EFAdapter.EqDataExchanger,True,1.
The Process criteria box is automatically filled with the value set to False. By setting
the Process criteria value to True, the SmartPlant P&ID adapter finds the extended
properties that contain the process properties for equipment.
8. Click the Publish tab.

9. In the Unmapped application properties table, select the

ProcessOperatingMaxTemperature property you created.
10. In the Unmapped SmartPlant properties table, select the PhaseTemperatureMax
property.
 The mapping you defined appears in the mapped objects table at the bottom of the
dialog box.
 The ProcessOperatingMinTemperature map property can be mapped to
PhaseTemperatureMin using the same process.
12. Click OK.
Save the Tool Map Schema

Click File > Save All Modified Files to save the changes to the tool map schema.
Because you did not change the SmartPlant schema, you do not need to save the CMF
file.
When you close the Schema Editor, the software offers to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes in
the message box to save the session files so that you can use it to return to this working
environment. However, you should not open a session file after launching the CMF file from the
Desktop Client.

Test the Publish Mapping Relationship

 Test your mapping by publishing equipment with process data related to it.
Below is an example of how the published data should appear.
SmartPlant P&ID Example: Define Mapping to Publish

Variable Frequency Drives
The following mapping example describes how to define mapping to publish variable frequency
drive data from SmartPlant P&ID by mapping a new enumeration in the tool map schema.
Define the Enumeration in the SmartPlant P&ID Tool Map Schema

Schema Editor.

view.
is not recommended.
schema.
schema.
9. In many cases, only one operation is supported to synchronize the database and map
schema. For example, if a new property was found in the database, the metadata adapter

can add the property to the tool map schema, but it cannot remove the property from the
tool database.
10. In the Map Environment, expand SmartPlant P&ID > Loaded Map Schemas > SmartPlant
P&ID Tool Schema.
11. Expand the Map Enumerated Lists node, and double-click EquipmentType.
13. In the tool map schema view on the left side of the Publish tab, right-click any node, then
select Create New SPMapEnumDef.
14. Type Variable Frequency Drive in the Name box and provide a description.
15. Click OK.
16. The new list appears in the Unmapped application enumerations table.
17. In the Unmapped application enumerations table, select Variable Frequency Drive.
18. In the Unmapped SmartPlant enumerations table, select Variable-frequency Drive.
19. Click Map .

20. Click OK.

the Desktop Client.
User's Guide.

SmartPlant P&ID Example: Mapping New Enumerated List

Entries Starting in the SmartPlant Schema
The following topic provides an example of adding and defining mapping for a new enumerated
list called Corrosive and its entries to the hierarchical Fluid System enumerated list starting in
the SmartPlant schema.

Launch Schema Editor and Load the SmartPlant P&ID Tool Map Schema
Schema Editor.
view.
is not recommended.

schema.
schema.
Verify that the Corrosive Enumerated List Does Not Already Exist in the Schema
1. In the Map Environment window, select the Schema tab.
2. Find the Fluid system enumerated list in the tree view.

3. Right-click the Fluid system node, and then click View FluidSystems.
4. In the Edit Enumerated List dialog box, review the existing list entries.
Note that Corrosive does not exist in the Fluid system list.

5. Next, check to be sure that there are not any fluid code entries with the same meaning as
the one you want to add.
Add the New Corrosive List to the SmartPlant Schema

1. In the Map Environment, return to the Tool tab.
2. Expand SmartPlant P&ID > Loaded Map Schemas > SmartPlant P&ID Tool Schema.
3. Expand the Map Enumerated Lists node, and double-click Fluid System.

5. In the SmartPlant schema tree view on the right side of the Publish tab, right-click any entry
under the Fluid system node, and then click Create New EnumListType on the shortcut
menu.
6. In the New Enumerated List dialog box, type Corrosive as the short description of the new
list, Corrosive Fluid System as the long description, and 10100 as the number.
7. Click New Child Entry, and create a fluid code of KA with a description of (KA) Ammonia,
Anhydrous.
8. Repeat step 7 for each fluid code in the following list, and click OK.

Fluid Code (Short Description) Long Description
KA (KA) Ammonia, Anhydrous
KC (KC) Caustic
KP (KP) Process Chemical
KW (KW) Ammonia, Aqueous
Add the New Corrosive List to the SmartPlant P&ID Tool Map Schema and Map
1. In the authoring tool map schema tree view on the left side of the Publish tab, right-click
any entry under the Fluid system node, and then click Create New SPMapEnumDef.

2. In the New SPMapEnumDef dialog box, type Corrosive in the Name field.
3. Type Corrosive Fluid System in the Description box, and then click OK.
4. The new list appears in the Unmapped application enumerations table.
5. In the Unmapped application enumerations list, select Corrosive.

6. In the Unmapped SmartPlant enumerations list, select Corrosive.
7. Click Map .
8. Click OK.
Add Entries to the Fluid Code List and Map

1. In the Map Environment, double-click Fluid Code under the Map Enumerated Lists node.
2. On the Edit Map Enumerated List Definition dialog box, click the Publish tab.
3. Above Unmapped SmartPlant enumerations on the right side of the dialog box, click New
Application Enumeration on the toolbar.

4. In the New SPMapEnumDef dialog box, create a fluid code of KA with a description of (KA)
Ammonia, Anhydrous.
5. Repeat steps 3 and 4 for each fluid code in the following list:
Fluid Code (Short Description) Long Description
KA (KA) Ammonia, Anhydrous
KC (KC) Caustic
KP (KP) Process Chemical
KW (KW) Ammonia, Aqueous
6. Click the Advanced tab.

7. Under Map enumerated list definition, browse to fluid code KA.

8. In the Constrained by box, click Browse, and select Corrosive as the dependent fluid
code enum entry. This value is saved in the tool map schema and ensures that the
Corrosive fluid system enum entry is defined as the Dependent value of the selected fluid
code in the Data Dictionary.
9. Repeat step 8 for each of the fluid code enum entries KC, KP, and KW.
11. In the Unmapped application enumerations table, select a fluid code that you defined.
12. In the Unmapped SmartPlant enumerations table, select the corresponding fluid code
from the SmartPlant schema.
13. Click Map .

14. Repeat steps 5-7 for each enumerated entry in the Fluid Code list.

the Desktop Client.
User's Guide.
Review New Corrosive List in Data Dictionary Manager

Dictionary Manager.
3. Click Select Entry.
4. In the Selected list box, select Fluid System, and review the new Corrosive entry in the
table.
5. In the Selected list box, click Fluid Code, and in the Dependent Value column for each of
the new fluid codes, select Corrosive as the fluid system value.

6. Review the entries that you added in the table.
Pre-Publishing Automation from SmartPlant P&ID

You can create an external plug-in that enables the .xml file generated when publishing from
SmartPlant P&ID to be modified automatically before it is handed over to SmartPlant
Foundation.
This capability requires SmartPlant Client v05 (2014) or later.
Create the Plug-in

1. Register the EFCustomProcess.tlb using the RegTLib command.
2. In the Windows Registry Editor, do one of the following:
 On a 64-bit machine, navigate to the key:
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Intergraph\SPF Framework
Client\Current Version].
 On a 32-bit machine, navigate to the key:
[HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\SPF Framework Client\Current
Version].
3. Add a new string value with the name: CustomPublishDLLProgID.

4. Set the value data to the <ProgID> of the CustomPublishDLL.
5. Write the custom plug-in .dll as follows:

a. Add the following required references to the software:
 EFCustomProcess.tlb
 SchemaComponent.tlb (C:\Program Files (x86)\Common Files\Intergraph\Schema
Component\SchemaComponent.tlb)
 CompSchemaCont.dll ( C:\Program Files (x86)\Common Files\Intergraph\Schema
Component\CompSchemaCont.dll)
b. Create a dll that implements all the properties and methods declared in
IEFCustomPublish interface, which is provided in EFCustomProcess.tlb.
EFCustomProcess Reference
IEFCustomPublish Interface
The methods and properties on this interface must be implemented to do any additional
processing of data before transmitting the data to SmartPlant Foundation during the publish
process. With this interface, you can process extra data that is not compatible with the tool
adapters.
Software (IEFCustomPublish Interface)

EFCustomProcess.tlb, delivered with SmartPlant Client 2014.

Properties (IEFCustomPublish Interface)

The following properties are declared in IEFCustomPublish Interface:
 MessageIContainer
 ToolParameters
MessageIContainer
Description
This is a container property to store any error or warning messages during the processing.
These message are logged during the publish process. This property is part of
IEFCustomPublish and is controlled by SmartPlant Client. The software implementation for the
IEFCusomtPublish interface adds messages to this container when required while processing
data to be published. These messages are logged to the same logging system as the rest of the
publishing process.
Data Type
IContainer
ToolParameters
Description
This is a collection of tool parameters and is the same object that the design tool passes through
the Connect call with CommonUI. IEFToolParameters is a collection of IEFToolParameter.
IEFParameter is a data class with sName (string) and vValue (variant) properties.
Data Type
IEFToolParameters
Methods (IEFCustomPublish Interface)
SetEventHandlerObj
Description
This method must be implemented to use the IEFCustomPublishEventHandler member object in
IEFCustomPublish. StepProgressBegin() and StepProgressEnd() must be called on this object
to update the publish progress bar with steps. SmartPlant Client implements the
IEFCustomPublishEventHandler interface, and SmartPlant Client acts as the oEventHandler
parameter for this method in SmartPlant Client.
Arguments
Name Data Type Input / Output Description
oEventHandler IEFCustomPublish Input This is an object used to update the publish

EventHandler progress bar.

ListOfProgressSteps
Description
This method is called by SmartPlant Client to retrieve all additional steps to be displayed in the
publish progress bar while processing the data. In the implementation of this method, add the
required additional steps that need to be displayed in the progress bar while processing the
data. These steps are displayed during the publish process along with the rest of the publish
process steps with status icons. The StepNames array must be filled with individual steps to be
displayed during the publish process.
Arguments
StepNames StringArray Input / Output Contains a list of additional progress steps to

be displayed in the publish progress bar.
ProcessPublishData
Description
This method is called by SmartPlant Client and needs to be implemented to modify, add, or
remove information from the data to be published before transmitting to SmartPlant Foundation.
This implementation can also validate the published data and raise messages during the publish
process. It can also update the publish progress bar with the status of each step.
By implementing this method, you can achieve the following:
 Modify or add information to the published data that cannot be handled by the tool adapters.
 Filter and limit information from the data being published.
 Calculate additional information based on the publishing application data, such as finding
the beginning P&ID number for a pipeline.
 Manipulate data to represent special business rules.
 Validate data and raise an "invalid" state to EFClient to stop the publish process.
 To log messages, make sure MessageIContainer is set, and add the messages to
MessageIContainer. The messages are saved to a log file.
 To display progress steps in the publish progress bar, implement ListOfProgressSteps(). For
each step, call StepProgressBegin(stepName) before and StepProgressEnd(stepName)
after. Use the member variable of type IEFCustomPublishEventHandler with
SetEventHandlerObj().
For a sample implementation, see Sample Implementation (IEFCustomPublish) (on page 330).
Arguments
oDocumentIObject IObject Input IObject interface on the document object.

oDocIContainer IContainer Input / Output Document container.
oDocMetalContainer IContainer Input / Output Document meta-data container.
oMapSchContlContainer IContainer Input Optional. Maps the schema container.
IEFCustomPublishEventHandler Interface
SmartPlant Client implements this interface to handle progress bar updates that are received
from the implementation of IEFCustomPublish. The software that implements IEFCustomPublish
declares an object of IEFCustomPublishEventHandler. This object is set in SmartPlant Client by
passing itself as the parameter to SetEventHandlerObj() and update the publish progress bar
with the required steps. The software implementation of IEFCustomPublish must call
StepProgressBegin() and StepProgressEnd() when required to update the publish progress bar.
Software (IEFCustomPublishEventHandler Interface)

EFCustomProcess.tlb, delivered with SmartPlant Client 2014.
Methods (IEFCustomPublishEventHandler Interface)
StepProgressBegin
Description
This method is implemented in SmartPlant Client and raises the progress status of current
progressing steps to the publish progress bar. The software that implements the
IEFCustomPublish interface must call this method before each step.
Arguments
sCurrentStep String Input / Output Contains a description of the current progress

step.
StepProgressEnd
Description
This method raises the progress information of the current progressing step to the publish
progress bar. The software that implements IEFCustomPublish must call this method after each
completed step. The steps must be filled with the string array StepNames by implementing the
ListStepNames method of the IEFCustomPublish interface.
Arguments

sCurrentStep String Input / Output Contains a description of the current progress

step.
Implementation (IEFCustomPublish)
Sample Implementation (IEFCustomPublish)
Option Explicit
Implements EFCustomProcess.IEFCustomPublish
Dim ObjEFSrvMgrLocal As IEFCustomPublishEventHandler
Private m_oMessageIContainer As IContainer
Private m_oToolParms As IEFToolParameters
Private Const TCD_L_ERROR_NUMBER_BASE As Long = vbObjectError + 5023&

Private Const TCD_L_ERROR_GENERAL As Long = TCD_L_ERROR_NUMBER_BASE + 1
Private Const S_THIS_FILE As String = "CustomPublish"
Public Property Set IEFCustomPublish_MessageIContainer(ByVal RHS As

IContainer)
Set m_oMessageIContainer = RHS
End Property
Public Property Set IEFCustomPublish_ToolParameters(ByVal RHS As

IEFToolParameters)
Set m_oToolParms = RHS
End Property
Public Sub IEFCustomPublish_SetEventHandlerObj(ByVal lobjEventHandler As

IEFCustomPublishEventHandler)
Set ObjEFSrvMgrLocal = lobjEventHandler
End Sub
Public Sub IEFCustomPublish_ListOfProgressSteps(ByRef

parrListOfProgressSteps() As String)
ReDim parrListOfProgressSteps(0) As String

parrListOfProgressSteps(0) = "Updating Pump(P-008)..."
End Sub
Public Sub IEFCustomPublish_ProcessPublishData(ByRef pDocObject As

IObject, _
ByRef pDocContainer As
IContainer, _
ByRef pMetaContainer As
IContainer, _
Optional ByRef
pToolMapContainer As IContainer)

On Error GoTo llblErrorHandler

ObjEFSrvMgrLocal.StepProgressBegin ("Adding new Pump(P-008)...")
Call AddNewObject(pDocObject, pDocContainer, pMetaContainer,
pToolMapContainer)
ObjEFSrvMgrLocal.StepProgressEnd ("Adding new object (Vessel)...")
GoTo llblExitProcedure
llblErrorHandler:
Call
ECU_HandleErrorProcessPublishDta("IEFCustomPublish_ProcessPublishData",
m_oMessageIContainer, Err.Source, Err.Description, Err.Number)
llblExitProcedure:
End Sub
Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
Aspen Basic Engineering or SmartPlant Instrumentation, you must register each plant in
SmartPlant P&ID with a SmartPlant Foundation database. The connection allows SmartPlant
P&ID to display the SmartPlant integration commands. A SmartPlant Engineering Manager
administrator typically registers plants.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The system administrator must register each plant in the authoring tool once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.
Accessing the SmartPlant Foundation Web Client

The SmartPlant Foundation Web Client provides a web-based user interface that allows you to
interact with SmartPlant Foundation. From this interface you can perform a number of tasks,
such as browse data and documents that have been published, use the SmartPlant Foundation
To Do List to complete workflow tasks, compare document revisions and published documents
with tool data, and subscribe to documents to receive notification of document changes.

Access the SmartPlant Foundation Web Client

 In the authoring tool, click SmartPlant > Browser.
 This command is available only if you have registered the active plant using the SmartPlant
Registration Wizard. For more information, see SmartPlant Engineering Manager Online
Help.
 From the SmartPlant Foundation Web Client, you can perform a number of tasks, such as
publishing or retrieving documents, comparing documents, subscribing to document
changes, and so forth. Many of these tasks can be performed from the authoring tools,
such as SmartPlant P&ID or SmartPlant Electrical, but the Web Client provides unique
access to other features such as the Web Client To Do List and search capabilities.
Browser Command (SmartPlant Menu)

Opens the SmartPlant Foundation Web Client, from which you can perform a number of tasks,
such as browsing for documents that have been published, using the SmartPlant Foundation To
Do List to complete tasks, comparing documents in the SmartPlant Foundation database with
the data in your authoring tool, and subscribing to documents in order to receive notification of
changes to the documents.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard.
Publishing Documents
In an integrated SmartPlant environment, 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 specified in SmartPlant Foundation. For
most documents, the associated data is included in the publishing process.
The authoring tools publish data in XML format. The software then places the .XML file in the
appropriate SmartPlant Foundation vault and loads the data from the .XML files to the
SmartPlant Foundation database. 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 does the following things:
 Creates a new master document and the first revision in SmartPlant Foundation the first
time you publish 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 applications, this is an Intergraph proprietary file, called a RAD file. The
viewable file can also be an Excel spreadsheet or another viewable file type, such as .pdf or

.doc. You can review and mark up the visual representation of the document, which is
attached to the document revision, using SmartPlant Markup.
 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 tools retrieve latest data. The software publishes only meaningful engineering data. The
published data is not enough to re-create the document in the originating tool.
 The software publishes some document types without the associated data, such as reports
from authoring tools (for example, line lists in SmartPlant P&ID). Users 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.
For more information about revisions and versions, see the SmartPlant Foundation Web Client
User's Guide or the SmartPlant Foundation Desktop Client User's Guide.
Reasons to Publish
You can publish documents and associated data for several reasons:
 To exchange and enhance data among tools, to avoid creating data multiple times in
multiple authoring tools
 To report on common data originating in multiple tools
 To provide enterprise-wide accessibility to published documents
 To 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 in loaded into SmartPlant Foundation 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 Manager loads the document into
SmartPlant Foundation as soon as it reaches the top of the Loader queue.
Publishing Documents
 Each authoring tool publishes different documents and data.
The PBS document contains information about the physical plant with a structure consisting of
plants, areas, and units. The default structure is plant/area/unit, but you can define a custom
hierarchy in 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 project breakdown structure, project definition document, and project list contain information
about projects and their statuses. When these documents are published from SmartPlant
Foundation, the authoring tools are notified of projects and contracts that need to be created in
the authoring tools.

The project breakdown structure contains a single project and the hierarchy of contracts under
that project in a plant/project structure. The project definition document contains information for
a single project that needs to be created in the authoring tool. The project list contains a list of all
projects in a plant, and it is used by those authoring tools that create all projects at one time.
 The plant breakdown structure and project breakdown structure used in the authoring tools
must match the structure in SmartPlant Foundation for publishing from the authoring tools
and object correlation to work correctly.
 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.
 When publishing from a project, an instruction container, which contains all the claimed
objects, is created within the tombstone file.
Publishing from SmartPlant P&ID - Work Process
* This step applies to a plant that is configured to use SmartPlant Foundation revisions. If your
plant is configured to use SmartPlant P&ID revisions, a new revision is added in the SmartPlant
P&ID Revise dialog box.
For details of the revision procedure, see SmartPlant P&ID Drawing Manager Help.
What do you want to do?

 Find Documents to Publish
 Publish Documents from SmartPlant P&ID (on page 335)

Publish Documents from SmartPlant P&ID

Before you can publish a document for the first time, at least one revision of that
document must exist. The software finds only those documents that have revisions. If a
document has several revisions, the software finds the most recent revision of that document.
1. Click SmartPlant > Publish.
 This command is available only if you have registered the active plant using the
 If you logged on to 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.
 A plug-in can be created that will allow user intervention to modify, add, or remove
information from data to be published before it gets transmitted to SmartPlant
Foundation. For details, see Pre-Publishing Automation from SmartPlant P&ID (on
page 325).
2. Add any additional documents to the Selected documents list by clicking one of the
following toolbar buttons:
 Engineering Tool — Opens the Publish from Engineering Tool dialog box for
selecting documents.
 File System — Opens a standard Microsoft dialog box that allows you to select
files. When you select a file with this Select File dialog box, the Document Properties
dialog box appears, allowing you to specify information about the file, such as whether it
is a new file; the category, type, and subtype of the document; and the name,
description, and title of the document.
 Find — Opens the Find Documents to Publish dialog box, which allows you to
search for documents. These are documents that have at least one revision and that
were not published after creation of the last revision. For more information, see Find
Documents to Publish Dialog Box (on page 345).
The documents that appear in the Selected documents list in the Publish dialog
box when it first appears are publishable documents that were selected within the authoring
tool before you clicked the Publish command.
3. Edit properties as required for the selected documents.
 When multiple documents are selected, only property values shared by all the selected
documents appear in the grid. Changing a value in the grid changes that value for all the
selected documents.
 To remove an entry (or node) from the Selected documents list, select the node in the
tree, and then click the Delete toolbar button.
4. From the Operations list, choose a publish method.
 Select Publish to immediately start the publishing process as soon as you click OK.

 Select Background publish to publish the selected documents immediately as a

separate process, allowing you to perform other tasks at the same time. 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.
 During publishing, an information dialog box appears with a progress bar. Click Show
Details to view details of the operation showing steps completed successfully, the current
step that is running, and steps yet to run. You can click Hide Details to hide this section of
the dialog box. If the View Log button on the dialog box is enabled, messages are available
concerning the operation. These messages may include errors or warnings or even
informational messages. Click View Log to see these messages.
 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.
Publish a Report
2. Click File System in the Publish dialog box.

3. Select the Excel spreadsheet or Word document that you generated from the Reports or
View menu, and click OK.
For more information about generating reports, see Generating Reports (on page
223).
4. Provide information as necessary in the Document Properties dialog box, and click OK.
5. Select a Revision Scheme and Workflow, and click OK to publish to SmartPlant
Foundation.
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.
(by name) to an object with the
same shared object definition,  When a publishing tool
SmartPlant Foundation does not retrieve.
automatically correlates the objects.
If the object can correlate to more  When using SmartPlant


than one object through multiple Foundation to perform
shared object definitions, a task is consistency checking and
placed in the To Do list to allow the the authoring applications
user to select the correlation. do not retrieve.
 When Shared Objects To
Correlate option is used to
configure which types of
objects are auto-correlated.
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 multiple 3D models
Foundation, then merges these as one composite 3D model
object sets into a new composite document in one 3D view.
document that represents the entire
3D model.
Correlate Places published objects with Correlate works similar to

possible correlations in the To Do Auto-Correlate except you can
list. From the To Do list, the user view the possible correlations
manually correlates selected items. before the actual correlation
SmartPlant Foundation creates a takes place.
shared object.
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.

PublishForLoadOnly Generates a document load task Use PublishForLoadOnly when

and consolidate task for the you want to publish documents
publishing document and makes to view, navigate and also for
the documents irretrievable by any consistency checking in
tool. These tasks are performed by SmartPlant Foundation without
the SmartPlant Foundation the possibility of the document
Scheduler. being retrieved by any tool.
Issue Request Documents from SmartPlant P&ID

Before you can publish a document for the first time, at least one revision of that
document must exist. The software finds only those documents that have revisions. If a
document has several revisions, the software finds the most recent revision of that document.
2. In the Publish dialog box, click the Issue Request tab.
3. In the Issue to box, select the contract to which you want to assign the document or
documents.
4. Under Selected documents, select the documents you want to associate with the specified
contract.
5. Add any additional documents to the Selected documents list by clicking one of the
following toolbar buttons:
 Engineering Tool — Opens the Publish from Engineering Tool dialog box for
selecting documents.
 File System — Opens a standard Microsoft dialog box that allows you to select
files. When you select a file with this Select File dialog box, the Document Properties
dialog box appears, allowing you to specify information about the file, such as whether it
is a new file; the category, type, and subtype of the document; and the name,
description, and title of the document.
 Find — Opens the Find Documents to Publish dialog box, which allows you to
search for documents. These are documents that have at least one revision and that
were not published after creation of the last revision. For more information, see Find
Documents to Publish Dialog Box (on page 345).
The documents that appear in the Selected documents list in the Publish dialog
box when it first appears are publishable documents that were selected within the authoring

tool before you clicked the Publish command. To remove documents from the list, select
them and then click the Delete toolbar button.
6. Click OK to issue the contract request for the selected documents to the integrated
environment.
7. Start SmartPlant Foundation Desktop Client on your computer and search for the published
document to verify the publishing process.
8. Right-click the document in the Desktop Client tree view and on the shortcut menu, click
Refresh.
9. Update the document. For more information, see the SmartPlant Foundation Desktop Client
User's Guide.
10. Review the issue properties by right-clicking the document and on the shortcut menu,
clicking Properties, and then clicking the Issue Request tab to see the issue information.
You can also open the document to see the issue information in the title block.
11. Publish the document with the updated issue information.

 Find Documents to Publish
 Publish Documents from SmartPlant P&ID (on page 335)
Publish Command (SmartPlant Menu)

Opens the Publish dialog box to allow you to send the information of the selected documents
for retrieval by other tools.
Publish Dialog Box

Provides a list of documents selected to publish. Information on this dialog box is divided into
the following two tabs:
 Publish Tab (Publish Dialog Box)
 Issue Request Tab (Publish Dialog Box)
The following options are available regardless of which tab is displayed.
Selected documents — Displays a list of the documents selected for publishing. You must
populate this list by selecting documents before you use the Publish command or by clicking
the buttons in the Add section of this dialog box. For each document, this list displays the name,
the type of document, the workflow from which the document was last published, the revision
and version numbers, the revision scheme, and the date when the document was last published.
Engineering Tool — Displays a tool-specific dialog box that allows you to add documents
from authoring tools, such as P&IDs or PFDs, to the Selected documents list.

File System — Opens the standard Select File dialog box that allows you to select
documents, such as Microsoft Word documents or Microsoft Excel workbooks, to add to the
Selected documents list. When you select a file using this dialog box, the Document
Properties dialog box opens, allowing you to specify information about the file, such as whether
it is a new file or was previously published; the category, type, and subtype of the document;
and the name, description, and title of the document.
Find — Opens the Find Documents to Publish dialog box, which allows you to search for
documents to add to the Selected documents list.

Publish Tab (Publish Dialog Box)

Displays properties of the selected document or documents. If only one document is selected in
the tree view, the properties displayed on this tab are the properties of that one document. If
multiple documents are selected, only the properties with the same value for all documents are
displayed. Any properties with varying values across the documents appear as blank values in
these fields.
You can change some of the values assigned to one or more documents by changing the values
displayed in the table. The values you enter here will override any existing values for all selected
documents.
Last Published - Indicates the date on which the document or documents were last published.
Name - Displays the name of the document.
Source - Indicates the authoring tool in which the document was created.
Type - Displays the type of document or documents selected.
Comment - Allows you to enter information about the selected publishable documents.
Issue Only - Allows you to issue request documents without, necessarily, republishing them.
Use this option when no changes were made to a document, but you want to add the document
to a transmittal.
 Even with the Issue Only option set, documents may still be published. Any documents that
have never been published must be published, regardless of this setting.
 You will receive an error message if you select multiple documents and activate this option
when one or more of the selected documents cannot be changed. For example, if a selected
set of documents includes new documents (for which this field can be set only to No) and
current or locked documents (for which this field can be set only to Yes), the error message
prompts you to select a smaller set of documents.
Owning Group - Select an owning group from the drop down list to which the document
belongs.
 By default, the owning group selected for the previous version, if any, is shown.
 All the owning groups configured in SmartPlant Foundation are listed.
Revision - Displays the current revision number of the selected document or documents.
You will receive an error message if you attempt to change the value in this box when you
have selected one or more documents that have conflicting revision schemes or different
possible revisions. The error message prompts you to select a smaller set of documents.
Revision Scheme - Displays the revision scheme applied to the selected document or
documents.
Only revision schemes that are applicable to the configuration (plant) or classification
(document type) are available in the shortcut menu. The revision schemes related to a
configuration or classification are not available for any other configurations or classifications. If
none of the revision schemes are related to the configuration or classification, then all revision
schemes are available unless they are related to any other configuration or classification. For

more information on revision scheme configuration, see Configuring Different Revision Scheme
Strategies in the How to Configure Document Management guide.
You will receive an error message indicating that this field cannot be edited if one or more
of the documents you have selected are not new or will have a revision scheme supplied by the
authoring tool. The error message prompts you to select a smaller set of documents.
Version — Indicates the current version of the document or documents.
Workflow — Indicates to which workflow the selected document or documents were assigned.
You will receive an error message indicating that this field cannot be edited if one or more
of the documents you have selected have conflicting sets of possible workflows. The error
message prompts you to select a smaller set of documents.
Check and publish released claims for previously deleted items - Select this check box to
resolve issues where deleted items were restored from an earlier version and the claim on them
was released. This check will take additional time and should only be used when deleted items
have been restored.
Operation — Select the operation you want to perform on the selected documents. Choose
from the following options:
 Publish now — Selected documents are published immediately.
 Background publish — Selected documents are published immediately as a separate
process, allowing you to perform other tasks at the same time.
 Scheduled publish — Selected documents are published in batch mode by the authoring
tool. This option is available only for tools that support it and if processed by the authoring
tool, not the SmartPlant Client. The documents are not published immediately. Instead, the
selected documents are scheduled for publish at a later time and maybe be scheduled as a
recurring operation.
Custom — If applicable, opens the Custom dialog box. This functionality is available only if
defined by your project implementation team.

Issue Request Tab (Publish Dialog Box)

This tab allows you to view the documents associated with a specific issue request and add
documents to or remove documents from a request.
Issue to — Contains a list of all objects (contracts) that can support issue requests. When you
select an item from this list, the names of any documents associated with that object appear in
the table below.
Add — Creates a new item in the table for any documents highlighted in the Selected
documents tree view.
Remove — Deletes a selected document from the table.
Document Name — Displays the names of all documents associated with the object in the
Issue to box.
Advanced Publish Options Dialog Box

Allows you to specify the type of files that you want to search for when you look for documents
to publish. This dialog box opens when you click Advanced on the Publish dialog box.
Document type — Indicates the types of documents the software considers when selecting the
documents to publish.

Find Documents to Publish from SmartPlant P&ID

1. Click SmartPlant > Find Documents to Publish.
 This feature is also available by clicking Find on the Publish dialog box.
 The Find Documents to Publish command determines which documents need to be
published or re-published and displays the results on the Find Documents to Publish
dialog box.
2. From the Select documents to publish list on the Find Documents to Publish dialog box,
select the check boxes beside the documents that you want to publish.
You can quickly select the entire list by clicking Select All, or you can clear the entire
list by clicking Clear All.
3. Click OK to accept the selections. The documents you selected to publish now appear in the
Documents to Publish list on the Publish dialog box, and are ready to be published.
The lists displayed on the Find Documents to Publish dialog box are compiled at the
time indicated in the Last search performed box. You can update the lists by clicking Update,
but this process can be time consuming, depending on whether you are running the applications
in synchronous or asynchronous mode.


 Publish Documents from SmartPlant P&ID
Find Documents to Publish Command (SmartPlant Menu)

Opens the Find Documents to Publish dialog box, which helps you select the documents that
you want to publish and specifies those documents that have never been published or have
been modified and need to be published again, or have been deleted since the last publish.
This list is specific to the authoring tool from which you are working.
Compare with Published Version Command (SmartPlant

Menu)
Allows you to compare the current document with a previous revision and version of that
document that was published.
Find Documents to Publish Dialog Box

Allows you to search for documents that have been updated since they were last published.
Additionally, you can use this dialog box to terminate documents that were previously published
but no longer exist in the authoring tool.
Last search performed — This option is not used.
Update — This option is not used.
Document types searched — Indicates what types of files were considered when the last
search was conducted.
Select documents to publish — Displays a list of files that were either updated since they
were last published or files that have not yet been published. For each file, this list displays the
file name and type, and the date on which the document was last published. If the file has not
been published, the Last Published box for the document is New.
Select documents to terminate — Displays a list of all the files that were previously published,
but have since been removed from the project. For each file, this list box displays the file name
and type, and the date on which the document was last published.
Select All — Selects all the files in the associated list of documents.
Clear All — Clears any selected documents in the associated list.
 Check for deleted objects no longer on documents option will be checked and disabled
if Automatic process of moved objects option is set to TRUE on the Manage Integration
Options dialog box in the SmartPlant Foundation Desktop Client. For more information, see
Configure Automatic process of moved objects in the Integration Administrator's Guide.
 The status bar contains three separate areas of information.

 In the lower-left corner, the current SmartPlant Foundation connection information is

displayed.
 The center of the status bar displays whether or not SmartPlant Basic Integrator is enabled.
If this section is blank, SmartPlant Basic Integrator is not enabled.
See Also
Find Documents to Publish Dialog Box - Document Types (on page 346)
Find Documents to Publish dialog box - Document Types

Allows you to specify the types of documents to find for publication.
Document types — Indicates the types of documents the software should consider when
deciding which documents should be published.
Revising Documents
The document revision process is separate from the publishing process, making it possible to
revise a document locally and in SmartPlant Foundation and save the revision values to the tool
database without re-publishing the document. You specify the revision using the Revisions >
New Revision command in Drawing Manager.
Revising a document creates a revision for the document with major and minor revision values
set, depending on the revision schema selected. When revising a document, you can modify the
major and minor revision data on the document.
You can 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 not required to assign a minor revision number. Also, revision data from tools is
supported even if the document has previously been revised in SmartPlant Foundation.
You can revise a document by using any previous revisions that are available from
the last published revision.
Example:
If you revise a new document using the revision scheme RevAlpha (A, B, C, D…) and revision
C, then SmartPlant Foundation reserves revision number C for the document. Revising the
same document with RevAlpha, you can now revise with any previous revision numbers, such
as A or B. However, if the document is published to SmartPlant Foundation with revision number
C, you are not allowed to go back to the previous revision numbers.
The following table contains the available revision numbers based on the document revision
state in SmartPlant Foundation:
Document revision state Next available revision number
Working (C) C and up
Current (C) D and up
For more details about performing revisions for SmartPlant P&ID, see Revising Drawings in the
SmartPlant P&ID Drawing Manager User's Guide.

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.
The authoring tools provide commands that let you select a document and retrieve it into that
tool. You can use either the SmartPlant > Retrieve command to open a wizard that assists you
in retrieving applicable documents, or with some authoring tools, you can configure an automatic
retrieval feature.
When you publish a 3D model, you must now enable the Scheduler and Loader in
SmartPlant Foundation 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.
The software trims all leading and trailing spaces from all strings and from all values
without units of measure. These spaces do not appear in the retrieved data file.
Additionally, you can access the Web Client through the SmartPlant > Browser command. This
allows you to select the document or documents that you want to retrieve from your Web Client
To Do List, the tree view, or by using the Web Client search functionality. After you select the
documents that you want to retrieve, you can use the Retrieve command on the Web Client
SmartPlant menu to start the retrieval process.
The Retrieve command provided in the authoring tools is slightly different from the Retrieve
command available in the SmartPlant Foundation Web Client. The Web Client presents a list of
documents from which you can select those you want to retrieve. However, when you use the
command from an authoring tool without first selecting documents, the software searches the
SmartPlant Foundation project for documents to retrieve, and these are presented in a list on
the Retrieve dialog box.
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 SmartPlant Foundation vault.
 With the latest data — Retrieves the latest data associated with the selected document in
the SmartPlant Foundation database. If another, more-recently published document contains
updates to objects in the selected document, the software retrieves the most current data in
the SmartPlant Foundation database for those shared objects. When you retrieve the latest
data, SmartPlant Foundation generates an .XML file containing the published data.
Document Types for Retrieval

The types of documents that you can retrieve depend on the authoring tool you are using.
From the authoring tools, you can retrieve the plant breakdown structure (PBS) and project
documents. The PBS and project documents, created in SmartPlant Foundation and published,
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 with a structure consisting of plants, areas, and units. The default structure is
plant/area/unit, but you can define a custom hierarchy in the Schema Editor. The project

breakdown structure, project list, and project definition document contain information about the
project or projects and their statuses in a plant/project structure.
 Retrieving the project breakdown documents and the PBS into SmartPlant Engineering
Manager creates the appropriate structures automatically.
 When using 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 a plant hierarchy with at least three levels with
a minimum of one unit before you can retrieve the PBS and project definition document.
 When working in a project, retrieval is not available.
 For certain document types, the tool schema definition may specify that To Do List tasks
(Create, Update, or Delete) will not be generated for those document types. For details, see
Suppress Generation of Tasks on Retrieve (on page 286).
Data Handling After Retrieval

The authoring tool that you use also determines how the system 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's To Do List that
allows you to 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 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.
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 life-cycle or can be schematic or
logical objects in one application that evolve into more detailed objects downstream.
Design basis is implicit 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, or a P&ID tag in SmartPlant
P&ID can evolve into a control loop with associated tag numbers in SmartPlant Instrumentation.

Retrieving to SmartPlant P&ID - Work Process

 Retrieve Documents to SmartPlant P&ID (on page 349)
Retrieve Documents to SmartPlant P&ID

1. Click SmartPlant > Retrieve. The Retrieve dialog box appears.
 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 in the Retrieve dialog box.
2. In the Document type list box, specify the type of document to be retrieved. The default
option is All.
3. Select further filtering options in the Show area of the dialog box.
 Select New documents to only display documents that have not been retrieved
previously.
 Select New versions of retrieved documents to only display documents that are a
new version of a previously retrieved document.
 Select Unchanged documents to display documents that have not been modified since
the last retrieval process.
4. Select Documents of all owning groups to display all documents.
5. In the Documents to retrieve list, select the check box beside each document you want to
retrieve. To help identify the documents, review the details in the Type, Revision, Version,
and Last Retrieved 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.
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 this document 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.
 During retrieval, an information dialog box appears with a progress bar. If the View Log
button on the dialog box is enabled, messages are available concerning the operation.
These messages may include errors or warnings or even informational messages. Click
View Log to see these messages.
Retrieve Command (SmartPlant Menu)

This command provides a list of the documents that need to be retrieved into the authoring tool.
This list is displayed on the Retrieve dialog box, from which you can select the documents you
want to retrieve, bringing the information from the SmartPlant Foundation database into the
authoring tool.
Retrieve Dialog Box

Allows you to retrieve information published by other authoring tools.
Document type — Lists the types of documents that you can retrieve. Selecting a document
type changes the list view to show only that document type.
Show — Indicates which documents you want to see in the list. Choose from the following
options:
 Documents to be retrieved only — Provides a list of only those documents that need to be
retrieved. In other words, the list will display the documents that have newer versions
published since they were last retrieved.
 New documents only — Provides a list of only the new documents that have not yet been
retrieved.
 All documents — Provides a list of all the documents available for retrieval, including both
new and previously retrieved documents.
Documents to retrieve — Displays a list of the documents available for retrieval. For each
document, this list provides the name, type, revision and version numbers, status, date of the
last retrieval, and revision option. Select the check box beside each document you want to
retrieve and then use the Retrieve Option column to specify whether you want to retrieve the
document with the Latest Data or retrieve it As published.
Select All — Selects all the files in the Documents to retrieve list.

Clear All — Cancels the selection of documents in the Documents to retrieve list.
Batch retrieve — Indicates that the system will retrieve the selected documents in batch mode,
in other words, in the background. When you use this feature, an e-mail message alerts you
when the process is complete. Otherwise, the retrieval process begins as soon as you click OK.
Work Breakdown Structure (WBS) documents, such as the Project List, Project
Definition, and Project Breakdown, and Plant Breakdown Structure (PBS) documents are
considered Administrative documents by the software and must be retrieved by all tools that
subscribed to these types of documents. So, even when these documents are new to the tools
(have not been retrieved by the tool before), they are still listed in the Documents to be
retrieved only list because they must be retrieved.
Correlation
Correlation may be defined as establishing a design basis for an item that has a separate
representation in two tools. For example, an instrument can share a design basis between
SmartPlant P&ID and SmartPlant Instrumentation; if data for that instrument is updated and
published from one of the tools and then retrieved in the other tool, an Update task is generated
for the correlated item.
In many cases, a one-to-one relationship exists between an item in an external application and
an item or items in the drawing software. For example, a piece of equipment defined in Aspen
Basic Engineering usually maps to a single equipment item in SmartPlant P&ID. In these cases,
once correlation has taken place, it is not possible to correlate the item in SmartPlant P&ID with
any other item in the external application unless the item is first uncorrelated. In addition, if an
item that has a design basis is deleted and then published in the external application and
afterwards retrieved in SmartPlant P&ID, a Delete task will appear in the To Do List for the
correlated item.
Correlation of the same item with different applications occurs independently.
For some types of piping, a single item in the external application is associated with multiple
items within the drawing software. For example, a single stream item in Aspen Basic
Engineering normally maps to multiple pipe runs in SmartPlant P&ID. The Correlate command
allows you to review and manage these relationships within the drawing environment.
Automatic Correlation
Automatic correlation takes place when you run a task in the To Do List for an item that does not
have an existing design basis. This can occur in the following situations:
 A newly-created item in the external application that does not have a matching item tag in
SmartPlant P&ID is retrieved in SmartPlant P&ID. This results in the generation of a Create
task. When this Create task is run, the item is created in the SmartPlant P&ID drawing and is
automatically correlated with the item in the external application.
Automatic correlation does not take place for items that are initially created in the
plant stockpile, such as loops. Such items must first be moved to the active drawing
stockpile and then correlated manually.
 An item in the external application that has a matching item tag in SmartPlant P&ID and
non-identical mapped properties is retrieved in SmartPlant P&ID. This results in the
generation of an Update task. When this Update task is run, the properties of the item are

updated in SmartPlant P&ID and the item is automatically correlated with the item in the
external application.
Manual Correlation
Manual correlation is available on the To Do List for Create tasks only, and is allowed under the
following conditions:
 The selected item cannot have an existing design basis for the same tool from which the
item was published.
 The selected item must be of the same item type as the item for which the Create task
applies.
 If a catalog item exists for the selected item, its catalog item type must be the same as the
catalog item type defined for the Create task.
For more information, see Perform Manual Correlation (on page 362).
Uncorrelating Items
When a design basis exists for an item, the item can be uncorrelated in one of the following
ways:
 On the To Do List, you can uncorrelate items from their Update or Delete tasks. For details,
see Uncorrelate Items from the To Do List (on page 362).
 Using the SmartPlant > Uncorrelate command, you can uncorrelate items even if they
were not deleted or their properties were not changed in the external application. For details,
see Uncorrelate Items (on page 354).
Changing the Design Basis of an Item

It is not possible to directly change the design basis of an item; however, this can be achieved
by first uncorrelating the item and then performing manual correlation between the desired
items. The uncorrelate step makes the item on the drawing or in the active drawing stockpile
available for manual correlation with a suitable item in the external application. Where the
uncorrelate step is performed on an Update task on the To Do List, that task is permanently
removed from the To Do List. The next time the document is retrieved, the To Do List is updated
and a Create task is generated for the item, allowing you to correlate the item in the external
application with a new item in SmartPlant P&ID (by running the Create task) or with an existing
SmartPlant P&ID item (by performing manual correlation for the Create task).
Update tasks only update those mapped properties that are different in the two tools.
When changing the design basis of an item that includes uncorrelation of an Update task
followed by manual correlation to a different SmartPlant P&ID item, it is recommended that you
retrieve the item again and run any new Update tasks that are generated so as to synchronize
the item's properties.

Correlate Pipe Runs with Streams

This procedure explains how to correlate pipe runs in SmartPlant P&ID with Aspen Basic
Engineering streams. A single stream item in Aspen Basic Engineering normally maps to
multiple pipe runs in SmartPlant P&ID.
1. Click SmartPlant > Correlate.
2. In the drawing, select either an item that was retrieved and placed in the drawing or a
previously correlated item.
As you move your pointer over an item in the drawing that is already correlated, the
item is highlighted. When you click a correlated item, it is added to the Items list on the
Correlate dialog box as a primary item. Then the application searches the database for all
other items that are correlated to the same design basis item and adds them to the list as
well.
3. On the Correlate dialog box, click Add.
4. Select an item in the drawing that you want to correlate with the retrieved item.
When the Correlate dialog box opens, you can highlight and select only items that
were retrieved or native P&ID items that are already correlated. Since retrieved items
already have a correlation, a message appears to make sure that you want to change the
existing correlation.
When you retrieve a document into SmartPlant P&ID, each item that is created in a
stockpile is automatically correlated to the design basis item that it came from.
Remove the Correlation Between Pipe Runs and Streams

1. Click SmartPlant > Correlate.
2. On the Correlate dialog box, select the item in the Items list whose correlation with the
design basis you want to remove.
3. Click Remove.
Correlate Command (SmartPlant Menu)

Opens the Correlate dialog box and allows you to review and edit the correlation between plant
items and design basis items.

Correlate Dialog Box

Allows you to review and edit the relationship between plant items and design basis items
imported from external applications.
Items — Lists all the items associated with a single design basis item. Items in the active
drawing are displayed in bold font style. A single item can be selected from the list, and when
selected, the item is highlighted in the drawing.
Select — Allows you to review a different drawing item. Clicking this button clears the Items list.
As you move your pointer over an item in the drawing that is already correlated, the item is
highlighted. When you click on a correlated item, it is added to the Items list as a primary item.
Then the application searches the database for all other items that are correlated to the same
design basis item and adds them to the list as well. Right-clicking quits this command.
Add — Allows you to correlate an additional item to the same design basis item that the listed
items are already correlated to. This command is available only when one or more items already
appear in the Items list. As you move your pointer over an item in the drawing that has the same
item type as the items in the list, the drawing item is highlighted. When you click on a highlighted
item, it is correlated with the same design basis item, and it is added to the list. If you click on an
item that is already correlated to some other design basis item, a confirmation message
appears. If you correlate a new item with a previously correlated item, both are associated with
the same design basis item; however, the new item inherits the properties of the item that it is
correlated to rather than the design basis item.
Remove — Deletes the selected item from the Items list and cancels its correlation with the
design basis item.
Uncorrelate Items
The purpose of this procedure is to uncorrelate drawing items with their design basis items.
1. Select one or more items on the drawing.
2. Click SmartPlant > Uncorrelate.
In the Design basis details pane, beside the ID, Item Tag and Item Type Name
columns, the software displays additional columns for each of the tools for which a design
basis exists for the selected drawing items.
3. On the Uncorrelate dialog box, select the check boxes for the items that you want to
uncorrelate for each tool.
To uncorrelate all of the items in a particular tool that have a design basis, select the
check box in the header for that tool.
 If an item does not have a design basis for a particular tool, the cell is read-only and it is not
possible to select the check box.
 After uncorrelating an item, any relevant tasks for that item on the To Do List dialog box are
removed.

Uncorrelate Command (SmartPlant Menu)

Opens the Uncorrelate dialog box and allows you to review and remove the correlation
between plant items and design basis items.
Uncorrelate Dialog Box

Allows you to review and remove relationships between plant items and design basis items
retrieved from external applications.
Design basis details

Lists all the items selected on the drawing that have a design basis.
ID — Displays the SP_ID that uniquely defines the design basis of the item.
Item Tag — Displays the item tag as defined in SmartPlant P&ID, if one exists.
Item Type Name — Displays the item type name, for example, Equipment: Mechanical.
For each tool for which a design basis exists for the selected items, the tool name appears in the
additional table columns. Each cell in the column has a check box that is initially not selected.
To remove an item's design basis for a particular tool, select the check box in the individual cell
corresponding to the item and the tool. To uncorrelate all of the items in a particular tool that
have a design basis, select the check box in the header for that tool.
If an item does not have a design basis for a particular tool, the cell is read-only and it is
not possible to select the check box.
Using the To Do List

The To Do List allows you to keep track of tasks required to keep P&IDs updated with
information in the SmartPlant Foundation database. Specifically, this feature aids in retrieving
data by providing a list of all the things that must be added, deleted, or modified to bring the
drawing into agreement with the newest retrieved information.
A single To Do List is shared by all the users of a plant database. You can view the entire To
Do List and see the tasks that have been completed and those that are pending. Some types of
tasks have associated code and you can run them thereby causing the database or drawings to
be modified.
From the To Do List, you can run, defer, or delete tasks, or specify tasks that you want the
software to ignore in future retrievals. Additionally, you can view properties for each task in the
To Do List and, if desired, specify that certain task properties are ignored when the task is
retrieved. The information that is available is specific to the type of task that is selected: Create
tasks and Update tasks, for instance, but certain information is provided for all types. The
available task types are:
 Create — Creates a new item in the active drawing or the plant stockpile
 Update — Updates the selected properties of the specified item
 Delete — Deletes the specified item from the plant
 Manual — Creates and displays a reminder. You can decide when a manual task is
complete and set the status accordingly.

Each task in the To Do List has a status. Initially, the status is Open. If you successfully run the
task, the status changes to Complete . If you attempt to run a task, but the process is not
completed successfully, the status is changed to Error . Error status occurs, for example, if
you attempt to run an Update task assigned to a drawing that is not currently open. For a
Create task where the task runs successfully, but the software has made changes to the item
tag, the status is updated to Completed with Warning . For more details, see Example of
Completed with Warning Status (on page 358). You can also postpone running a task and
change its status to Deferred .
SmartPlant P&ID retrieves equipment components and nozzles and generates corresponding
Create tasks in the To Do List for them. The system allows you to automatically place the items
in a drawing when the To Do List task is executed. The items are placed attached to their
parent equipment item, based on a spacing algorithm. You can adjust the location,
post-placement, as necessary.
 When the software creates an Update task in the To Do List, the units of measure used in
properties are automatically converted to the defaults for the plant. The units of measure
used for properties in Create tasks are converted to the plant defaults when the task is run.
 By clicking the heading of columns on the To Do List, you sort the list by the values in that
column. You can change the order in which these columns appear in the Task List by
right-clicking a column heading and choosing either Shift Left or Shift Right from the
shortcut menu to move the column one place in either direction.
Open the To Do List

 On the main menu bar, click SmartPlant > To Do List.
1. Click SmartPlant > To Do List.

2. On the To Do List, select a task that is assigned to a drawing.
You can assign tasks to drawings by using commands on the To Do List.
3. Click Open Drawing .
Once the drawing is open, you can display drawing items from the To Do List, too.

2. On the To Do List dialog box, select a task.
3. On the To Do List toolbar, click Zoom .
 The software opens a Drawing view with the drawing items that are associated with the task
highlighted.
 The Zoom command is available only for Update and Delete tasks, not for Create tasks,
and only when the drawing that the item belongs to is already open.


2. From the list on the To Do List dialog box, select the tasks that you want to assign to a
particular drawing.
3. Click Assign Drawing .

4. On the Assign Drawing dialog box, select the drawing that you want to assign these tasks
to.
Modify To Do List Task Properties

2. From the task list on the To Do List dialog box, select the task that you want to edit.
3. On the toolbar, click Properties .

You can also open the Properties dialog box by double-clicking a task in the To Do
List.
4. On the Task Properties dialog box, change the properties as necessary.
The properties available for each task depend on the type of task. For all types, you can
edit the name and notes for the task. For Create and Update tasks, you can ignore task
properties when running a task. For Create tasks, you can edit the catalog item being created
and turn off or on the values assigned to different properties for that item. For Update tasks,
you can turn off or on the new values assigned to properties for the item.
Run Tasks from the To Do List

2. On the To Do List dialog box, select one or more tasks to run.
3. Click Run .
 For SmartPlant P&ID Engineering, it is not possible to run Create or Delete tasks.
 If a task is assigned to a drawing, the drawing must be open before you can run the task.
You can open a drawing from the To Do List.
 Manually created tasks are not executable tasks and cannot be run from the To Do List.

Example of Completed with Warning Status

This status appears for Create tasks when the software has performed a validation and
determines that an item with the same tag sequence number already exists. In such cases, the
new item automatically receives a new sequence number, and the To Do List item status
becomes Completed with Warning, indicated by the icon . The following scenario shows
how a Create task can receive this status.
1. In SmartPlant Instrumentation, create a loop named 'c-114' and publish the Instrument
Index.
2. Retrieve the Index in SmartPlant P&ID.
3. Open the To Do List to verify that a Create task exists for the loop, but do not run the task.
4. Close the To Do List and then manually create a loop named c-114.
5. Reopen the To Do List and execute the loop create task.
The software will create the loop, but actually renames it. In the To Do List, the Create task
for the loop appears with a Completed with Warning status icon as shown.
6. Double-click the Create task to open the Properties dialog box for the task and click the
General tab.

An indication of the warning appears in the Notes field, together with details of the loop
renaming.
Define Filtering by Task Assignment for the To Do List

2. Define the task assignment for each task to be included in the filtering by doing the
following:
a. Double-click the desired task to open its Properties dialog box.
b. On the General tab, in the Task assignment field, enter free text as desired.
3. On the toolbar, click Filter / Sort Tasks .

4. On the Filter / Sort dialog box, click the Filter tab.
5. Beside the Filter name box, click the ellipsis button.
6. Select a folder and click New to create a new filter.
7. On the New Filter dialog box, select Simple filter.

8. On the Add Filter dialog box, define a filter using the Task Assignment property as shown
in the example below.
In the Value field, you can use a percent sign (%) as a wildcard character to find
multiple characters or an underscore (_) as a wildcard character for a single character.
9. Click OK to apply the filter on the To Do List.
Filter To Do List Tasks


3. On the Filter / Sort dialog box, click the Filter tab.
4. Beside the Filter name box, click the ellipsis button to select a filter.
If you cannot find a suitable existing filter, click New to create a new filter.
5. Click OK to apply the filter on the To Do List.

Sort To Do List Tasks


3. On the Filter / Sort dialog box, click the Sort tab.
4. Select up to three To Do List properties as sort criteria by selecting from the Sort by lists;
for example: Item Type, Task Status, Task Type.
5. For each sorting property, select whether to sort in ascending or descending order.
Defer Tasks from the To Do List

2. On the To Do List dialog box, select the tasks that you want to defer.
3. On the toolbar, click Defer .
Remove Tasks from the To Do List

2. On the To Do List dialog box, select the tasks that you want to remove.
3. On the toolbar, click Delete .
Display Deleted To Do List Tasks

2. On the toolbar, click View Deleted Tasks .

To return to the To Do List, click this command again.
3. To delete tasks permanently, select the tasks that you want to delete, and on the To Do List
toolbar, click Delete .
Ignore To Do List Tasks

2. On the To Do List dialog box, select the Create tasks that you want to be ignored.
3. On the toolbar, click Ignore .

Perform Manual Correlation

This procedure explains how to correlate an item where the SmartPlant P&ID item tag does not
match the item tag in the external application. Manual correlation is allowed under the following
conditions:
item was published.
applies.
2. On the To Do List dialog box, select the Create task that you want to correlate.
3. On the toolbar, click Correlate .

The software highlights items that are suitable for correlation on the drawing sheet.
4. Do one of the following to choose the item whose properties you want to correlate:
 On the drawing sheet, select one of the highlighted items.
 In the Engineering Data Editor, select a row from the active drawing, the active
drawing stockpile, or the plant stockpile.
Selection of an item for correlation is only possible from the main Engineering Data
Editor window; you cannot perform correlation on an item if it is selected in an Engineering
Data Editor view that was opened in the Design window.
5. At the message prompt, confirm that you want to correlate the selected item by clicking Yes.
The Create task changes to an Update task and the software removes any properties on the
task that have the same values as those of the item selected on the drawing sheet.
6. Run the correlated task to update the drawing item properties.
Uncorrelate Items from the To Do List

2. On the To Do List dialog box, select one or more Update or Delete tasks that you want to
uncorrelate.
a. On the toolbar, click Uncorrelate .

b. Click Actions > Uncorrelate.
4. At the message prompt, confirm that you want to uncorrelate the selected item by clicking
Yes.
After uncorrelating tasks, the items will no longer be correlated with the tool from which
those tasks were retrieved. The tasks are permanently removed from the To Do List and do not
appear on the deleted tasks list. The next time the document is retrieved, the To Do List is
updated.

You cannot perform Correlate or Uncorrelate to items in the To Do List that were
upgraded from versions prior to SmartPlant Instrumentation 2013. Republish the To Do List to
allow the correlation functionality to work with items that were upgraded from versions prior to
SmartPlant Instrumentation 2013.
Ignore Task Properties

2. On the To Do List dialog box, select the Create or Update task whose properties you want
to ignore.
3. On the toolbar, click Properties .

You can also open the Task Properties dialog box by double-clicking a task in the To
Do List.
4. On the Task Properties dialog box, click the Create or Update tab, according to the
selected task type.
5. Select the Ignore check box beside each property that you want the software to ignore
when running the task.
When you select to ignore a property, the software does not update that property when
you run the task for the current or for subsequent retrieve sessions. If the new value of the
property changes in the published data, on the next retrieve, that property is no longer
ignored. If you want to ignore the property only for the current retrieve session, clear both
the Activate and Ignore check boxes beside the property.
After running a task that includes ignored properties, that task is copied from the To Do
List to the ignored tasks list, where only the properties that were selected to be ignored appear
on the Details tab.
Display Ignored To Do List Tasks

2. On the toolbar, click View Ignored Tasks .

To return to the To Do List, click this command again.
3. To delete ignored tasks permanently, select the tasks that you want to delete, and on the To
Do List toolbar, click Delete . This action makes the task available from the To Do List
the next time you retrieve the document to which the task belongs.
Update the To Do List Display

 On the To Do List dialog box toolbar, click Refresh .

To Do List Task Commands and Controls

To Do List Command
Opens the To Do List window, which lists tasks to be performed in the authoring tool
(SmartPlant Instrumentation, SmartPlant Electrical, or SmartPlant P&ID). From the To Do List,
you can run, defer, or delete tasks, and you can organize your tasks.
This command is available regardless of whether a drawing is open or not.
See Also
Working with SmartPlant Integration (on page 257)
Using the To Do List (on page 355)
Open the To Do List (on page 356)
To Do List Dialog Box

Provides the ability to manage tasks that need to be run within a SmartPlant P&ID database in
order to keep the plant current with information in the SmartPlant Foundation database. This
dialog box opens when you click SmartPlant > To Do List on the main menu bar. The
commands associated with the To Do List are all on the To Do List toolbar.
Open Drawing — Opens the drawing associated with the selected task. If the drawing is not
active, this command activates it. Any currently-open drawings remain open. This command is
available when a drawing-specific task is selected and the drawing is not currently open or
active. If multiple tasks are selected, this command is available only if they are assigned to the
same drawing. You can assign or reassign a Create task, but Update and Delete tasks that
are already assigned to a drawing cannot be reassigned.

Zoom In — Centers and zooms in on the drawing items associated with the selected tasks
in the Drawing view. You select the tasks from the list. This command allows you to visually
inspect the referenced objects in the context of the surrounding drawing and is available when
the selected task is associated with graphics and the drawing that contains the object is open
and active. If multiple tasks are selected, this command is available only if each of the tasks
meets these criteria.
New Manual Task — Displays the Task Properties dialog box, and allows you to manually
create a new task.
Properties — Displays the Task Properties dialog box for the selected task. This dialog
box shows the detailed properties of the task. This command is available only when a single
task is selected.
Assign Drawing — Creates an association between the selected task and a particular
drawing. The Assign Drawing dialog box opens and lists the available drawings. This
command is available when you select manually added tasks or tasks resulting from the Create
command. If multiple tasks are selected, this command is available only if each of the tasks
meets these criteria.
Create in Drawing — If this button is depressed, the item created by running the selected
task is placed on the active drawing. If the button is not depressed, the item is created in the
Plant stockpile.
Run — Runs the task that you select from the list. This command is available when an
executable task is selected, the associated drawing is open and active, and the status of the
selected task is Open or Error. This command is not available for manually created tasks; in
other words, the command is only available for tasks generated automatically by integration and
importing data. If multiple tasks are selected, this command is available only if each of the
tasks meets these criteria.
When a task runs, the status of the task and the Run Date and Run By properties are
updated. If the task runs successfully, the status is updated to Completed . If there is a
problem, the status is updated to Error . For a Create task where the task runs successfully,
but the software has made changes to the item tag, the status is updated to Completed with
Warning . For more details, see Example of Completed with Warning Status (on page 358).
When the status is Error or Completed with Warning, a timestamp and error message are
added to the Notes area on the General tab of the Task Properties dialog box.
Defer — Toggles the status of the selected tasks between Open and Deferred . This
command is available only when the selected tasks have Open, Error , or Deferred status.
Delete — Allows you to delete the selected task from the To Do List. This command is
available only when one or more tasks are selected. A confirmation dialog box appears to verify
deletion of the selected task or tasks.
Ignore — Allows you to specify the selected task from the To Do List as an ignored
task. This command is available only when one or more tasks are selected. When you invoke
this command, the software moves all the selected tasks to the ignored tasks list. An ignored
task is skipped for all subsequent retrieve operations. To make a task available for running
again the next time you retrieve data, you must delete that task from the ignored tasks list.
Correlate — Allows you to correlate tasks manually when a retrieved item tag does not
match the defined correlation criteria. This command is available only when a Create task is

selected. To correlate an item, you select a suitable item on the drawing sheet or in the
Engineering Data Editor. After correlation, the Create task changes to an Update task and
the software removes any properties on the task that have the same values as those of the item
selected on the drawing sheet.
Correlation is allowed under the following conditions:
item was published.
applies.
Uncorrelate — Allows you to uncorrelate tasks related to items on the drawing sheet or in
the Engineering Data Editor. This command is available only when Update or Delete tasks
are selected. After uncorrelating tasks, the items will no longer be correlated with the tool from
which those tasks were retrieved. The tasks are permanently removed from the To Do List and
do not appear on the deleted tasks list. The next time the document is retrieved, the To Do List
is updated.
View Deleted Tasks — Toggles the view between the To Do List and the deleted tasks
list. To completely delete tasks, you select them from the deleted tasks list and click Delete
.
View Ignored Tasks — Toggles the view between the To Do List and the ignored tasks
list. To make tasks available for running again the next time you retrieve data, you select them
from the ignored tasks list and click Delete .
Report — Opens Microsoft Excel and runs a report on the contents of the To Do List. This
command is only available from the To Do List toolbar, but the report template, called To Do
List.xls, produces reports much the same way other reports are produced.
Filter / Sort Tasks — Opens a dialog box that allows you to filter or sort the list of tasks by
the headings in the To Do List. This is useful if, for example, you want to filter or sort the tasks
in order to run tasks of one type only, such as Create tasks.
Refresh — Updates the information that is displayed in the To Do List. Since only one To
Do List is generated per plant, multiple users can be working in the To Do List at the same
time, and so the information can change at any time. You can use the Refresh command to
stay up-to-date.
Group Related Tasks — When this button is depressed, clicking on the column header not
only sorts the tasks based on the selected sort key but also groups the related tasks. If the
Group Related Items button is not depressed, then clicking on the column header only sorts
the tasks based on the selected column sort key.
Task List
Populates automatically when you retrieve a document. This list provides information about
each task, including, for example, the status of the task, the destination drawing, the name of
the task, a description of the task, and so forth. By clicking the heading of any of these
columns, you sort the list by the values in that column. You can change the order in which

these columns appear in the Task List by right-clicking a column heading and choosing either
Shift Left or Shift Right on the shortcut menu to move the column one place in either
direction. Double-clicking a task opens the Task Properties dialog box for that task.
The Task Assignment column value is assigned on the General tab of the Properties
dialog box for the task and is intended for filtering To Do List tasks.
Assign Drawing Dialog Box

Allows you to associate a task in the To Do List with a drawing assigned to the active plant
structure. Create tasks are not initially associated with a drawing; you can assign Create or
Manual tasks using this dialog box. This dialog box opens when you click Assign Drawing
on the To Do List dialog box.
Clear — Removes the association between the selected task and a drawing.
Drawings — Lists all the drawings associated with the active plant. Select the drawing that
you want to associate with the tasks you selected on the To Do List dialog box. When you
select a drawing and click OK, the selected tasks are assigned to that drawing.
Filter / Sort Dialog Box

Allows you to filter or sort tasks according to the category headings on the To Do List dialog
box.
Filter tab (on page 367)
Sort tab (on page 367)
Filter Tab
This dialog box allows you to filter the data displayed on the To Do List dialog box according to
the category headings for the To Do List tasks.
Filter name — Displays the name of the selected filter, defined in the Filter Manager. To select
a filter, click the ellipsis button .
Clear — Clears the selected filter in the Filter name field so that you can clear the filter on the
To Do List.
Sort Tab
This dialog box allows you to sort the data displayed on the To Do List dialog box according to
the category headings for the To Do List tasks.
Sort by
Allows you to select the first category to sort the list by.
Ascending —Sorts by the beginning of the alphabet, the lowest number, or the earliest date
first for the selected category.
Descending —Sorts by the end of the alphabet, the highest number, or the latest date first for
the selected category.

Then by
Allows you to select the second category to sort the list by.
Then by
Allows you to select the third category to sort the list by.
Clear —Clears the selected sort selections so that you can clear the sorting on the To Do List.
Task Properties Dialog Box

Provides information about tasks that are defined in the task list of the To Do List dialog box.
The tabs that appear on this dialog box are determined by the type of task that you selected
from the To Do List. There are three basic types of tasks: Create, Update, and Delete tasks.
This dialog box opens when you click Properties on the To Do List dialog box. You must
select a task from the To Do List in order to open this dialog box.
 General Tab (on page 368)
 Details Tab (on page 369)
 History Tab (on page 369)
 Create Tab (on page 369)
 Update Tab (on page 370)
General Tab
Displays properties that are common to all types of tasks. The Task Properties dialog box
opens when you click Properties on the To Do List dialog box toolbar.
Name — Provides a descriptive string that helps you identify the purpose of the task. This value
is not a unique identifier for the task.
Description — Displays a longer description of the purpose of the task.
Task assignment — Free text field whose value is used for filtering tasks to be displayed on the
To Do List dialog box.
Status — Indicates the level of completion of the task. The following choices are available:
Open, Completed , Deferred , and Error . When a task is created, the status is set to
Open, which does not have an identifying icon in the list of To Do List tasks.
Notes — Allows you to enter freeform text about the task. You can also enter hyperlinks to other
documents for more extensive information. Information about the execution of the task, such as
the success of the procedure, is added to the end of any existing notes for a task.

If you run a Create task for an item that already exists, the new item automatically
receives a new sequence number, and the To Do List item status becomes Completed with
Warning, indicated by the icon . In the Notes field, the message 'Task completed with a
warning' is displayed, together with details of the sequence number change.
Details Tab
Provides information that is common to all types of tasks and that concerns the source and
destination of the information being imported as part of the task. The Task Properties dialog
box opens when you click Properties on the To Do List dialog box toolbar.
Engineering tool — Displays the name of the application that published the document from
which this task originated.
Document — Displays the name of the document from which this task originated (for example,
an Aspen Basic Engineering equipment data sheet or a SmartPlant Instrumentation instrument
index).
Item tag — Displays the item tag of the drawing object from which this task originated. For
Update and Delete tasks, this box displays the item tag of an existing item. For Create tasks,
this box displays the item tag of the item to be created. This information is read-only.
Drawing — For drawing-specific tasks, this box displays the name of the drawing to which the
task is assigned. This information cannot be directly edited on this tab, but you can use the
Assign Drawing command on the To Do List dialog box to change this value.
History Tab
Provides information this is common to all types of tasks and that concerns the history of the
task. This information includes the user names and dates for the creation of an item,
modification of an item, and so forth. The information on this tab is read-only. The Task
Properties dialog box opens when you click Properties on the To Do List dialog box toolbar.
Created By — Displays the user name of the task creator.
Created Date — Displays the date and time that the task was created.
Modified By — Displays the user name that last ran, modified, or deleted the task.
Modified Date — Displays the date and time that the task was last run, modified, or deleted.
Run By — Displays the user name that last ran the task.
Run Date — Displays the date and time that the task was last run.
Deleted By — Displays the user name that removed the task.
Deleted Date — Displays the date and time that the task was removed.
Create Tab
Displays information specific to tasks that create new items in the drawing. This information
includes the type of item created and the names and values of the properties of the new
item. The Task Properties dialog box opens when you click Properties on the To Do List
dialog box toolbar.
Item type — Displays the type of item to be created.
Catalog item — Indicates the catalog item used to create the drawing item if the task is run.

Correlation action — If running the task involves correlating data with another item, the text
Correlate appears in this box; otherwise, the value in the box is empty.
Item properties
Displays the task data properties and enables you to select which properties to include when
you run the task.
Activate — Creates the value in the database when you run the task. This option applies only
to tasks for which the status is New, Open, or Deferred.
Ignore — Ignores the new value of the property when you run the task, unless the new value
changes after subsequent retrieval. This option applies only to tasks for which the status is
New, Open, or Deferred. To ignore a property for the current retrieve session only, clear both
the Activate and Ignore check boxes.
Property — The name of the item property as it appears in SmartPlant P&ID.
New Value — The new value of the item property in the SmartPlant P&ID database as indicated
in the retrieved document.
Update Tab
Displays information specific to tasks that update existing items in the drawing. This information
includes the type of item created and the names and values of the item properties. The Task
Properties dialog box opens when you click Properties on the To Do List dialog box toolbar.
Item type — Displays the type of item to be updated.
Catalog item — Indicates the catalog item used to create the drawing item if the task is run.
Correlation action — If running the task involves correlating data with another item, the text
Correlate appears in this box; otherwise, the value in the box is empty.
Item properties
Displays the task data properties and enables you to select which properties to include when
you run the task.
Activate — Updates the value in the database when you run the task. This option applies only
to tasks for which the status is New, Open, or Deferred.
Ignore — Ignores the new value of the property when you run the task, unless the new value
changes after subsequent retrieval. This option applies only to tasks for which the status is
New, Open, or Deferred. To ignore a property for the current retrieve session only, clear both
the Activate and Ignore check boxes.
Property — The name of the item property as it appears in SmartPlant P&ID.
New Value — The new value of the item property in the SmartPlant P&ID database as indicated
in the retrieved document.
Old Value — The current value of the item property in the SmartPlant P&ID database.

SECTION 11
Comparing SmartPlant P&ID with PDS

There are many functions that can be compared between SmartPlant P&ID and the PDS
product. They include attributes and properties, code lists and select lists, relationships
between placed items, construction status values, consistency checking and propagation,
design file differences, and using filters.
Code Lists and Select Lists

In PDS, an attribute that is restricted to pre-defined values is said to be code-listed. These
values for SmartPlant P&ID properties are called select-listed values; they reside in a select
list. For more information, see Comparing Code Lists and Select Lists (on page 372).
Setting Construction Status

In PDS 2D, you set the construction status by clicking the New, Future, or Existing buttons on
the Construction Status control. When an item is placed, the default construction status is
New. For more information, see Setting Construction Status (on page 372).
Comparing Consistency Check to Propagation

Consistency Check in SmartPlant P&ID serves the same purpose as propagation in PDS
2D. For more information, see Comparing Consistency Check to Propagation (on page 372).
Comparing Graphics and Text in PDS 2D and SmartPlant P&ID

In PDS 2D, graphics are called cells. These graphics include pumps, tanks, piping, valves, and
other items. In SmartPlant P&ID, graphics are called catalog items. For more information, see
Comparing Graphics and Text in PDS 2D and SmartPlant P&ID (on page 374).
Using Filters and Display Sets Versus Levels

PDS 2D uses levels to separate data types in the Drawing view. SmartPlant P&ID uses filters
and display sets to show certain parts of the drawing, such as only the equipment or only the
piping, and you can combine filters in both display sets and compound filters. For more
information, see Using Filters and Display Sets Versus Levels (on page 374).

Comparing Code Lists and Select Lists

In PDS, an attribute that is restricted to pre-defined values is said to be code-listed; that is, the
accepted values for the attribute are defined in a codelist.
When you add an entry to a codelist, the system automatically assigns a number for the
entry. The value assigned will be greater than 10,000.
In SmartPlant P&ID, some properties are likewise restricted to preset values. These values for
SmartPlant P&ID properties are called select-listed values; they reside in a select list. Select
entries are the individual members of a select list. Select lists and their select entries are defined
in SmartPlant Data Dictionary Manager. For more information on defining select lists and
entries, see SmartPlant Data Dictionary Manager Help.
Some code lists and select lists contain special, restricted values, frequently in the Short Value
entry. These special values help SmartPlant P&ID communicate information to other
applications, such as PDS 3D, SmartPlant 3D, and SmartPlant Reference Data. Consequently,
you should use caution when modifying any entries already included with the product when it is
delivered to you. You must have special permissions, granted in SmartPlant Engineering
Manager, to modify select lists in SmartPlant Data Dictionary Manager.
Setting Construction Status

In PDS 2D, you set the construction status by clicking the New, Future, or Existing buttons on
the Construction Status control.
Comparing Consistency Check to Propagation

Consistency Check in SmartPlant P&ID serves the same purpose as propagation in PDS 2D.
However, instead of waiting to check for errors until after the drawing is complete, SmartPlant
P&ID continuously checks for design errors during drawing creation.
Consistency checking is an important function in producing a useful design. The designer places
the elements that compose the overall configuration of the design in a graphical mode. The
designer places equipment, routes lines between equipment, places components on lines, and
adds labels for accuracy. After the designer completes this work, consistency checking confirms
that the created drawing agrees, or is consistent, with the design practices of the associated
plant.
PDS 2D uses a process called propagation to verify the suitability of a design. Propagation
determines that a drawing is not ambiguous. Also, the process populates the associated
database if serious propagation errors do not exist. Propagation produces a report with
propagation exceptions. You must resolve them for an acceptable drawing. Available tools can
help in the review of the report along with the drawing. However, pinpointing the source of the
inconsistency could require time. Also, when you discover an error, tools or suggested error
recoveries are not available.
In the SmartPlant P&ID environment, Consistency Check continuously blends into the software
product, more so than the workflow associated with propagation. Consistency Check starts
when you modify an item. SmartPlant P&ID uses predefined rules to establish relationships that

verify the design, and it automatically reports in the graphical view on junctions that do not follow
these rules.
To check for errors in your design, PDS 2D uses propagation, while SmartPlant P&ID uses
consistency checking. Errors occur when you violate the design practices for a plant. For
example, an inconsistency occurs if a designated material is connected to a different type of
material.
In PDS 2D, propagation checks for errors each time the software populates the database. You
can list the types of errors you want to detect, such as pipe and valve conflicts. The software
detects and reports the errors so you can correct them in the drawing. However, because you
do not receive a list of possible solutions, resolution can be time-consuming.
In SmartPlant P&ID Engineering, consistency checking occurs continuously as you modify
equipment according to settings in SmartPlant P&ID Rule Manager. Double-click an
inconsistency in a Drawing view, and the Consistency Check dialog box lists solutions to fix the
errors.
Comparing System Editing to Propagation

SmartPlant P&ID is a data-centric application that makes use of a live connection to the plant
database within the graphical environment. The drawing provides a familiar user interface for
creating and modifying the data in the database. The database is the master data-store. The
drawings can be regenerated from the data in the database.
PDS 2D is a drawing-centric application that can load the plant database from the data in the
drawings. Drawings can be created independently and loaded into the database at a later time.
The drawings contain the master data. The database can be regenerated from the data in the
drawings.
The term propagation as used in PDS 2D describes the process by which the data in the
drawings are loaded into the database. This process includes three major parts: 1) Validation of
the graphics, 2) Validation of the data and the spreading of the data through the network of
connected items, 3) Loading of the database.
Validation of the graphics, validation of the data and loading of the database are not included in
SmartPlant P&ID System Editing (propagation). System Editing is not a post-process of any
kind. It is not driven by the existence of labels on the drawing. It does not apply a precedence
algorithm to determine the property value for each item.
It is a process that happens every time a property is changed (if the command is turned on). It is
a process by which a property value can be spread throughout a connected network of items
without requiring the user to visit each item. It is a process by which consistency can be
maintained with minimal effort as the design changes.
For more information, refer to System Editing (on page 177).

Comparing Graphics and Text in PDS 2D and

SmartPlant P&ID
In PDS 2D, graphics are called cells. These graphics include pumps, tanks, piping, valves, and
other items. PDS 2D cells are grouped together in libraries. You can add and delete cells or
place cells from a library into the design file.
In PDS 2D, you can record text on a label. Then, at certain times, you propagate or write the
information on the labels to the database.
In SmartPlant P&ID, graphics are called catalog items. SmartPlant P&ID supplies a pre-loaded
set of symbols. Plant administrators can create more symbols if needed. For more information
about creating symbols, see SmartPlant Catalog Manager Online Help.
For SmartPlant P&ID Engineering, placement of symbols is not allowed.
In SmartPlant P&ID, labels play a different role than in PDS 2D. In SmartPlant P&ID, you add or
edit properties information for each item in the Properties window, and the software
continuously writes this information to the database. Most labels show item properties, which are
stored in the database. These labels are referred to as "driven," because they are updated as
the property values of the item are updated. SmartPlant P&ID also provides "driving" labels,
which you can use to directly edit properties in the database by editing the properties of the
label.
PDS 2D uses levels to separate data types in the Drawing view. The software automatically
defines levels for the various parts of process systems. You can customize these levels, and
you can combine them to view collective data sets.
In SmartPlant P&ID, display sets show certain parts of the drawing, such as only the equipment
or only the piping. A display set consists of one or more filters. For example, you can define a
display set that combines a filter that displays 6- inch pipe with a filter that displays tanks more
than 5 feet in diameter. Then, both 6-inch pipe and tanks over 5 feet in diameter are displayed.
SmartPlant P&ID filters fall into the following categories:
 Plant filters
 Personal filters
Plant filters are stored in Plant Folders, and personal filters are stored in My Folders. The plant
administrator defines Plant filters, while each individual user defines personal filters. You can
use filters along with rules to check for errors in certain filtered views. SmartPlant P&ID offers
extensive flexibility in creating and editing filters. You can even edit the individual properties of
the filters.
For more information about creating and editing filters, see SmartPlant Filter Manager
Help. For more information about display sets, see Apply Display Set Dialog Box (on page
181).

SECTION 12
Troubleshooting
Problem: The application fails to launch or stops working when the user launches it.
Reasons: The application may fail to launch due to damage in any of the following areas:
 Cached data
 Database connection or database client
 Database server, site, or plant
 SmartPlant P&ID client software
 SmartPlant P&ID client USER information
Solution: We recommend that you perform each of the following steps in the order shown and
after each step try to launch the application. If the application still fails to launch, proceed to the
next step:
1. Open Task Manager and terminate the draft.exe process.
2. Reboot the computer.
3. Clean up temporary cached data (.tmp and .temp files) in the client's user profile. These
files are usually located in the path C:\Documents and Settings\username\Local
Settings\Temp\.
4. Check the database connection using the appropriate database tools.
5. Delete the SmartPlantManager.ini and SmartPlantPID.ini files. These files are usually
located in the path C:\Documents and Settings\username\
6. Uninstall the software client and do the following:
a. Clean up the current USER registry information:
HKEY_CURRENT_USER\Software\Intergraph\Applications\SmartPlantPID.Application
b. Ensure that the following registry settings have been removed:
 HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\Applications\SmartPlantPID.App
lication
 HKEY_LOCAL_MACHINE\SOFTWARE\Intergraph\SmartPlant P&ID
c. Clean up any left-over files and the following folders:
 SmartPlant P&ID installation folder ..\SmartPlant\P&ID Workstation\.
 Any subfolders in the Windows\Downloaded Installations\ folder that contain
SmartPlantPID.msi files.
Deletion of the SmartPlantManager.ini file and the current user's registry
environment will clear the user's recent activities and customized menu look-up.
d. Reinstall the software client.
If, after performing all of the above troubleshooting steps, the application still fails to launch,
contact Intergraph Customer Support.

Troubleshooting
Problem: The software is unable to print to PDF.

Reasons: The PDF printer driver may not have been installed correctly, or may have been
damaged, or may be the wrong version. For SmartPlant P&ID, the correct printer driver version
is SmartPlant PDF Converter (Amyuni 4.5).
Solution: If the problem is due to an incorrect or damaged file, we recommend that you uninstall
the SmartPlant PDF Converter printer driver and install the correct version. Restore the driver
by running the executable file InstallPDFConverter.exe, which is installed by default in the
software installation folder path ..\SmartPlant\P&ID Workstation\bin.

Glossary
alias
An alternative name for an object, such as a variable, file, device, or database instance.
annotations
Dimensions, notes, symbols, or reports that are used in a drawing to provide information or
comments.
archive
To copy a file to a specified storage location and then delete the file from the current location.
attribute
1. A property or characteristic of a component.
2. A characteristic that all members of a class possess. Each property has an associated value
that defines its current state. Most databases represent an attribute by a column in a table.
backup
To copy a file to a specified storage location while retaining the file in the current location.
batch processing
A method of processing data that collects a series of operations into a group and runs the group
in a continuous stream without user intervention.
Boolean operator
Syntax that defines logical relationships between expressions like AND (both), OR (either), and
NOT (other than).
branch point
A point on a pipe run that separates piping segments for assignments with different segment
parameters.
break label
A graphic label placed at a point in a piping line at which any property can change value.
cache
Memory that stores recently-accessed data so that subsequent requests to access the same
data can be processed quickly.
catalog
A collection of catalog items, which are blueprints or templates for creating an item within the
model.

Glossary
check in
The process of moving a file from a user location to a storage location and recording that
location in the database.
class
A blueprint for creating an item. The class defines the properties and behaviors that an item can
show.
client
A user, software application, or computer that requests the services, data, or processing of
another application or computer. The client is the user process. In a network environment, the
client is the local user process and the server may be local or remote. All network operations
among two or more nodes establish a client/server relationship.
client/server database
A database system in which the database engine and database applications reside on separate,
intelligent computers that communicate with each other through a network. In this system, the
processing power is split between the two CPUs. The workstation for the user is the client, and
the database runs on the server.
code list
See select list.
collaboration
Working jointly. In Workshare, satellite sites work together with the host site to share the
creation and maintenance duties for P&ID drawings and related data.
column
An attribute of a database table. A group of columns defines a table in the database.
commodity code
A code you define that provides an index to material descriptions.
commodity item
A standard component that you can find in a manufacturer catalog.
commodity option
A pre-defined exception to the default settings for a component definition in the Piping Job
Specification.
component
A catalog item that represents a part of the P&ID. A component has database information
associated with it.
concentric
Having a common center or origin point with varying radii.

Glossary
configuration files
Files that are used to identify and characterize the components of a network. Configuration is
largely a process of naming network components and identifying relationships among those
components.
connect point
An active point item that is specially designated in a component. A connect point is a location at
which lines, labels, and other components connect to one another. Also, a location for applying
a relationship.
connectivity
Linkage between items that relate because of their graphics, like a valve and a pipe run. Proper
connectivity must exist to confirm valid data integrity.
connector
Item with multiple vertices; behavior of a connector relies on the two items that it connects.
data dictionary
The underlying data model of a plant, consisting of database entries and select lists. SmartPlant
Data Dictionary Manager maintains this information.
data model
Application items that populate a project. Typical items in a data model are components, lines,
and labels.
database
Collection of files of comprehensive information that have predefined structure and organization;
a specific program can communicate, interpret, or process these files.
database administrator
The technical support person who assigns user IDs and data access permissions, creates new
databases, removes databases no longer in use, and monitors disk storage usage of the
database and performance.
database link
A pointer that defines a one-way communication path from an Oracle database server to
another database server. This pointer is stored in the local database and identifies the remote
database, a communication path to that database, and optionally, a user name and password. In
connected Workshare, the database link is used to access the remote database, providing the
satellite a view into the plant schema at the host site.
database table
Part of the database consisting of rows and columns and containing information about the
project and design elements.
design file
File containing graphics and text data, also called a drawing file.

Glossary
design-wide break
A region of the drawing within which a single property value is defined for all the included
components. Indicating the region, a closed shape exists, along with an accompanying label that
shows the property value.
display-only annotation
Feature that allows you to generate temporary annotation graphics for review without placing the
graphics in a design file.
drawing file
File that contains graphical items; also called a design file.
drawing, P&ID
Graphics file that contains data about one unit. Each drawing has a unique drawing number
within the unit to which the drawing belongs.
driving label
Graphics, text, or both with their own properties that are placed on the P&ID to define property
values of the components and groups to which they apply.
easting
Term used in plane surveying that describes an east, or positive, difference in longitude.
edge-edge model
A model that represents connectivity entirely by edges.
enumerated list
See select list.
equipment components
Items associated with pieces of equipment, such as nozzles and trays.
equipment group
A single-name equipment body and any items within or attached to the body, such as a tray or
nozzle.
exclusive database relationship
Relationship that exists between any given item and the parent item to which it belongs, for
example, an instrument can belong only to one loop at a time.
exit elevation
Lowest downstream elevation point on the internal diameter of a pipe.
filter
Function that creates a subset of items. This subset meets criteria that property values define.

Glossary
fixed point
A control point that usually is a locally known monument with known coordinates.
flow rate
Quantity of fluid that flows per unit of time.
flow time
Required time for the flow, from the start of the piped system, to reach a downstream point.
full path name
Name of the entire path or directory hierarchy to a file, including the filename. See also relative
path name and UNC path.
gap
Condition that exists when two lines intersect graphically on the P&ID but not physically in the
plant.
hierarchical
An ordered relationship from greatest to least; refers to the relationships among groups,
components, and labels.
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, for grouping
files or commands.
horizontal angle
Angle measured in the horizontal plane. Horizontal angles are the basic measurements needed
to determine bearings and azimuths.
horizontal distance
Distance between two points computed using only the northing and easting coordinates of the
points.
host
A computer that acts as the controlling source of information. In SmartPlant P&ID Workshare, a
site that controls satellites.
implied piping component
Piping components that the software creates in the alphanumeric database; these components
are not represented graphically.
inline
Term used to refer to those piping or instrument components that have been inserted in a piping
segment.

Glossary
inline instruments
Components that have been inserted in a piping segment. Inline instruments include instrument
valves, such as butterfly valves and temperature regulator valves, and other instrument
components, such as orifice plates and flow controllers.
instance
A single allocation of an item class.
instrument loops
A group of one or more instruments or control functions arranged so that signals can pass from
one function to the next for the purpose of measuring and controlling a process variable. In
SmartPlant P&ID, you can create instrument loops containing any combination of inline and
offline instruments.
instruments
Devices that directly or indirectly measure or control a variable in a plant process, such as flow
or temperature. Instruments can be devices such as final control elements, computing devices,
or electrical switches. Two types of instruments exist: inline instruments and offline instruments.
interference checking
Process that identifies possible collisions or insufficient clearance between items in a drawing.
isometric
Relating to or concerning a drafting system characterized by three equal axes at right angles; a
view in which the horizontal lines of an item are drawn at an angle to the horizontal and all
verticals are projected at an angle from the base.
item
Unit of storage within a larger unit, such as a file in a catalog; a single member in a drawing.
item type
Distinct objects that users can manipulate in SmartPlant P&ID, such as equipment, events, and
safety classes.
keypoint
A point on an item, including vertices, which is used to connect to the item.
label
A graphic representation that reflects the status or condition of an associated item.
line route
Collection of ordered line runs, gaps, and components that all share the same attribution. A line
route contains line runs, components, gaps, and properties; however, a line route does not
contain any branches.
line style
Collection of formats or properties that you name and store as a group to apply as a style of a
line.

Glossary
loop
Software structure that allows a specified sequence of instructions to run repeatedly, if the
stated conditions remain constant.
macro
A sequence of actions or commands that can be named and stored. When you run the macro,
the software performs the actions or runs the commands. You can create the macros in Visual
Basic or other OLE-aware programming applications. Some of the OLE-aware programming
applications are VBA, Visual C++ Delphi, Visual Basic, and so forth.
model
A representation of graphics or a schema; collection of all items and their relationships to create
a coherent description of a process plant.
model file
A design file or database file that defines the 2-D or 3-D geometry and connectivity of a
structure.
MTO
Material take-off; also called a Bill of Materials.
net service alias
(Oracle) An alternative name for a directory naming object in a directory server. A directory
server stores net service aliases for any defined net service name or database service.
net service name
(Oracle) A simple name for a service that resolves to a connect descriptor. Users initiate a
connect request by passing a username and password along with a net service name in a
connect string for the service to which they wish to connect: CONNECT
username/password@net_service_name.
network
Interconnection of host computers and workstations that allows them to share data and control.
The term has a dual meaning: network can refer to the devices that connect the system, or
network can refer to the connected system.
node name
A name or alias that you can assign to the node address of a device on a network.
northing
Term used to describe a north coordinate location in the plant coordinate system.
nozzle
A special equipment item that contains the connection point to piping.
offline
Term that refers to those instrument components that are not inserted in a pipe run.

Glossary
offline instruments
Components that are not inserted in a piping segment. Typically, these components are the
instruments that monitor and control inline instruments. Offline instruments include temperature
regulators, level gauges, and system functions, such as digital control stations (DCS) or
computers.
Oracle Net
Communication software that enables a network session from a client application to an Oracle
database server. Once a network session is established, Oracle Net acts as a data courier for
the client application and the database server. It is responsible for establishing and maintaining
the connection between the client application and database server, as well as exchanging
messages between them. Oracle Net is able to perform these jobs because it is located on each
computer in the network.
Oracle Net Manager
A graphical user interface tool that provides an integrated environment for configuring and
managing Oracle Net Services.
ORACLE_HOME
An alternate name for the top directory in the Oracle directory hierarchy on some
directory-based operating systems.
orthogonal view
A view that is a projection of the drawing onto a plane along lines that are orthogonal to the
plane.
P&ID
See Piping and Instrumentation Diagram.
parameter
A property with a value that determines the characteristics or behavior of an item.
parametric item
Item that contains geometry constrained together using relationships, with driving dimensions
that are defined as adjustable parameters.
path name
Sequence of directories leading to a file. See also relative path name.
peak flow
Maximum flow rate of water through a specific size pipe.
PFD
Process Flow Diagram; a drawing that serves as a start for a P&ID.
pipe run
A line run that has piping properties. Also, a contiguous set of pipe run segments separated only
by inline components, branch points and gap components. A pipe run has a beginning and an

Glossary
end. It does not branch or contain spaces between components. A pipe run segment may have
identical properties as a pipe run from which it branches but is not considered part of the pipe
run.
pipeline
Set of connected piping segments and their associated piping items. Also, the collection of pipe
runs from all drawings in a project whose project-defined line property values are identical.
Piping and Instrumentation Diagram (P&ID)
A primary drawing for maintaining a plant. The P&ID includes three primary groups of items:
equipment, piping, and instrumentation. The drawing relates critical process-related information,
such as process conditions for temperatures and pressures, and identifies physical components
in the plant. The P&ID is the basis for both the construction of the physical plant and further
specification of instrumentation components.
piping components
Graphic elements that represent processes or functions within a particular piping segment.
Piping components include valves, flanges, reducers, strainers, and safety components. In
drawings, piping components are connected with multiple line segments.
Piping Materials Class (PMC)
Classification of components by service or specification - for example, a 150-pound carbon steel
specification.
piping network
Series of connected pipe runs and inline components. A network terminates at a nozzle,
off-page connector, utility connector, or one-point piping component - for example, a pipe cap.
piping segment
A line string with two or more vertices that defines the centerline geometry of the pipe run and
contains the non-graphic data associated with the pipe run.
plant
A group of facilities and equipment that performs one or more material processing functions
within a given geographical area. One company can have several plants located at different
geographical locations.
plant group items
The building blocks, such as site, plant, unit, area, and level, used to create plant breakdown
structures or plant structure hierarchies.
plant structure
Represents the business structure or physical hierarchy of a plant.
process line
Ordered collection of connectors and inline components with an equal set of core properties -
typically, items with the same line number. Specifically, a representation of the piping that
transfers process fluid.

Glossary
process point
A tool that defines the operating conditions at a particular place during a process. Examples
include defining temperature, density, and flow rate.
project
1. A directory file created in an application environment that contains design files and
subprojects. A project is not necessarily specific to an application; the project may contain
design files from multiple applications.
2. Term used for convenient grouping of either all or part of the items that constitute a plant.
Several projects can be under design at one time, probably in separate geographical
locations and having limited communication among them.
projection lines
Witness lines; lines extending from the boundaries of an item and between which dimensioning
data for the area marked by the projection lines is placed.
property
A unique characteristic of an object, item, symbol, or document.
The properties of an item can include display properties and properties stored with the item. For
example, the properties of a valve symbol can include display properties such as color, line
style, and width. Other properties stored with the valve symbol can include the manufacturer,
cost, or material. Properties stored with the valve symbol are displayed in the Properties window
when the valve symbol is selected.
publish
To release a P&ID drawing for subscription or distribution.
publishing method
To publish a P&ID drawing using either the database link or the file sharing means of
transferring data.
reference data
A collection of information containing facts relative to industry design codes, catalog data of
vendors, job specifications, commodity libraries, graphics symbology, label descriptions, report
formats, and other information of a similar theme.
reference file
A drawing file attached to another drawing file for reviewing reference; a graphic representation
attached to a drawing view.
Relational Database Management System (RDBMS)
A database management system that uses Structured Query Language (SQL) to implement and
query data in relational tables.
relationship
A condition that exists between items indicating some form of communication of behavior or
state.

Glossary
relative path name

Sequence of directories leading from the current directory to a particular file. See also path
name.
report template
An online outline for a new report that you need to define. You can select a user-level or a
project-level template to create a new report template.
required item
Item that the plant model needs. An item is required if the Tag Required Flag property is set to
True for the item in the Properties window of Catalog Manager.
revision cloud
A set or arcs used to enclose changes that have occurred since the last revision.
revision triangle
A numbered triangle placed in the P&ID to indicate the drawing revision when the change
occurred.
rule
Standard mechanism for creating relationships. A rule defines a valid context for two items to
communicate their behavior or state.
satellite
A server located remotely from the host server. In SmartPlant P&ID Workshare, a remote server
connected to a satellite slot at the host server.
satellite slot
The host's side of a Workshare connection. Satellites connect to the satellite slots made
available by the host at the host site.
schema
Description of the overall structure of the rulebase or database.
schema file
File that outlines the overall logical structure of a rulebase or database.
schematic file
Schematic drawing or diagram of a particular item in the plant.
search criteria
Set of values used to scan a database or object library.

Glossary
segment
Contiguous piping and piping components between two points in the network at which properties
change value. Segments terminate by property break labels, branches, nozzles, off-pace and
utility connectors, and by the terminal ends of piping lines.
select list
List of related values that Data Dictionary Manager uses to specify various aspects of the data
model. For example, select lists allow you to select from a list of values for specific properties
when creating drawings, filters, and symbols. A select list for the fluid code property, for
example, allows you to select from a set of standard entries: such as P for process or MMA for
methyl alcohol.
server
In network operations, the node that maintains common data or performs a common task that
clients need. All network operations between two or more nodes establish a client/server
relationship.
signal lines
1. Intelligent line strings that connect offline instruments, inline instruments, and piping.
2. An ordered collection of connectors, and inline components with an equal set of core
properties: typically, items that share the same line number. Specifically, a representation of
the wiring used for transferring electrical or software signals.
3. A collection of signal runs from all drawings in a project whose project-defined line property
values are identical.
signal run
A line run with signal properties. See also pipe run.
site
A group of plants. A site can contain one or more plants.
site server
A text file containing the database type, connection alias, data dictionary, and schema
information for the site. Appears as the root directory for each site in SmartPlant Engineering
Manager.
SP_IDs
Unique identification numbers assigned by the SmartPlant software to all items created in the
database.
Standard Query Language (SQL)
Language developed by IBM for creating, modifying, and querying relational databases.
static Oracle port
A network configuration that forces an Oracle database link to always connect via a fixed path to
a fixed port number.

Glossary
stockpile
View of the data model, displaying items that have not yet been placed in the graphic model.
style
1. The appearance of geometry and annotations on the drawing sheet. For example, color and
line weight of an element, the font used in a text box, and so forth.
2. A collection of formats or properties that you name and store as a group. When you apply a
style to a selected item, the software applies all the formats or properties in the style to the
element. The style types include: fill, dimension, line, and text.
subnet
A division of a network into an interconnected, but independent, segment, or domain, in order to
improve performance and security.
subnet mask
The technique used by the IP protocol to filter messages into a particular network segment. The
subnet mask is a binary pattern that is stored in the client machine, server, or router and is
matched up with the incoming IP address to determine whether to accept or reject the packet.
subscribe
To sign up for a service. In SmartPlant P&ID Workshare, to connect a satellite site with a
satellite slot at the host.
subscribe access
Read-only access to published P&ID drawings.
symbology
1. Display style of an item, including color, pattern, style, and width.
2. In Options Manager, symbology provides graphical clarity to a drawing by differentiating
among various items by their appearance. Symbology refers to the color, line weight, and
style associated with items in a particular filter.
table
Collection of data for quick reference, either stored in sequential locations in memory or printed
as an array of rows and columns of data items of the same type.
template
A document or file having a preset format, used as a starting point or blueprint for a particular
application so that the format does not have to be re-created each time it is used. In SmartPlant
P&ID, a file used to create a drawing with a set of default parameters; a template serves as an
outline or blueprint for you to create a new drawing. In SmartPlant Engineering Manager, a file
used to create roles, data dictionaries or other database schemas.
time stamping
A process that prompts the software to generate a record when you change a property.

Glossary
transaction
A non-graphic record of any additions, deletions, and changes that you request during job
posting activities.
UNC path
Universal Naming Convention. The full name of a resource on a network. It conforms to the
\\servername\sharename syntax, where servername is the name of the server and sharename is
the name of the shared resource. UNC names of directories or files can also include the
directory path under the share name, with the following syntax:
\\servername\sharename\directory\filename.
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.
user name
Name that provides access to an account on the system. Same as username.
validation
A process or program that verifies data integrity in the database.

Index
Associate Hydraulic Circuits with an Item •
A 155
About SmartPlant P&ID Engineering attribute • 377
Command (Help Menu) • 16 AutoFilter Command • 37
Access a Recently Open Drawing • 90 AutoGap Command (Tools Menu) • 177
Access the SmartPlant Foundation Web
Client • 332 B
Accessing the SmartPlant Foundation Web
Client • 331 backup • 377
Actions Menu (Engineering Data Editor) • Batch Copy Item Properties Using Plant
49 Editing • 46
Activate Symbol Toolbars • 65 batch processing • 377
Active Window List • 35 Batch Replace Units of Measure Using
Add a Button to a Toolbar • 29 Plant Editing • 47
Add a Command to a Menu • 79 Boolean operator • 377
Add a Shortcut Button to the Catalog branch point • 377
Explorer Navigation Bar • 67 break label • 377
Add an Item to the Stockpile from Catalog Browse Dialog Box • 24
Explorer • 61 Browser Command (SmartPlant Menu) •
Add Button Command • 67 332
Add Instruments to a Loop • 142
Adding Design Elements • 152 C
Additional Documentation • 15 cache • 377
Advanced Publish Options Dialog Box • 343 Calling Item Tag Validation • 144
Advanced View Properties Dialog Box • 52 Cascade Command • 35
alias • 377 catalog • 377
annotations • 377 Catalog Explorer Command (View >
Apply a Display Set • 184 Display Menu) • 60
Apply Display Set Command (View Menu) • Catalog Explorer Find Dialog Box • 62
180 Catalog Index • 275
Apply Display Set Dialog Box • 181 Catalog Menu • 61
archive • 377 Change Printer Properties • 255
Asking Filters Dialog Box • 186 Change the Properties of a Drawing View •
Assign a Command to a Catalog Explorer 33
Toolbar Button • 68 check in • 378
Assign a Commodity Code to a Piping Check Symbol Paths • 187
Component Using the Piping Claim a Drawing Item • 194
Specification Utility • 141 Claim Command • 50, 194
Assign a Jacketed Heat Trace to an Item • Claim Dialog Box • 194
136 Claim Status Command • 51, 198
Assign a Piping Materials Class to a Pipe Claiming Items • 192
Run Using the Piping Specification Utility Claims Tab • 32
• 140 class • 378
Assign an Insulation Specification • 169 Clean Data Dialog Box • 80
Assign Drawing Dialog Box • 367 Clear Display Set Command (View Menu) •
Assign Heat Tracing to an Item • 132 180
Assigning Heat Tracing and Jacketing • 124 client • 378
Associate an Item with a Plant Group • 72 client/server database • 378

Index
Close an Active Drawing • 94 Controlling Access • 195

Close Command • 65 Copy an Item • 165
Close Command (File Menu) • 93 Copy Bulk Properties • 73
Close the Catalog Explorer Window • 61 Copy Command • 50
Close the Program • 94 Copy Command (Edit Menu) • 165
code list • 378 Copying Items • 165
collaboration • 378 Correlate Command (SmartPlant Menu) •
Colors Tab • 23 353
column • 378 Correlate Dialog Box • 354
commodity code • 378 Correlate Pipe Runs with Streams • 353
commodity item • 378 Correlation • 351
commodity option • 378 Create a New Blank Report Template • 235
Compare and Refresh Command (Tools Create a New Heat Tracing Medium • 126
Menu) • 201 Create a New Jacketed Property for Pipe
Compare and Refresh Dialog Box • 201 Runs • 135
Compare and Refresh Dialog Box Create a New Menu • 80
Properties Window Toolbar • 205 Create a New Pump by Importing a
Compare and Refresh Drawing Versions • SmartPlant P&ID Report into the
206 Stockpile • 173
Compare and Refresh Examples • 208 Create a New Toolbar • 29
Compare Options Dialog Box • 205 Create a Report Template Based on an
Compare With Dialog Box • 201 Existing Template • 236
Compare with Published Version Command Create a Select Set from a Line • 166
(SmartPlant Menu) • 345 Create an Assembly • 188
Comparing and Refreshing Versions • 199 Create Tab • 369
Comparing Code Lists and Select Lists • Create the Plug-in • 325
372 Create Typical Command (Edit Menu) • 175
Comparing Consistency Check to Creating and Editing Report Templates •
Propagation • 372 229
Comparing Graphics and Text in PDS 2D Custom AutoFilter Dialog Box • 37
and SmartPlant P&ID • 374 Custom Button Dialog Box • 79
Comparing SmartPlant P&ID with PDS • Custom Commands Command • 80
371 Customize Command (Tools Menu) • 75
Comparing System Editing to Propagation • Customize Current View Dialog Box • 88
373 Customize Dialog Box • 75
component • 378 Customize the Catalog Explorer List View •
Composite Format Report • 233 66
concentric • 378 Customize the Display of the Engineering
Configuration (QuickPick) Tool • 122 Data Editor • 36
Configuration File Settings for AutoCAD Customize the Open Dialog Box • 89
Translation • 97 Customize the Properties Window • 71
Configuration File Settings for MicroStation Customize the Software with the Options
Translation • 106 Command • 24
configuration files • 379 Customizing Catalog Explorer • 68
connect point • 379 Customizing the Display of the Engineering
connectivity • 379 Data Editor • 36
connector • 379 Customizing the Software • 74
Consistency Check Command (Edit Menu) • Cut Command (Edit Menu) • 163
212
Consistency Check Dialog Box • 212 D
Consistency Checking • 211
Consistency Criteria Tab (Consistency data dictionary • 379
Check Dialog Box) • 215

Index
Data File Command (File > Import Menu) • Delete to Stockpile > Drawing Command
221 (Edit Menu) • 164
data model • 379 Delete to Stockpile > Plant Command (Edit
database • 379 Menu) • 164
database administrator • 379 Delete to Stockpile Commands (Edit Menu)
database link • 379 • 164
database table • 379 Delete View Command • 58
Default Table Layouts • 54 Delete View Dialog Box • 58
Defer Tasks from the To Do List • 361 Description Dialog Box • 168
Define a Display Set • 183 design file • 379
Define a New Engineering Data Editor View Designing Symbol Toolbars • 63
• 55 design-wide break • 380
Define a New Filter for an Engineering Data Details Command • 66
Editor View • 55 Details Dialog Box • 198
Define a New Layout for the Engineering Details Tab • 369
Data Editor • 56 Display > Engineering Data Editor
Define a User-Level Symbol Toolbar • 63 Command (View Menu) • 47
Define Command • 240 Display Claim Status in the Drawing
Define Filtering by Task Assignment for the Symbology • 199
To Do List • 359 Display Command (View Menu) • 28
Define Heat Trace Media as Pipe Jacketing Display Deleted To Do List Tasks • 361
• 133 Display Help for Programming with
Define Heat Tracing Graphics for an Item • SmartPlant P&ID Engineering • 16
127 Display Ignored To Do List Tasks • 363
Define Jacketing Graphics for an Item • 134 Display Null Values in the Properties
Define Locate Filter Dialog Box • 124 Window • 73
Define Mapping Relationships as 'For Display Properties with Units Using an
Documentation Only' • 282 Alternative Format • 246
Define Report Contents Dialog Box • 241 Display Settings Dialog Box • 39
Define Report Items Dialog Box • 242 Display Shortcut Buttons in Catalog
Define the Contents of Your Report Explorer • 68
Template • 243 Display Tab • 30
Define the Layout of a Composite Format Display the Claim Status of a Drawing Item
Report Template • 234 • 199
Define the Layout of a Fixed Format Report Display the Engineering Data Editor • 49
Template • 233 Display the Properties of a Report Template
Define the Layout of a Tabular Format • 239
Report Template • 231 display-only annotation • 380
Defining Test System Relationships • 155 Drawing • 275
Delete a Catalog Item • 64 drawing file • 380
Delete a Catalog Node • 64 drawing, P&ID • 380
Delete a Report Template • 239 driving label • 380
Delete a Saved Engineering Data Editor
View • 58 E
Delete Command • 239
Delete Command (Catalog Explorer > easting • 380
Catalog Menu) • 64 edge-edge model • 380
Delete from Model Command (Edit Menu) • Edit a Report Template • 238
164 Edit Active Drawing Item Properties in the
Delete Orphan Model Items • 82 Engineering Data Editor • 42
Delete Orphan Model Items Dialog Box • 81 Edit Command • 237
Delete Report Template Dialog Box • 239 Edit Menu (Engineering Data Editor) • 50
Delete Stockpile Item Command • 49 Edit Report Template Dialog Box • 237

Index
Edit the Engineering Data Editor View • 41 Fit All Items in the Active Drawing View • 27
Edit View Command • 51 Fit Command (View Menu) • 27
Edit View Dialog Box • 51 Fixed Format Report • 233
Editing Item Properties in the Engineering fixed point • 381
Data Editor • 40 flow rate • 381
EFCustomProcess Reference • 326 flow time • 381
Enable System Editing • 180 Freeze Panes Command • 39
Enforcing Claims • 195 full path name • 381
Engineering Data Editor Shortcut Menu • 59
enumerated list • 380 G
Equipment • 275
equipment components • 380 gap • 381
equipment group • 380 Gap Now Command (Tools Menu) • 177
Equivalent Diameter and Cross Section Gapping Lines • 177
Area Properties • 167 General Tab • 22, 30, 91, 368
Example of Completed with Warning Status Generate a Report for an Active Drawing •
• 358 224
exclusive database relationship • 380 Generate a Report for the Plant • 225
Exit Command (File Menu) • 94 Generate Reports for Selected Drawings •
exit elevation • 380 226
Explore Elsewhere Dialog Box • 62 Generating Reports • 223
Grid Tab • 31
F
H
File Properties Dialog Box • 91
Files Tab • 24 hierarchical • 381
filter • 380 Hierarchical Enumerated Lists • 274
Filter / Sort Dialog Box • 367 hierarchy • 381
Filter Dialog Box • 88 History Tab • 369
Filter Tab • 52, 243, 367 Hold Status Text Dialog Box • 168
Filter To Do List Tasks • 360 horizontal angle • 381
Find a Drawing Item by Using a Catalog horizontal distance • 381
Item • 159 host • 381
Find an Item by Using a Filter • 159
Find an Item by Using an Existing Drawing I
Item • 160 IEFCustomPublish Interface • 326
Find and Replace Dialog Box • 161 IEFCustomPublishEventHandler Interface •
Find Command • 61, 158 329
Find Documents to Publish Command Ignore Task Properties • 363
(SmartPlant Menu) • 345 Ignore To Do List Tasks • 361
Find Documents to Publish Dialog Box • Implementation (IEFCustomPublish) • 330
345 implied piping component • 381
Find Documents to Publish dialog box - Import > SmartSketch Command (File
Document Types • 346 Menu) • 221
Find Documents to Publish from SmartPlant Import Aspen Basic Engineering Stream
P&ID • 344 Data • 222
Find Drawing Inconsistencies • 158 Import Log Dialog Box • 221
Find Redundant Breaks • 219 Importing Aspen Basic Engineering Stream
Find Redundant Breaks Command (View Data • 221
Menu) • 219 Importing Drawing Data • 221
Find Tab (Find and Replace Dialog Box) • Improve the Performance of Custom
161 Reports • 229
Finding Drawing Items • 158

Index
Inconsistencies Tab (Consistency Check Methods (IEFCustomPublishEventHandler

Dialog Box) • 213 Interface) • 329
Inconsistency Indicators Tab • 32 Mirror Command (Edit Menu) • 163
inline • 381 model • 383
inline instruments • 382 model file • 383
Insert > Image Command (Edit Menu) • 187 Modify Pump Properties by Importing a
Insert > Object Command (Edit Menu) • 187 SmartPlant P&ID Report • 167
instance • 382 Modify the Offset Distance of Heat Trace
Instrument • 276 Lines • 128
instrument loops • 382 Modify the Properties of an Existing
instruments • 382 Engineering Data Editor View • 57
Insulation Spec Dialog Box • 169 Modify To Do List Task Properties • 357
interference checking • 382 Modifying Item Properties • 167
isometric • 382 Modifying Items in SmartPlant P&ID
Issue Request Documents from SmartPlant Engineering • 156
P&ID • 338 Modifying Properties • 195
Issue Request Tab (Publish Dialog Box) • Move a Connector to Another Stockpile •
343 150
item • 382 Move a Partner Connector to Another
Item Tag Validation Scope • 146 Stockpile • 151
item type • 382 Move a Stockpile Item to the Stockpile of
Another Drawing • 171
K Move Command (Edit Menu) • 158
Move Partner OPC Command (Connector
keypoint • 382 Shortcut Menu) • 151
Move Partner OPC Dialog Box • 151
L Move to Different Stockpile Command • 50
label • 382 Move to Different Stockpile Dialog Box •
Labeling • 147 171
Large Icons Command • 66 Move to Drawing Command (Edit Menu) •
Layout Tab • 53 158
line route • 382 Move to Primary Command (Edit Menu) •
line style • 382 176
Linking and Embedding Objects • 186 Move to Typical Command (Edit Menu) •
Links Command (Edit Menu) • 187 176
List Command • 66 Moving Between Stockpiles • 196
loop • 383 Moving Stockpile Items • 170
Loop Tag Dialog Box • 142 MTO • 383
My Reports Command (Reports Menu) •
228
M My Reports Dialog Box • 228
macro • 383
Map Properties Command • 248
MapClass • 266
N
MapEnum • 269 Navigating in the Engineering Data Editor •
MapEnumList • 268 35
MapProperty • 267 Navigating in the Properties Window • 69
MapUoM • 271 Navigating in the Software • 17
MapUoMList • 270 Navigation Menu • 66
Menu Tab • 76 Navigation Menu (Catalog Explorer) • 66
Methods (IEFCustomPublish Interface) • net service alias • 383
327 net service name • 383
network • 383

Index
New > Drawing Window Command Performing Commodity Code and

(Windows Menu) • 34 Fabrication Category Look Up • 138
New > Engineering Data Editor Command Performing Service Limits Validation • 138
(Window Menu) • 34 PFD • 384
New Command • 63, 234 pipe run • 384
New Command (Window Menu) • 34 pipeline • 385
New Items Dialog Box • 241 PipeLine • 277
New Report Template Dialog Box • 235 PipeRun • 276
New Toolbar Dialog Box • 28 Piping and Instrumentation Diagram (P&ID)
node name • 383 • 385
northing • 383 piping components • 385
Note Text Dialog Box • 170 Piping Materials Class (PMC) • 385
nozzle • 383 piping network • 385
piping segment • 385
O Piping Specifications Dialog Box • 140
Place a Contract Package • 156
offline • 383 Place a Hydro Test Package • 154
offline instruments • 384 Place a Package • 152
Open a Continuation Drawing • 152 Place a Safety Class • 153
Open a Drawing in a Different Database • Place a Test System • 153
89 Place Multiple Representation Command •
Open a New Drawing View • 34 49
Open an Existing Drawing • 89 Placement Tab • 23
Open Command • 63 plant • 385
Open Command (File Menu) • 86 Plant Editing • 43
Open Continuation Drawing Command plant group items • 385
(OPC Shortcut Menu) • 152 Plant Reports Command (Reports Menu) •
Open Dialog Box • 86 227
Open Plant Structure Dialog Box • 87 Plant Reports Dialog Box • 227
Open the To Do List • 356 plant structure • 385
Options Command • 245 Polygon Fence Locate Command • 121
Options Command (Tools Menu) • 22 Polygon Fence Ribbon • 121
Options Dialog Box • 22 Populate the Stockpile from a Spreadsheet
Oracle Net • 384 • 173
Oracle Net Manager • 384 Pre-Publishing Automation from SmartPlant
ORACLE_HOME • 384 P&ID • 325
orthogonal view • 384 Previous Command (View Menu) • 25
Print a Drawing • 252
P Print a Selected Area • 253
P&ID • 384 Print a Typical View • 176
Page Setup Command (File Menu) • 255 Print Command (File Menu) • 250
Pan a Drawing View • 27 Print Dialog Box • 250
Pan Command (View Menu) • 27 Print to a File • 255
parameter • 384 Printable Guides Command (Help Menu) •
parametric item • 384 15
Paste Bulk Properties • 73 Printing Drawings • 249
Paste Command • 50 process line • 385
Paste Command (Edit Menu) • 164 process point • 386
Paste Special Command (Edit Menu) • 164 project • 386
path name • 384 projection lines • 386
peak flow • 384 Properties (IEFCustomPublish Interface) •
Perform Manual Correlation • 362 327
Perform Plant Editing • 43 Properties Command (File Menu) • 90

Index
Properties Command (View Menu) • 29 Remove the Correlation Between Pipe

Properties Tab • 242 Runs and Streams • 353
Properties Window Command (View Menu) Rename a Catalog Node • 64
• 70 Rename Command • 64
Properties Window Toolbar • 70 Repair OPCs Dialog Box • 81
property • 386 Replace Command (Edit Menu) • 160
Property Conversions • 272 Replace Mode Command (Tools Menu) •
Publish • 386 160
Publish a Report • 336 Replace Tab (Find and Replace Dialog
Publish Command (SmartPlant Menu) • 339 Box) • 162
Publish Dialog Box • 339 Report Options Dialog Box • 245
Publish Documents from SmartPlant P&ID • Report Properties Dialog Box • 237
335 report template • 387
Publish Tab (Publish Dialog Box) • 341 required item • 387
Publish the 'OwnsComponentOcc' Relation Resolve an Inconsistency • 218
• 284 Restore a Customized Toolbar to Its Default
Publish with Instrument Expansion • 278 Settings • 29
Publish Workflows • 336 Restore a Drawing View • 25
Publishing Documents • 332 Restore All Built-In Menus to their Original
Publishing from SmartPlant P&ID - Work Settings • 80
Process • 334 Retrieve Command (SmartPlant Menu) •
publishing method • 386 350
Retrieve Dialog Box • 350
Q Retrieve Documents to SmartPlant P&ID •
349
Query Results Dialog Box • 48 Retrieve Expanded Instruments • 281
Retrieving Documents • 347
R Retrieving to SmartPlant P&ID - Work
Recent Drawings Command (File Menu) • Process • 349
90 Review an Inconsistency • 217
Re-create a Drawing • 117 Review and Edit Item Properties • 72
Re-creating Drawings • 115 Revising Documents • 346
reference data • 386 revision cloud • 387
reference file • 386 Revision Text Dialog Box • 170
Refresh Command • 59 revision triangle • 387
Refresh Symbol Toolbar Command Rotate Command (Edit Menu) • 163
(Catalog Explorer > Catalog Menu) • 65 rule • 387
Registering Tools • 331 Run a Macro • 83
Relational Database Management System Run Tasks from the To Do List • 357
(RDBMS) • 386
relationship • 386 S
relative path name • 387 Sample Implementation
Release a Claim • 197 (IEFCustomPublish) • 330
Release Claim Command • 51, 197 satellite • 387
Release Claim Dialog Box • 197 satellite slot • 387
Remove a Button from a Toolbar • 29 Save a Drawing as a PDF File • 114
Remove a Command from a Menu • 79 Save a Drawing in a Different Format • 95
Remove a Shortcut Button from the Catalog Save an Engineering Data Editor View • 58
Explorer Navigation Bar • 68 Save as Assembly Command (File Menu) •
Remove an Instrument from a Loop • 143 188
Remove Button Command • 67 Save As Command (File Menu) • 114
Remove Tasks from the To Do List • 361 Save As Dialog Box • 114

Index
Save as PDF Command (File Menu) • 114 signal lines • 388

Save as PDF Dialog Box • 115 signal run • 388
Save Command (File Menu) • 95 site • 388
Save View Command • 57 site server • 388
Save View Dialog Box • 57 Small Icons Command • 66
Saving Drawings • 94 SmartPlant P&ID Engineering • 13
schema • 387 SmartPlant P&ID Engineering Help
schema file • 387 Command (Help Menu) • 15
schematic file • 387 SmartPlant P&ID Example
search criteria • 387 Define Mapping to Publish Variable
Search for an Item in Catalog Explorer • 62 Frequency Drives • 311
segment • 388 Mapping a New Complex Property
Select a Polygon-Shaped Area of a Starting in the Tool • 297
Drawing • 124 Mapping a New String Property Starting
Select a View • 175 in the Tool • 290
Select All Command • 50 Mapping Equipment Classes to Publish
Select All Command (Edit Menu) • 164 Process Data • 307
Select Alternative Format for Display Dialog Mapping New Enumerated List Entries
Box • 246 Starting in the SmartPlant Schema •
Select an Item • 122 314
Select an Item Using the Configuration SmartPlant P&ID Mapping Examples • 290
(QuickPick) Tool • 123 SmartPlant P&ID Program Group • 14
Select Associated Item Command (Edit SmartPlant P&ID Technical User Forum
Menu) • 160 Command (Help Menu) • 16
Select Catalog Item Dialog Box • 163 SmartPlant Reports Toolbar • 240
Select Connected Items Command (Edit Software (IEFCustomPublish Interface) •
Menu) • 165 326
Select Connected Items Dialog Box • 166 Software (IEFCustomPublishEventHandler
Select Hydraulic Circuits Dialog Box • 155 Interface) • 329
select list • 388 Sort Tab • 243, 367
Select Tool Command • 121 Sort To Do List Tasks • 361
Select Tool Ribbon • 121 SP_IDs • 388
Selecting Connected Items • 165 Special SmartPlant P&ID Mapping
Selecting Drawing Items • 120 Procedures • 277
Send to Drawing Stockpile Command • 65 Standard Query Language (SQL) • 388
Send to Stockpile Command • 65 static Oracle port • 388
server • 388 Statistics Tab • 92
Set Document Properties • 93 stockpile • 389
Set Print Options • 253 Stream Number Dialog Box • 170
Setting Construction Status • 372 style • 389
Settings Dialog Box • 251 subnet • 389
Show Both Command (View Menu) • 176 subnet mask • 389
Show Brief Properties • 73 subscribe • 389
Show Buttons Command • 68 subscribe access • 389
Show Case Data • 74 Summary Tab • 92
Show Claims Command (View Menu) • 199 Suppress Generation of Tasks on Retrieve •
Show Command • 22 286
Show Inconsistencies • 212 Switch to Another Open Drawing or View •
Show Inconsistencies Command (View 90
Menu) • 212 symbology • 389
Show Primary Command (View Menu) • System Editing • 177
176 System Editing and Changing Property
Show Typical Command (View Menu) • 176 Values Across OPCs • 150

Index
System Editing and Consistency Checking • Undo Your Last Action • 157
179 unit • 390
System Editing and Projects • 180 Units Tab • 92
System Editing Command (Tools Menu) • Update Associated Instruments with Loop
180 Properties Dialog Box • 143
Update Symbology Command (Tools Menu)
T • 186
Update Tab • 370
table • 389 Update the Engineering Data Editor • 59
Tabular Format Report • 231 Update the To Do List Display • 363
Task Properties Dialog Box • 368 Upgrade Schema Command (SmartPlant
template • 389 Menu) • 262
The SmartPlant Adapter and Tool Schema • Use AutoFilter in the Engineering Data
262 Editor • 38
The Tool Schema Data Model • 265 user name • 390
Tile Horizontally Command (Window Menu) Using Catalog Explorer • 59
• 35 Using Filters • 118
Tile Vertically Command (Window Menu) • Using Filters to Create and Apply Display
35 Sets • 180
time stamping • 389 Using Implied Items • 144
To / From Dialog Box (Properties Window) • Using Off-Page and Utility Connectors • 148
150 Using Piping Components • 137
To Do List and Correlating Items • 196 Using Reports to Import Items into the
To Do List Command • 364 Stockpile • 172
To Do List Dialog Box • 364 Using Shortcut Keys • 18
To Do List Task Commands and Controls • Using the Piping Specification Utility • 137
364 Using the To Do List • 355
Tool Requirements for Integrating
SmartPlant P&ID • 258
Tool Schema Location • 265 V
Toolbars Command (View Menu) • 28 Validating Properties • 196
Toolbars Dialog Box • 28 validation • 390
Toolbars Tab • 78 View > Display Settings Command (EDE) •
transaction • 390 39
Troubleshooting • 375 View Document Properties • 93
Turn the Display of Catalog Explorer On or View Menu • 25, 65
Off • 60 View Menu (Engineering Data Editor) • 51
Turn the Display of the Properties Window View Properties Dialog Box • 30
On or Off • 71
Typicals • 174 W
Typicals Common Tasks • 174
Window Menu • 33
Working with Assemblies • 187
U Working with Drawings • 85
UNC path • 390 Working with Drawings in Projects • 191
Uncorrelate Command (SmartPlant Menu) • Working with Instruments and Loops • 141
355 Working with Off-Site Projects • 192
Uncorrelate Dialog Box • 355 Working with P&IDs in SmartPlant P&ID
Uncorrelate Items • 354 Engineering • 119
Uncorrelate Items from the To Do List • 362 Working with SmartPlant Integration • 257
Understanding Database Constraints • 119 Working with the Design Window • 20
Understanding System Editing and OPCs • Working with the Properties Window • 69
149
Undo Command (Edit Menu) • 157

Index
Z
Zoom Area Command • 25
Zoom In • 26
Zoom In Command • 26
Zoom In on an Area • 25
Zoom Out • 26
Zoom Out Command • 26

Schem SPPID Engineering

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Schem SPPID Engineering

Încărcat de

Drepturi de autor:

Formate disponibile

SmartPlant P&ID Engineering

Version 2014 R1 (7.1)

U.S. Government Restricted Rights Legend

2 SmartPlant P&ID Engineering User's Guide

SmartPlant P&ID Engineering User's Guide 3

Navigating in the Software ....................................................................................................................... 17

Working with Drawings ............................................................................................................................. 85

SmartPlant P&ID Engineering User's Guide 5

Open a Drawing in a Different Database........................................................................................ 89

Working with P&IDs in SmartPlant P&ID Engineering ........................................................................ 119

6 SmartPlant P&ID Engineering User's Guide

Working with Instruments and Loops .................................................................................................. 141

SmartPlant P&ID Engineering User's Guide 7

System Editing .................................................................................................................................... 177

Working with Drawings in Projects ....................................................................................................... 191

Consistency Checking ............................................................................................................................ 211

8 SmartPlant P&ID Engineering User's Guide

Importing Drawing Data .......................................................................................................................... 221

Generating Reports ................................................................................................................................. 223

Printing Drawings .................................................................................................................................... 249

Working with SmartPlant Integration .................................................................................................... 257

SmartPlant P&ID Engineering User's Guide 9

Property Conversions ................................................................................................................... 272

10 SmartPlant P&ID Engineering User's Guide

Uncorrelate Items ......................................................................................................................... 354

Comparing SmartPlant P&ID with PDS ................................................................................................. 371

Troubleshooting ...................................................................................................................................... 375

Glossary ................................................................................................................................................... 377

Index ......................................................................................................................................................... 391

SmartPlant P&ID Engineering User's Guide 11

12 SmartPlant P&ID Engineering User's Guide

SmartPlant P&ID Engineering

SmartPlant P&ID Engineering User's Guide 13

 Paste Command (Edit Menu)

SmartPlant P&ID Program Group

14 SmartPlant P&ID Engineering User's Guide

SmartPlant P&ID Engineering allows you to view

SmartPlant P&ID Drawing Manager allows you to create

SmartPlant P&ID Insulation Specification Manager

SmartPlant P&ID Options Manager defines plant-wide

SmartPlant P&ID Rule Manager defines rules for

SmartPlant Engineering Manager performs higher-level data management tasks, such as

Printable Guides Command (Help Menu)

SmartPlant P&ID Engineering User's Guide 15

SmartPlant P&ID Technical User Forum Command (Help

About SmartPlant P&ID Engineering Command (Help Menu)

Display Help for Programming with SmartPlant P&ID

16 SmartPlant P&ID Engineering User's Guide

Navigating in the Software

Engineering Data Editor

SmartPlant P&ID Engineering User's Guide 17

Using Shortcut Keys

Start the Add Button command A

Start the Remove Button command R

Turn the Show Buttons command on or S

Find dialog box in Catalog Explorer

Select in the Named list ALT + N

Select the Close button ALT + C

Select the Look In box ALT + L

Select the Find Now button ALT + I

Select the Stop button ALT + P

Select the New Search button ALT + W

Select the Browse button ALT + B

Browse for Folder dialog box in Catalog Explorer