SmartPlant Instrumentation

User’s Guide

Version 2007.6 (8.0) January 2009 DINS-08.00.0001G

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

Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth 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
Huntsville, Alabama 35894-0001

Warranties and Liabilities

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

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartSketch, FrameWorks, INtools, MARIAN, and IntelliShip
are registered trademarks and SupportModeler and SupportManager are trademarks of Intergraph Corporation.
Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark
of Bentley Systems, Inc. ISOGEN and SPOOLGEN are registered trademarks of Alias Limited. Other brands and
product names are trademarks of their respective owners.
 Preface

Table of Contents
Preface...............................................................................................................................44

Working with SmartPlant Instrumentation: An Overview .........................................45

User Assistance................................................................................................................. 46
Online Help Text Conventions ...................................................................................48
Getting Started Common Tasks..................................................................................50
Start SmartPlant Instrumentation ...................................................................................... 50
Navigating in SmartPlant Instrumentation........................................................................ 51
Open a Different Domain.................................................................................................. 52
Change the Logon Password............................................................................................. 52
Switch to a Different Unit................................................................................................. 53
Open a Module.................................................................................................................. 53
Setting General Preferences Common Tasks .............................................................54
Display and Customize Preferences.................................................................................. 54
Preferences Governed by the .INI File.............................................................................. 55
Preferences Dialog Box .................................................................................................... 56
General (Preferences)........................................................................................................ 57
Copy File Locations Dialog Box ...................................................................................... 59
Instrument Index > New Tag (Preferences)...................................................................... 59
Instrument Index > New Loop (Preferences).................................................................... 60
Instrument Index > Profile (Preferences).......................................................................... 61
Instrument Index > Browse (Preferences) ........................................................................ 62
Instrument Index > Duplicate (Preferences) ..................................................................... 62
Instrument Index > Delete Tag (Preferences) ................................................................... 64
Instrument Index > Rename (Preferences)........................................................................ 64
Instrument Index > Tag Properties (Preferences) ............................................................. 66
Instrument Index > Move (Preferences) ........................................................................... 66
Instrument Index > Custom (Preferences) ........................................................................ 66
Specifications > General (Preferences)............................................................................. 67
Specifications > Multi-Tag Specifications (Preferences) ................................................. 69
Specifications > Save as Excel (Preferences) ................................................................... 71
Specifications > Export/Import (Preferences)................................................................... 71
Specifications > Custom (Preferences) ............................................................................. 72
Wiring > General (Preferences) ........................................................................................ 72
Wiring > I/O Cards (Preferences) ..................................................................................... 73
Wiring > I/O Assignment (Preferences) ........................................................................... 73
Wiring > CS Tags (Preferences) ....................................................................................... 74
Wiring > Copy Items (Preferences) .................................................................................. 75
Wiring > Jumpers (Preferences) ....................................................................................... 76
Wiring > Reports (Preferences) ........................................................................................ 77
Wiring > Cross Wiring (Preferences) ............................................................................... 78
Wiring > Custom (Preferences) ........................................................................................ 78
Process Data > General (Preferences)............................................................................... 79
Process Data > Custom (Preferences)............................................................................... 80
Calculation > General (Preferences) ................................................................................. 80
Calibration and Maintenance > Custom (Preferences) ..................................................... 81

SmartPlant Instrumentation User’s Guide 3

Preface

Loop Drawings > General (Preferences) .......................................................................... 81

Loop Drawings > CAD File Locations (Preferences)....................................................... 84
Loop Drawings > Custom (Preferences)........................................................................... 85
Browser > Reports (Preferences) ...................................................................................... 85
Browser > Fonts (Preferences).......................................................................................... 86
Browser > Custom (Preferences) ...................................................................................... 86
Hook-Ups > General (Preferences)................................................................................... 87
Hook-Ups > CAD File Locations (Preferences) ............................................................... 89
Hook-Ups > Reports (Preferences)................................................................................... 91
Hook-Ups > Custom (Preferences)................................................................................... 92
Document Binder > General (Preferences)....................................................................... 92
Document Binder > Specification Binder (Preferences)................................................... 93
Document Binder > General Document Binder (Preferences) ......................................... 94
Document Binder > Custom (Preferences) ....................................................................... 94
Calibration and Maintenance > General (Preferences) ..................................................... 94
Calculation > Custom (Preferences) ................................................................................. 96
Enhanced Reports > General (Preferences) ...................................................................... 96
Enhanced Reports > Layers (Preferences) ........................................................................ 98
Enhanced SmartLoop > View (Preferences)..................................................................... 98
Panel-Strip > View (Preferences) ................................................................................... 100
Wiring Equipment Connections > View (Preferences)................................................... 102
Segment Wiring > View (Preferences) ........................................................................... 103
Communication Line > View (Preferences) ................................................................... 104
Internal Cross Wiring > View (Preferences)................................................................... 105
Fieldbus Loop > View (Preferences) .............................................................................. 106
Network Class > View (Preferences).............................................................................. 108
Strip Signals > View (Preferences)................................................................................. 109
Single Speaker > View (Preferences) ............................................................................. 110
Enhanced PA Amplifier > View (Preferences)............................................................... 111
Cable Block Diagram > View (Preferences)................................................................... 112
Enhanced Reports > Hook-Ups > View (Preferences) ................................................... 112
Panel-Signals > View (Preferences) ............................................................................... 113
Symbol Editor > View (Preferences) .............................................................................. 114
Enhanced Reports > Custom (Preferences) .................................................................... 114
Enhanced Reports > Drawing (Preferences)................................................................... 115
Enhanced Reports > File Locations (Preferences).......................................................... 116
Enhanced Reports > File Locations (continued) (Preferences)....................................... 117
Enhanced Reports > Fonts (Preferences) ........................................................................ 118
Enhanced Reports > Title Block (Preferences)............................................................... 118
Enhanced Reports > Connectors (Preferences)............................................................... 120
Enhanced Reports > Pagination and Revisions (Preferences) ........................................ 121
Interfaces > DCS Vendors (Preferences) ........................................................................ 121
SmartPlant Integration > General (Preferences) ............................................................. 122
SmartPlant Integration > To Do List (Preferences) ........................................................ 122
Claim and Merge Options (Preferences)......................................................................... 123
Report Generator (Preferences) ...................................................................................... 126
SmartPlant Instrumentation Server (Preferences)........................................................... 127
Module Icons (Preferences) ............................................................................................ 127

4 SmartPlant Instrumentation User’s Guide

 Preface

Searching for Tag and Loop Numbers: An Overview................................................129

Searching for Tag and Loop Numbers Common Tasks ...........................................130
Search for All Tag Numbers ........................................................................................... 131
Use Search Parameters to Find Tag Numbers ................................................................ 132
Search for Typical Tags .................................................................................................. 134
Search for All Loop Numbers......................................................................................... 134
Use Search Parameters to Find Loop Numbers .............................................................. 135
Search for Typical Loops................................................................................................ 136

Supporting Tables: An Overview .................................................................................138

Supporting Tables Common Tasks...........................................................................139
Supporting Tables in SmartPlant Instrumentation .......................................................... 139
Supporting Tables for Telecom ...................................................................................... 147
Add a New Value to a Select List ................................................................................... 148
Customize Manufacturer-Specific Field Headers ........................................................... 148
Manage a Custom Table ................................................................................................. 149

SmartPlant Instrumentation Interface Languages: An Overview............................150

Interface Languages Common Tasks........................................................................152
Replace the Interface Language with a Language from the Database ............................ 152
Replace the Interface Language with a Language from an External File ....................... 153
Translate Interface Text Phrases ..................................................................................... 154
Prefixes and Suffixes in the Interface Text..................................................................... 157

Revision Management: An Overview...........................................................................158

Global Revisions: An Overview....................................................................................159

Revision Management Common Tasks ....................................................................160
Filter Items for Global Revisions.................................................................................... 162
Add Global Revisions ..................................................................................................... 163
Define Settings for Upgrading Revisions ....................................................................... 164
Update Revisions Globally ............................................................................................. 165
Upgrade Revisions Globally ........................................................................................... 166
Revision Upgrade Example ............................................................................................ 167
Delete Global Revisions ................................................................................................. 167
Add Local Revisions....................................................................................................... 168
Edit Local Revisions ....................................................................................................... 170
Delete Local Revisions ................................................................................................... 171
View an Archived Revision ............................................................................................ 171
Report Comparison: An Overview ...........................................................................172
Setting Font and Color for Report Comparison........................................................173
Set Font And Color for Report Comparison ................................................................... 173
Comparing Archived Reports ...................................................................................174
Compare the Currently Previewed Report With an Archived Report............................. 174
Comparing the Current Report with an Archived Report.........................................175
Compare the Currently Previewed Report With an Archived Report............................. 175

SmartPlant Instrumentation User’s Guide 5

Preface

Viewing Archived Reports ..............................................................................................176

View an Archived Report ............................................................................................... 176
Displaying Changed Documents ..............................................................................177
Display a List of Changed Documents ........................................................................... 177
Workflow..................................................................................................................178
Workflow Prerequisites ............................................................................................179
Create a Workflow Browser ........................................................................................... 180
Implementing Workflow ..........................................................................................181
Enter Initial Instrument Data .......................................................................................... 181
Enter Process Data for Instrument Tags ......................................................................... 181
Enter Additional Instrument Data ................................................................................... 182
Process Data Statuses ...............................................................................................183
Printing and Saving Documents: An Overview........................................................184
Previewing Documents.............................................................................................185
Preview a Document ....................................................................................................... 185
Printing Documents ..................................................................................................187
Print Documents ............................................................................................................. 187
Batch Printing Documents to PDF Files...................................................................188
Modifying Printer Settings .......................................................................................189
Saving Documents ....................................................................................................190
Save the Current Document to a File .............................................................................. 190
Saving in DXF Format..............................................................................................191
Save a Document in DXF Format................................................................................... 191
Editing Document Headers.......................................................................................193
Edit the Headers for a Report.......................................................................................... 193

Claiming As-Built Items for a Project: An Overview.................................................194

Preparing Project Items for Merging with As-Built: An Overview..........................196

Claiming and Merging Items Common Tasks..........................................................198
Display As-Built and Project Data.................................................................................. 199
Copy As-Built Items to the Claim Buffer ....................................................................... 200
Claim As-Built Items from the Domain Explorer........................................................... 201
Claim Instruments in the Browser or Instrument Index Module .................................... 202
Claim Loops, Lines, and Equipment in the Browser Module......................................... 203
Copy Items to the Merge Buffer as Merge Now............................................................. 203
Copy Items to the Merge Buffer as Release Claim......................................................... 204

SmartPlant Instrumentation Explorer: An Overview................................................206

Working with the Domain Explorer: An Overview....................................................207

Domain Explorer Common Tasks ............................................................................209
The Organization of Items in the Domain Explorer Tree View...................................... 212
Panels by Category Hierarchy Examples........................................................................ 215
Panels by Location Hierarchy Example.......................................................................... 217
Cable Hierarchy Example ............................................................................................... 218
Fieldbus Segments in the Domain Explorer ................................................................... 218

6 SmartPlant Instrumentation User’s Guide

 Preface

Items in the Drawing Block Types Folder ...................................................................... 218

Items in the Electrical Equipment Folder ....................................................................... 220
Items in the Hook-Ups Folder......................................................................................... 220
Items in the Loops Folder ............................................................................................... 222
Association Rules in the Domain Explorer ..............................................................225
Item Status Indicators in the Domain Explorer............................................................... 229
Create an Item in the Domain Explorer .......................................................................... 230
Duplicate an Item............................................................................................................ 230
Move an Item in the Domain Explorer ........................................................................... 231
Edit Item Properties ........................................................................................................ 231
Delete Items .................................................................................................................... 231
Perform Various Actions with an Instrument ................................................................. 232
Generate a Report for an Instrument............................................................................... 232
Generate a Specification or a Process Data Sheet for an Instrument .............................. 232
Copy a Reference Item to the Domain Explorer............................................................. 233
Search for Items in SmartPlant Instrumentation Explorer .............................................. 233
Find an Item in the Tree View of an Explorer Window ................................................. 234
Filter the Display of Items According to a Specific Item Name..................................... 235
Filter the Display of Items According to a Specific Item Type ...................................... 236
Filter Cables in an Explorer Window ............................................................................. 238
Define a Filter for Pre-Assigned Device Cables ............................................................. 239
Filter Loops in an Explorer Window .............................................................................. 240
Display a Browser View in the Explorer Items Pane...................................................... 242
Add Items to My List in the Items Pane ......................................................................... 242
Define and Use a Custom View...................................................................................... 243

Working with the Reference Explorer: An Overview ................................................244

Reference Explorer Common Tasks.........................................................................245
The Organization of Items in the Reference Explorer Tree View .................................. 248
Items in the Hook-Up Item Libraries Folder .................................................................. 249
Create a Reference Item.................................................................................................. 251
Create a Reference I/O Card ........................................................................................... 251
Create a Reference Wiring Equipment Item ................................................................... 254
Create a Reference I/O Termination ............................................................................... 255
Copy a Reference Item to the Domain Explorer............................................................. 257

Instrument Index Module: An Overview ....................................................................258

Managing Loop Numbers: An Overview.....................................................................259

Managing Loop Numbers Common Tasks...............................................................260
Create a New Individual Loop Number.......................................................................... 262
Loop Number Naming Convention ................................................................................ 263
Duplicate a Loop Number............................................................................................... 263
Move Loop Numbers ...................................................................................................... 265
Edit Loop Number Properties from the Domain Explorer.............................................. 266
Edit Loop Properties from the Instrument Index Module............................................... 267
Edit Multiple Loop Numbers .......................................................................................... 269
Create a Loop Number When Editing a Tag................................................................... 270
Customize New Loop Numbers...................................................................................... 271

SmartPlant Instrumentation User’s Guide 7

Preface

Delete Loop Numbers ..................................................................................................... 272

Rename A Single Loop Number..................................................................................... 273
Set Preference for Renaming A CAD File from A Loop Number.................................. 274
Rename Multiple Loop Numbers.................................................................................... 274
Define a Functional Requirement for a Loop ................................................................. 275

Working with Instrument Types: An Overview .........................................................276

Instrument Types Common Tasks ............................................................................277
Define an Instrument Type ............................................................................................. 278
Define a General Process Function................................................................................. 279
Define an Instrument Type Profile ................................................................................. 279
Define a Wiring and Controls System Instrument Type Profile ..................................... 280
Copy Instrument Type Profile Data ................................................................................ 281
Set an Alias Control System Tag .................................................................................... 282
Apply All Existing Profiles............................................................................................. 283

Managing Instrument Tags: An Overview..................................................................284

Instrument Tag Naming Convention .............................................................................. 284
Working with Tag Numbers Common Tasks...........................................................285
Create an Instrument in the Domain Explorer ................................................................ 287
Create an Instrument Tag in the Instrument Index Module ............................................ 289
Edit an Instrument Tag from the Domain Explorer ........................................................ 290
Edit Instrument Tags from the Instrument Index............................................................ 291
Customize Tag Name...................................................................................................... 292
Change the Tag Class of an Instrument .......................................................................... 292
Enter Power Supply Data for Panels and Instrument Tags ............................................. 293
Enter an Instrument Tag Remark .................................................................................... 294
Duplicate an Instrument Tag in the Domain Explorer .................................................... 295
Duplicate an Instrument Tag in the Instrument Index .................................................... 296
Delete Instrument Tags ................................................................................................... 297
Delete Instrument Tags in the Instrument Index Module ............................................... 297
Delete Instrument Tags in the Browse Window ............................................................. 298
Move an Instrument Tag to Another Plant Group .......................................................... 298
Move Multiple Instrument Tags in the Browser Window .............................................. 299
Rename an Instrument Tag ............................................................................................. 299
Instrument Tag Renaming Options ................................................................................. 301
Changing the Measured Variable .............................................................................302
Change an Instrument Type ............................................................................................ 302
Associating Tag Category and Criticality.................................................................304
Add and Edit Criticality Values ...................................................................................... 304
Add and Edit Instrument Tag Categories........................................................................ 305
Associate Tag Category and Criticality .......................................................................... 305
Generate a Process Data Sheet in a Browser Window.................................................... 306
Incorporating Soft Tags Within an Enhanced Loop Drawing ..................................307
Flow of Activities for Managing Soft Tags..............................................................308
Set a Default Custom Symbol for Items Associated with an Instrument Type .............. 309

8 SmartPlant Instrumentation User’s Guide

 Preface

Associating Instrument Tags with Loop Numbers: An Overview ............................310

Associating Instrument Tags with Loop Numbers Common Tasks .........................311
Associate Multiple Tag Numbers with a Loop ............................................................... 311
Change an Instrument Tag Loop Association in the Domain Explorer .......................... 312
Change Instrument Tag Loop Associations in the Instrument Index Standard
Browser View ................................................................................................................. 313
Associate an Instrument Tag with a New Loop.............................................................. 313
Dissociate an Instrument Tag from Loops...................................................................... 314

Working with Typical Loops and Tags: An Overview...............................................315

Typical Loops and Tags Common Tasks .................................................................316
Create a Typical Loop..................................................................................................... 318
Duplicate a Typical Loop................................................................................................ 319
Batch Loop Creation from Typical Loops ...................................................................... 321
Verify New Loop Numbers ............................................................................................ 322
Edit a Typical Loop ........................................................................................................ 322
Delete a Typical Loop..................................................................................................... 323
Edit a Typical Tag........................................................................................................... 324
Edit a Typical Tag in a Browser View............................................................................ 324
Typical Tag Naming Conventions .................................................................................. 325

Managing Lines: An Overview .....................................................................................326

Working with Lines Common Tasks........................................................................327
Create a New Line .......................................................................................................... 328
Edit Line Data ................................................................................................................. 328
Create or Edit a Line Type.............................................................................................. 328
Change Type of Line ...................................................................................................... 329
Copy Line Data ............................................................................................................... 330
Delete a Line ................................................................................................................... 330
Define or Modify Pipe Specifications............................................................................. 331

Editing Data in a Browser View: An Overview ..........................................................332

Edit and View Data Common Tasks ........................................................................333
Define a Standard Browser View for the Instrument Index............................................ 336
Edit a Single Row ........................................................................................................... 337
Open a Specific Supporting Table .................................................................................. 337
Find a Record in a Browser View Column ..................................................................... 338
Sort Tag Rows in a Browser View ................................................................................. 339
Edit Instrument Tag Data in Multi-Row Mode............................................................... 339
Count Instrument Tag Rows in a Browser View ............................................................ 340
View Point-to-Point Wiring Diagrams ........................................................................... 340
View Data History in a Browser View ........................................................................... 341
Set a Date Range for Field Value Changes..................................................................... 342
Track Field Value Changes............................................................................................. 342
Open a Process Data Sheet from the Browser Window.................................................. 343
Open a Specification Sheet from the Browser Window ................................................. 343
Open a Calculation Sheet from the Browser Window .................................................... 343
Display Existing Wiring Connections............................................................................. 344

SmartPlant Instrumentation User’s Guide 9

Preface

Open I/O Assignment from a Browser View.................................................................. 344

Change the Process Function and Instrument Type in Batch Mode ............................... 344

Generating Documents: An Overview .........................................................................346

Generating Documents Common Tasks ...................................................................347
Generate a Specification Sheet for an Instrument........................................................... 348
Generate a Process Data Sheet for an Instrument ........................................................... 349
Generate a Drawing and Revision Report....................................................................... 349
Create a List of Available Tags ...................................................................................... 350
Generate Loop Summary Reports................................................................................... 350
Generate Custom Table Reports ..................................................................................... 351

Working with External Documents: An Overview.....................................................352

Managing External Documents Common Tasks ......................................................353
Associate an External Document with Instrument Tags ................................................. 354
Open an External Document Associated with an Instrument Tag .................................. 354
Dissociate an External Document from an Instrument Tag ............................................ 354
View Associated Documents .......................................................................................... 355

Process Data Module .....................................................................................................356

Process Data Principles.............................................................................................357
Starting the Process Data Module.............................................................................358
Start the Process Data Module........................................................................................ 358
Working With Instrument Tags in the Process Data Module...................................359
Create an Instrument Tag in the Process Data Module................................................... 359
Open an Instrument Tag in the Process Data Module .................................................... 359
Define Basic Process Data for an Instrument Tag .......................................................... 360
Editing Instrument Process Data ..............................................................................361
Edit Instrument Process Data.......................................................................................... 361
Modifying Instrument Base Conditions....................................................................362
Modify Base Conditions for an Instrument Tag ............................................................. 362
Copying Instrument Process Data from Another Instrument ...................................364
Copy Instrument Process Data From Another Instrument.............................................. 364
Propagating Line Process Data to an Instrument Tag ..............................................365
Propagate Process Data From the Current Line to the Current Instrument .................... 365
Propagate Process Data From Any Line to the Current Instrument................................ 365
Batch Propagation of Line Data to Instrument Tags ................................................366
Propagate Line Data to a Batch of Instrument Tags ....................................................... 366
Setting the Line-to-Tag Filter ...................................................................................367
Select Line Properties ..................................................................................................... 367
Process Data for Differential Pressure Instruments..................................................368
Define Process Data for a Differential Pressure Instrument ........................................... 368
Deleting Instrument Process Data ............................................................................369
Delete an Instrument Process Data Sheet ....................................................................... 369
Calculating Physical Properties ................................................................................370
Calculate the Properties of a Selected Material .............................................................. 370
Adding a New Line Type .........................................................................................371
Add a Line Type ............................................................................................................. 371

10 SmartPlant Instrumentation User’s Guide

 Preface

Editing a Line Type ..................................................................................................372

Edit a Line Type ............................................................................................................. 372
Changing the Line Type ...........................................................................................373
Change the Type of a Selected Line ............................................................................... 373
Deleting a Line Type ................................................................................................374
Delete a Line Type.......................................................................................................... 374
Adding a New Line...................................................................................................375
Add a New Line .............................................................................................................. 375
Modifying Line Properties........................................................................................376
Modify Line Properties ................................................................................................... 376
Duplicate a Line.............................................................................................................. 376
Defining Line Process Data ......................................................................................378
Define Line Process Data................................................................................................ 378
Viewing Line Process Data ......................................................................................379
View Line Process Data.................................................................................................. 379
Editing Line Process Data - Selecting Pipe Standards .............................................380
Editing Line Process Data - Fluid.............................................................................381
Copying Line Data from One Line to Another.........................................................382
Copy Line Data From One Line to Another ................................................................... 382
Deleting Line Process Data ......................................................................................383
Delete Line Process Data ................................................................................................ 383
Line Fluid Velocity...................................................................................................384
Multiple Process Data Cases ....................................................................................385
Creating Process Data Cases ....................................................................................386
Enable Cases for the Current Tag Or Line...................................................................... 386
Add a Case for the Current Tag Or Line......................................................................... 386
Setting a Governing Case .........................................................................................388
Set a Governing Case...................................................................................................... 388
Managing the Cases Supporting Table .....................................................................389
Manage the Cases Supporting Table............................................................................... 389
Deleting a Process Data Case ...................................................................................390
Delete a Process Data Case............................................................................................. 390
Process Analyzers.....................................................................................................391
Flow of Activities for Complex Analyzers...............................................................392
Managing Line Component Tables ..........................................................................393
Manage the Fluid Components Supporting Table .......................................................... 393
Create A Line Components Table For The Current Line ............................................... 393
Defining a Complex Analyzer ..................................................................................394
Define a Complex Analyzer............................................................................................ 394
Linking Analyzer Stream Components with Line Components...............................395
Link Analyzer Stream Components With Line Components ......................................... 395
Adding an Insulation Type .......................................................................................396
Add a New Insulation Type ............................................................................................ 396
Entering and Editing a Pipe or Orifice Material.......................................................397
Edit Or Enter Additional Pipe/Orifice Materials ............................................................ 397
Defining or Modifying Pipe Specs ...........................................................................398
Create a New Pipe Spec Or Modify an Existing One ..................................................... 398

SmartPlant Instrumentation User’s Guide 11

Preface

Deleting Pipe Specs ..................................................................................................399

Delete a Pipe Spec .......................................................................................................... 399
Setting the Default Units of Measure .......................................................................400
Set the Default Units of Measure.................................................................................... 400
API 2540 Standard for Liquid Density Calculation .................................................401
Calculate Liquid Density According to the API 2540 Standard ..................................... 401
Converting Engineering Units of Measure Automatically .......................................402
Convert Engineering Units Automatically...................................................................... 402
Copying Default Units of Measure from Another <Unit> .......................................403
Copy Default Units of Measure From Another <Unit>.................................................. 403
Importing Process Data Files....................................................................................404
Import Instrument Process Data Files............................................................................. 404
Import Line Process Data Files....................................................................................... 404
Exporting Process Data Files....................................................................................406
Export Instrument Process Data Files............................................................................. 406
Export Line Process Data Files....................................................................................... 406
Principles of Generating Process Data Reports ........................................................408
Generating a Process Data Report for One Instrument or Line................................409
Generate a Process Data Report for the Current Instrument Or Line ............................. 409
Generating Line Reports...........................................................................................410
Generate Line Reports .................................................................................................... 410
Generating Instrument Reports.................................................................................411
Generate Instrument Reports .......................................................................................... 411
Viewing and Editing Process Data Revisions ..........................................................412
Working with External Revisions.............................................................................413
Work With External Process Data Revisions ................................................................. 413
Viewing Process Data History..................................................................................415
View Process Data History ............................................................................................. 415

Calculation Module: An Overview...............................................................................417

Starting the Calculation Module...............................................................................418
Start the Calculation Module .......................................................................................... 418
Viewing and Editing a Calculation Item ..................................................................419
Open a Process Data Sheet for Calculation .................................................................... 419
Fluid Definition ........................................................................................................420
Define the Fluid .............................................................................................................. 420
Performing Calculations ...........................................................................................422
Preparing for Flowmeter Calculation .......................................................................423
Prepare for Flowmeter Calculation ................................................................................. 423
Orifice Flowmeter Calculation .................................................................................424
Calculate Orifice Flowmeter Parameters ........................................................................ 424
Tube Flowmeter Calculation ....................................................................................426
Calculate Tube Flowmeter Parameters ........................................................................... 426
Restriction Device Calculation .................................................................................428
Calculate the Restriction Device Parameters .................................................................. 428
Calculating a Relief Valve........................................................................................430
Calculate a Relief Valve ................................................................................................. 430

12 SmartPlant Instrumentation User’s Guide

 Preface

Calculating a Relief Valve in Case of Fire ...............................................................432

Size a Relief Valve in Case of Fire ................................................................................. 432
Calculating a Control Valve .....................................................................................433
Calculate a Control Valve............................................................................................... 433
Calculating a Thermowell.........................................................................................436
Calculate the Maximum Permissible Thermowell Length.............................................. 436
Performing a Batch Calculation................................................................................437
Perform a Batch Calculation ........................................................................................... 437
Calculating Multiple Cases.......................................................................................439
Calculate Multiple Cases ................................................................................................ 439
Creating a Hybrid Case.............................................................................................440
Create A Hybrid Case ..................................................................................................... 440
Principles of Generating Calculation Item Reports ..................................................441
Generating Calculation Item Reports .......................................................................442
Generate a Calculation Item Report................................................................................ 442
Calculation Revisions ...............................................................................................443
Maintain Calculation Revisions...................................................................................... 443
Creating New Tags in the Calculation Module ........................................................445
Create a New Tag in the Calculation Module................................................................. 445
Recommended Control Valve Characteristic ...........................................................446
Calculate the Recommended Control Valve Characteristic............................................ 446
Entering Built-Up Back Pressure - Relief Valve......................................................447
Take Built-Up Back Pressure Into the Calculation Account .......................................... 447

Specifications: An Overview .........................................................................................448

Principles of Generating Specifications....................................................................449
Specification General Operations Common Tasks...................................................451
Define Specification Options in an Instrument Type Profile.......................................... 452
Generate Instrument Specs in Batch Mode..................................................................... 453
Open a Spec from the Instrument Index Standard Browser View .................................. 454
Open a Spec from the Specifications Module................................................................. 454
Create a Tag Number in the Specifications Module ....................................................... 455
Add Expanded Notes and Remarks ................................................................................ 456
Delete Specs in Batch Mode ........................................................................................... 456
Ways of Defining a Spec Document Number................................................................. 457

Specification Pages: An Overview................................................................................458

Managing Spec Pages Common Tasks.....................................................................459
Open a Page .................................................................................................................... 461
Open a Page from an External File ................................................................................. 462
Display Data Field Names .............................................................................................. 463
Display a List of Forms that Include the Current Page................................................... 463
Regenerate a Specification Page ..................................................................................... 463
Regenerate Pages in Batch Mode ................................................................................... 464
Save a Page to the Database............................................................................................ 464
Save a Page as an External File ...................................................................................... 465
Delete a Page .................................................................................................................. 465
Create a Large Note Page ............................................................................................... 466

SmartPlant Instrumentation User’s Guide 13

Preface

Select a Different Process Function for a Page............................................................... 467

Set the Tab Order of the Fields on a Page....................................................................... 468
Switch to the Default Tab Order ..................................................................................... 469
Retrieve Custom Pages as PSR Files .............................................................................. 469
Requirements for Creating User-Defined Views ............................................................ 470
Associate User-Defined Views ....................................................................................... 471
Working with Page Graphics Common Tasks..........................................................472
Add a Line to a Page....................................................................................................... 473
Set Precise Position and Length of a Line ...................................................................... 474
Modify Line Position and Length Using Arrow Keys .................................................... 474
Modify Line Position and Length Using the Mouse....................................................... 475
Change Line Properties................................................................................................... 475
Duplicate Page Lines ...................................................................................................... 476
Add Graphics to a Page................................................................................................... 476
Set Precise Position and Size of Page Objects................................................................ 478
Modify Position and Size of Page Objects Using the Mouse ......................................... 478
Modify Position and Size of Page Objects Using Arrow Keys ...................................... 479

Specification Page Customization: An Overview........................................................480

Customizing Pages in the Page Editor Common Tasks............................................481
Edit Field Headers .......................................................................................................... 483
Display Invisible Fields .................................................................................................. 484
Define Fields with Computed Values ............................................................................. 484
Display Revision Changes for Spec Properties............................................................... 485
Format Field Values........................................................................................................ 486
Add Data Fields to a Page............................................................................................... 487
Duplicate Data Fields in a Page ...................................................................................... 488
Delete Data Fields........................................................................................................... 488
Add Custom Fields of Wiring Equipment Items ............................................................ 488
Add Function Block Custom Fields to a Fieldbus Spec ................................................. 489

Spec Forms: An Overview.............................................................................................491

Spec Forms Common Tasks .....................................................................................492
Create a Form.................................................................................................................. 494
Edit Form Properties ....................................................................................................... 495
Add Pages to an Existing Form ...................................................................................... 495
Remove a Page from a Form .......................................................................................... 496
Sort Pages Within Forms ................................................................................................ 497
Display a List of Pages Included in a Form .................................................................... 497
Delete a Form.................................................................................................................. 498
Restore Library Forms .................................................................................................... 498
Regenerate Library Forms .............................................................................................. 499
Change the Form Assignment of a Spec......................................................................... 499
Change Form Assignment for a Batch of Specs ............................................................. 499
Define Form Browser Fields........................................................................................... 500
Define a Multi-Form Browser ........................................................................................ 501

14 SmartPlant Instrumentation User’s Guide

 Preface

Form Data Templates: An Overview....................................................................503

Form Data Template Common Tasks.......................................................................504
Create and Modify a Form Data Template ..................................................................... 504
Delete a Form Data Template ......................................................................................... 505

Single-Tag Specs: An Overview....................................................................................507

Single-Tag Specs Common Tasks ............................................................................508
Generate a Single-Tag Spec............................................................................................ 508
Notes for Editing a Single-Tag Spec .............................................................................. 510
Edit Manufacturers and Models in a Spec ...................................................................... 510
Move a Single-Tag Spec to a Multi-Tag Spec................................................................ 511
Generate a Spec for a Complex Analyzer....................................................................... 512

Process Data Case Specs: An Overview.......................................................................513

Process Data Case Specifications Common Tasks...................................................514
Generate a Spec for Multiple Process Data Cases .......................................................... 514
Generate a Hybrid Case Spec ......................................................................................... 515

Multi-Tag Specs: An Overview.....................................................................................517

Multi-Tag Specs Common Tasks .............................................................................518
Generate a Multi-Tag Spec ............................................................................................. 520
Add a Single Instrument Tag to a Multi-Tag Spec ......................................................... 521
Add Instrument Tags to a Multi-Tag Spec in Batch Mode............................................. 522
Edit See List Data in a Multi-Tag Spec .......................................................................... 522
Change the Master Tag Definition.................................................................................. 523
Search for a Specific Tag in a Multi-Tag Spec............................................................... 523
Change the Font Size of See List Column Headers ........................................................ 524
Move a Tag to Another See List ..................................................................................... 524
Move a Tag from See List to a Single-Tag Spec ............................................................ 525
Remove a Tag from a Multi-Tag Spec............................................................................ 526
Generate a Spec for an Analyzer Stream ........................................................................ 526

Multi-Tag Spec Formats: An Overview.......................................................................528

Formats Common Tasks ...........................................................................................529
Create a Format............................................................................................................... 530
Modify a Format ............................................................................................................. 531
Delete a Format............................................................................................................... 532
Regenerate Formats ........................................................................................................ 533
Change the Format for a Multi-Tag Spec ....................................................................... 533
Define Multi-Tag Spec Print Layout .............................................................................. 533

Non-Instrument Specs: An Overview ..........................................................................535

Non-Instrument Specs Common Tasks ....................................................................536
Prerequisites for Generating a Non-Instrument Spec ..................................................... 536
Generate a Non-Instrument Spec .................................................................................... 537
Generate a Functional Requirement Spec....................................................................... 538

SmartPlant Instrumentation User’s Guide 15

Preface

Composite Specifications: An Overview......................................................................539

Composite Spec for Multiple Instruments: Generation Workflow ................................. 541
Composite Spec for Instrument with Cases: Generation Workflow............................... 542
Loop Composite Spec: Generation Workflow................................................................ 544
Remove an Instrument from a Composite Spec.............................................................. 545
Remove a Section from a Composite Page..................................................................... 546

Spec Title Blocks: An Overview ...................................................................................547

Title Block in a Multi-Tag Spec ..................................................................................... 548
Spec Title Block Common Tasks .............................................................................549
Customize a Title Block in InfoMaker ........................................................................... 550
Assign a Title Block to a Form ....................................................................................... 551
Modify a Custom Title Block ......................................................................................... 552
Update Custom Title Blocks After Version Upgrade ..................................................... 553

Copying Specification Data: An Overview ..................................................................554

Copying Specification Data Common Tasks............................................................555
Protect Fields from Overwriting When Copying Data ................................................... 555
Copy Data to a Form Data Template from a Spec .......................................................... 556
Copy Data to a Spec from a Form Data Template .......................................................... 557
Copy Data from One Spec to Another ............................................................................ 558

Spec Revisions: An Overview .......................................................................................560

Revision and Data Comparison Common Tasks ............................................................ 560
Manage Spec Revisions Locally ..................................................................................... 562
Manage Spec Revisions Globally ................................................................................... 563
View and Print Spec Revisions....................................................................................... 564
Compare Current Data with a Saved Revision ............................................................... 564
Compare Current Data with a Saved Spec...................................................................... 565
View Data History .......................................................................................................... 565
Change Storage Method of Specification Revisions....................................................... 566
Delete Spec Revisions..................................................................................................... 567

Save, Export, and Import Options: An Overview ......................................................568

Save, Export, and Import Options Common Tasks ..................................................569
Save a Spec in PSR Format ............................................................................................ 570
Save an Instrument Spec in ISF Format.......................................................................... 570
Save Instrument Specs in Batch Mode ........................................................................... 571
Save an Instrument Spec in Excel Format ...................................................................... 571
Batch Save of Instrument Specs in Excel Format........................................................... 572
Protect Fields Before Exporting Specs to External Editor.............................................. 572
Import Data to a Specification from an External File ..................................................... 573
Import Data to Instrument Specs in Batch Mode............................................................ 574

Save as Excel: An Overview..........................................................................................575

Customizing Specs for Save as Excel Common Tasks ............................................576
Guidelines for Customizing Pages for Save as Excel ..................................................... 578

16 SmartPlant Instrumentation User’s Guide

 Preface

Guidelines for Customizing PSR Files for Save as Excel .............................................. 579
Create an Invisible Vertical Zero Line............................................................................ 581
Replace Double Lines with Thick Single Lines.............................................................. 581
Correct a Line Discontinuity........................................................................................... 582
Correct Horizontal and Vertical Divergence of Grid Lines ............................................ 582
Set Value Display Precision for Save as Excel Globally................................................ 583
Set Value Display Precision for Individual Fields.......................................................... 583
Save as Excel Troubleshooting.................................................................................585
Resolve Spec Accessing Problem in a Common Excel File ........................................... 587
Remove the Protection from a Spec Saved as Excel ...................................................... 588
Resolve a Data Saving Problem...................................................................................... 588
Resolve Grid Line Overlap Problems ............................................................................. 588
Correct Undershooting and Overshooting of Grid Lines................................................ 589
Prevent Truncation of Labels and Values ....................................................................... 590
Fix Displaced Labels....................................................................................................... 590
Fix Text Display in Excel Cells ...................................................................................... 592
Fix Function Conversion Problems ................................................................................ 592
Set Value Display Precision............................................................................................ 593
Fix Display of Vertical Fields......................................................................................... 593
Fix Display of Select Lists.............................................................................................. 594
Prepare Problematic Excel Files for Intergraph Support ................................................ 594

Specification Report List...............................................................................................595

Printing Specifications and Reports Common Tasks ...............................................597
Print a Specification Report ............................................................................................ 598
Generate Reports by Date ............................................................................................... 598
Generate a Report for a Selected Field Name................................................................. 599
Assign User-Defined Headers for Spec Form Field Reports .......................................... 599
Print the Currently Open Specification........................................................................... 600
Print Specs into PDF Files .............................................................................................. 601

Pipe Specs: An Overview...............................................................................................602

Pipe Specs Common Tasks.......................................................................................603
Define or Modify Pipe Specs.......................................................................................... 604
Assign Pipe Specs to Instruments ................................................................................... 604
Assign Pipe Specs to Lines ............................................................................................. 605
Associate Pipe Specs with Sub-Libraries........................................................................ 605
Display Pipe Specs Assigned to a Hook-Up Item Sub-Library ...................................... 606
Dissociate a Pipe Spec from Lines.................................................................................. 607
Delete Pipe Specs............................................................................................................ 608

SmartPlant Instrumentation and InfoMaker..............................................................609

SmartPlant Instrumentation Database Structure.......................................................610
Enabling InfoMaker for SmartPlant Instrumentation Common Tasks.....................612
Create a SmartPlant Instrumentation Database Profile................................................... 612
Display SmartPlant Instrumentation Data Automatically............................................... 613
Display SmartPlant Instrumentation Data by Executing an SQL Statement .................. 614
Define InfoMaker As the Default Report Generator ...................................................... 614

SmartPlant Instrumentation User’s Guide 17

Preface

Working with Libraries and Reports Common Tasks ..............................................615

Create an InfoMaker Library .......................................................................................... 615
Create an InfoMaker Library and Report for Editing PSR Files .................................... 616
Open a PSR File from an InfoMaker Library and Report............................................... 617
Build a Query.................................................................................................................. 617
Calibration Form Customization: An Overview.......................................................620
Customizing Form Pages in InfoMaker Common Tasks .........................................621
General Procedures for All Form Page Types ................................................................ 621
Procedures for Calibration Form Pages .......................................................................... 622
Open a Form Page in InfoMaker .................................................................................... 623
Add a Unit of Measure Drop-Down Data Window in a PSR File .................................. 624
Add a Select List in a PSR File....................................................................................... 625
Add a Single-Use Column in a Calibration Form Page .................................................. 626
Add a Multi-Use Column in a Calibration Form Page ................................................... 627
Add an Expression for Field Protection.......................................................................... 627
Add an Expression for Background Color of Protected or Editable Field...................... 631
Add an Expression for Background Color of Result Field ............................................. 633
Add an Expression for Field Visibility ........................................................................... 634
Enable the Use of Fractions of an Inch ........................................................................... 635
Define a Computed Field for Calibration ....................................................................... 638
PSR File Viewer: An Overview ...............................................................................640
PSR File Viewer Common Tasks .............................................................................641
Open a PSR File From the PSR List ............................................................................... 642
Retrieve a Previously Saved PSR File ............................................................................ 642
Retrieve a Report from a PBL File ................................................................................. 642
Manage the PSR File List ............................................................................................... 643
Add Custom Fields in a PSR File ................................................................................... 644
Retrieve Custom Field Values from PSR Files............................................................... 645
Customizing Title Blocks for Reports: An Overview ..............................................646
Requirements for Customized Report Title Blocks..................................................647
Edit Report Title Block Properties.................................................................................. 651

Performing Calibrations: An Overview.......................................................................652

Starting the Calibration Module ...............................................................................653
Start the Calibration Module from the SmartPlant Instrumentation Window ................ 653
Start the Calibration Module from the Instrument Index Standard Browser .................. 653
Searching for Tag Numbers in the Calibration Module ...........................................654
Search for Tag Numbers in the Calibration Module....................................................... 654
Calibration Forms: An Overview .............................................................................657
Upgrading the Standard Calibration Forms..............................................................658
Upgrade the Standard Calibration Forms........................................................................ 660
Flow of Preliminary Activities for Calibration.........................................................662
Add Customized Calibration Forms to the Database...................................................... 663
Create a Calibration Profile ............................................................................................ 664
Define Calibration Profile Settings ................................................................................. 664
Associate Calibration Profiles with Instrument Types ................................................... 665
Dissociate Profiles from Instrument Types..................................................................... 666
Manage Code Tables....................................................................................................... 666

18 SmartPlant Instrumentation User’s Guide

 Preface

Flow of Activities for Defining Tag Calibration Settings ........................................668

Define Tag Calibration Settings...................................................................................... 669
Copy Existing Process Data............................................................................................ 670
Defining Alarm / Trip Settings .................................................................................671
Define Alarm / Trip Settings........................................................................................... 671
Defining the Set Point...............................................................................................672
Define the Set Point ........................................................................................................ 672
Flow of Activities for Entering Tag Calibration Data ..............................................673
Select a Calibration Profile ............................................................................................. 674
Enter Calibration Data .................................................................................................... 674
View Calibration History................................................................................................ 676
List of Calibration Reports.............................................................................................. 677
Generate Calibration Reports.......................................................................................... 678
Test Equipment: Overview .......................................................................................680
Selecting Test Equipment .........................................................................................682
Create a Test Equipment Tag.......................................................................................... 682
Loop Error Calculation: An Overview .....................................................................683
Loop Error Calculation Common Tasks...................................................................684
Calibration Error Calculations ........................................................................................ 684
Setting Tags for Loop Error Calculation ..................................................................686
Set Tags for Loop Error Calculation............................................................................... 686
Calculating Loop Error .............................................................................................688
Calculate the Loop Error................................................................................................. 688

Working with the Fluke Interface ................................................................................690

Set up a Profile for the Fluke Calibrator...................................................................691
Download Data from SmartPlant Instrumentation ...................................................692
Upload Data from the Fluke Calibrator ....................................................................694

Maintenance Module: An Overview ............................................................................696

Access Rights in the Maintenance Module ..............................................................697
Starting the Maintenance Module.............................................................................698
Start the Maintenance Module From Any SmartPlant Instrumentation Module ............ 698
Start the Maintenance Module From an Instrument Index Browser View ..................... 698
Filtering Maintenance Activities ..............................................................................699
Filter Maintenance Activities.......................................................................................... 699
Generating Maintenance Reports .............................................................................700
Generate a Maintenance Report...................................................................................... 700
Preventive Maintenance Preliminary Activities .......................................................701
Performing Preventive Maintenance ........................................................................702
Defining Preventive Maintenance Attachments .......................................................704
Define a Preventive Maintenance Attachment................................................................ 704
Defining Preventive Maintenance Tasks ..................................................................705
Define a Preventive Maintenance Task .......................................................................... 705
Defining Preventive Maintenance Activities............................................................706
Define a Preventive Maintenance Activity ..................................................................... 706
Scheduling Maintenance...........................................................................................708
Schedule Maintenance .................................................................................................... 708

SmartPlant Instrumentation User’s Guide 19

Preface

Extending Existing Scheduling.................................................................................710

Extend the Existing Scheduling of Maintenance ............................................................ 710
Entering Preventive Maintenance Details ................................................................711
Enter Preventive Maintenance Details............................................................................ 711
Performing Breakdown Maintenance .......................................................................713
Issuing a New Work Request ...................................................................................715
Issue a New Work Request ............................................................................................. 715
Opening a Work Request..........................................................................................716
Open an Existing Work Request..................................................................................... 716
Creating Repair Forms..............................................................................................718
Create a New Repair Form ............................................................................................. 718
Filling Out Repair Forms..........................................................................................719
Fill Out a Repair Form.................................................................................................... 719

Maintenance Event Records: An Overview ................................................................720

Flow of Activities for Defining and Managing Maintenance Event Records ..........722
Set a Date Format for Maintenance Event Record Names ............................................. 723
Create a Maintenance Event Record............................................................................... 723
Complete a Maintenance Event Record.......................................................................... 724

Wiring in SmartPlant Instrumentation: An Overview ..............................................726

Principles of Wiring Operations in SmartPlant Instrumentation..............................727
Splitting the Wiring Design Among Several Teams ................................................728
Creating a Wiring Scheme........................................................................................730
Name and Sequence Uniqueness of Wiring Items ...................................................731
General Definitions Common Tasks ........................................................................733
Apply Naming Conventions to Wiring Items ................................................................. 733
Associate a Symbol with an Item .............................................................................734
Remove Trailing Separators From Wiring Item Names ................................................. 735

Creating and Managing Cables: An Overview ...........................................................736

Creating and Managing Cables Common Tasks ......................................................737
Define a Cable Configuration ......................................................................................... 740
Edit a Cable Configuration ............................................................................................. 742
Delete a Cable Configuration.......................................................................................... 743
Create a Cable ................................................................................................................. 743
Create a Connector.......................................................................................................... 745
Edit Cable Properties ...................................................................................................... 746
Add a Cable Set .............................................................................................................. 747
Add a Wire to a Cable Set............................................................................................... 748
Create a Cable Without Sets and Wires .......................................................................... 749
Apply a Reference Cable to Multiple Cables Without Sets and Wires........................... 750
Apply a Reference Cable to One Cable Without Sets and Wires ................................... 750
Edit Wire Properties........................................................................................................ 751
Apply Regional Wire Colors to Project Cables .............................................................. 752

20 SmartPlant Instrumentation User’s Guide

 Preface

Conventional Panels: An Overview..............................................................................754

Managing Conventional Panels Common Tasks......................................................755
Create a Junction Box ..................................................................................................... 756
Create a Marshaling Rack............................................................................................... 758
Create a Cabinet.............................................................................................................. 759
Create an Unassociated Conventional Device Panel ...................................................... 761
Create a Distributed Control System (DCS) Panel ......................................................... 762
Create a Programmable Logic Controller (PLC) Panel .................................................. 764
Create a Panel with Terminals and Connectors .............................................................. 765
Enter Power Supply Data for Panels and Instrument Tags ............................................. 766
Create a Rack .................................................................................................................. 767
Create a Slot.................................................................................................................... 768

Device Panels: An Overview .........................................................................................770

Principles of Creating Device Panels .......................................................................771
Managing Device Panels Common Tasks ................................................................772
Create an Instrument with an Automatically Configured Device Panel ......................... 775
Create an Instrument with a Manually Configured Device Panel................................... 776
Create an Instrument Without a Device Panel ................................................................ 779
Create Device Panels and Cables in the Instrument Index Standard Browser View ...... 780
Create Device Panels for Selected Instruments .............................................................. 781
Associate Instruments with Device Panels ..................................................................... 782
Dissociate Device Panels from Instruments.................................................................... 783
Create a Device Cable..................................................................................................... 783
Rename Device Cables in Batch Mode........................................................................... 784

Wiring Equipment: An Overview ................................................................................786

Wiring Equipment Common Tasks ..........................................................................788
Customize and Use Wiring Equipment Categories......................................................... 790
Add User-Defined Wiring Equipment Category Properties ........................................... 791
Create a Wiring Equipment Item .................................................................................... 792
Hierarchy Examples of Wiring Items .......................................................................795
Create an I/O Card .......................................................................................................... 797
Create an I/O Termination .............................................................................................. 799
Customize the Controller/Processor List Header in I/O Card Properties ....................... 802
Associate an I/O card with an I/O Termination .............................................................. 802

Apparatus: An Overview ..............................................................................................804

Apparatus Common Tasks........................................................................................805
Define an Apparatus Configuration ................................................................................ 806
Create an Apparatus Group............................................................................................. 808
Add an Apparatus to an Apparatus Group ...................................................................... 809
Edit Apparatus Terminal Properties................................................................................ 810

Terminal Strips: An Overview .....................................................................................811

Managing Terminal Strips Common Tasks..............................................................812
Define a Terminal Strip Configuration ........................................................................... 813

SmartPlant Instrumentation User’s Guide 21

Preface

Modify a Terminal Strip Configuration .......................................................................... 815

Terminal Strip Configuration Examples ......................................................................... 816
Create a Terminal Strip................................................................................................... 817
Move a Terminal Strip to Another Parent Item .............................................................. 818
Add a Terminal to a Terminal Strip ................................................................................ 819
Add a Group of Terminals to a Terminal Strip............................................................... 820
Edit the Properties of a Terminal .................................................................................... 821
Move a Terminal............................................................................................................. 822
Select a Graphic for a Terminal Connection................................................................... 822

Making Connections in SmartPlant Instrumentation: An Overview .......................824

Making Connections Common Tasks.......................................................................825
Define a Connection Type .............................................................................................. 827
Connection Type Examples ............................................................................................ 828
Connect a Cable or a Cable Set to a Terminal Strip ....................................................... 830
Connect Device Cables to a Terminal Strip in Batch Mode ........................................... 831
Connect a Wire to a Terminal Strip ................................................................................ 833
Move Cables, Cable Sets, and Wires .............................................................................. 834
Disconnect Cables, Cable Sets, and Wires ..................................................................... 834
Add Jumpers to the Existing Wiring............................................................................... 835
Set Preferences for Automatic Naming of Jumpers........................................................ 836
Remove a Jumper from the Existing Wiring .................................................................. 836
Assigning Wire Designation.....................................................................................838
Updating Connection Data .......................................................................................839
View Cable Connection Destinations ............................................................................. 839
Display Adjacent Connections of a Cable ...................................................................... 839
Display the Farthest Connection of a Cable.................................................................... 840
Examples of Farthest Connections of Cables ................................................................. 841
Trace a Signal in a Point-to-Point Wiring Diagram........................................................ 841
Change the Font Size of Cable and Cable Set Names .................................................... 843
Generate a Connection Report from the Connection Window ....................................... 843

I/O Assignment: An Overview......................................................................................844

Effecting I/O Assignment Common Tasks...............................................................845
Set I/O Assignment Instrument Tag Preferences............................................................ 847
Effect I/O Assignment for an Instrument........................................................................ 848
Effect I/O Assignment for a Segment ............................................................................. 849
Assign an Instrument to a Channel ................................................................................. 850
Assign a Segment to a Channel ...................................................................................... 851
Create a Channel ............................................................................................................. 852
Create a Control System Tag .......................................................................................... 852
Create a Control System Tag in the Instrument Index Standard Browser View............. 853
Rename a Control System Tag ....................................................................................... 854
Couple an Instrument with a Control System Tag .......................................................... 854
Decouple an Instrument and a Control System Tag ....................................................... 854
Delete a Control System Tag .......................................................................................... 855
Filter the Display of Data in the I/O Assignment Window............................................. 855
Cancel I/O Assignment ................................................................................................... 856
Generate an I/O Tag Assignment Report........................................................................ 857

22 SmartPlant Instrumentation User’s Guide

 Preface

Control System Tag Propagation .................................................................................... 857

View and Edit Channel Data........................................................................................... 858
Find I/O Channels for Assignment ................................................................................. 860

Cross Wiring: An Overview..........................................................................................862

Cross Wiring Connections Common Tasks..............................................................863
Perform Manual Cross Wiring........................................................................................ 864
Perform Semiautomatic Cross Wiring ............................................................................ 866
Set Cross Wiring Preferences ......................................................................................... 867
Perform Automatic Cross Wiring ................................................................................... 868
Create a Cross Wiring Cable........................................................................................... 870
Generate a Panel Strip Report from the Cross Wiring Window ..................................... 871

Auto-Wiring: An Overview...........................................................................................872
Defining and Executing Auto-Wiring Tasks: An Overview ....................................873
Flow of Activities for Auto-Wiring..........................................................................875
Auto-Wiring Connections Common Tasks ..............................................................876
Pre-Assign Junction Boxes to Device Panels ................................................................. 877
Auto-Wire Pre-Assigned Junction Boxes ....................................................................... 878
Auto-Wire Two Panels ................................................................................................... 879
Auto-Wire Control Systems............................................................................................ 881
Auto-Wire Control Systems Connected to Pre-Assigned Junction Boxes...................... 883
Auto-Wiring Task Statuses ............................................................................................. 885
Change an Auto-Wiring Task Status .............................................................................. 886

Signal Propagation: An Overview................................................................................887

Possible Cases of Signal Propagation ............................................................................. 888
Tag Signal Propagation Common Tasks ..................................................................890
Re-Propagate a Tag Signal.............................................................................................. 892
Force Signal Propagation................................................................................................ 892
Propagate a Tag Signal Manually ................................................................................... 893
Automatically Propagate a Signal from a Non-Wiring Instrument ................................ 894
Create a Local Tag Signal............................................................................................... 894
Filter the Local Signal Dialog Box ................................................................................. 895
Create a General Signal .................................................................................................. 896
Link Tag Signals to a General Signal ............................................................................. 897
Multiplex Tag Signals..................................................................................................... 897
De-Multiplex Tag Signals............................................................................................... 898
Intrinsic Safety Calculations Common Tasks...........................................................899
Create an Intrinsically Safe Circuit Type........................................................................ 900
Manage Intrinsic Safety Circuit Types ........................................................................... 900
Calculate Intrinsic Safety................................................................................................ 901
Define Tag Numbers for Intrinsic Safety Loop Calculation........................................... 902
Define Circuit Cables for Intrinsic Safety Loop Calculation.......................................... 903
Calculate Intrinsic Safety for a Loop .............................................................................. 903

SmartPlant Instrumentation User’s Guide 23

Preface

Cable Routing: An Overview........................................................................................905

Cable Routing Flow of Activities .............................................................................906
Cable Routing Common Tasks.................................................................................907
Set Cable Routing Options.............................................................................................. 909
Customize Cable Routing Terminology ......................................................................... 910
Manage Standard Widths................................................................................................ 910
Manage Standard Positions............................................................................................. 910
Set the Maximum Number of Cables for the Standard Positions ................................... 911
Create a Routing Section ................................................................................................ 911
Edit a Routing Section .................................................................................................... 912
Associate a Routing Section with Cables ....................................................................... 913
Edit a Cable Routing....................................................................................................... 913
Copy Routing Data to Another Cable ............................................................................. 914
Append Routing Data to a Cable .................................................................................... 915

Cable Drums: An Overview..........................................................................................917

Cable Drums Common Tasks...................................................................................918
Create and Manage a Pulling Area ................................................................................. 919
Associate Cables with a Pulling Area ............................................................................. 920
Define Cable Drum Attributes for Cable Types ............................................................. 920
Manage Cable Drums Manually ..................................................................................... 920
Assign Cables to Drums Automatically (with Optimization) ......................................... 922
Assign Cables to Drums Manually (Without Optimization)........................................... 922

Managing Panel Locations: An Overview ...................................................................923

Managing Panel Locations Common Tasks .............................................................924
Define a New Panel Location ......................................................................................... 924
Modify Panel Location Properties .................................................................................. 925
Change the Location of a Panel ...................................................................................... 925
Dissociate a Panel from a Location ................................................................................ 926
Delete a Panel Location .................................................................................................. 926
Generating Wiring Reports Common Tasks.............................................................927
List of Wiring Reports .................................................................................................... 928
Generate a Connection Report from the Connection Window ....................................... 931
Generate a Panel Strip Report from the Cross Wiring Window ..................................... 932
Generate an I/O Tag Assignment Report........................................................................ 932
Display Channels and Wiring Equipment in Panel-Strip Reports .................................. 932

Cable Block Diagrams: An Overview ..........................................................................934

Cable Block Diagram Common Tasks .....................................................................935
Create a Cable Block Diagram ....................................................................................... 935
Add Cables and Objects to an Existing Cable Block Diagram....................................... 937
View an Existing Cable Block Diagram ......................................................................... 937
Disconnect Cables from Items in a Cable Block Diagram ............................................. 938
Remove Items from a Cable Block Diagram .................................................................. 938

Associate Cable with Panels: An Overview .................................................................939

Associate Cable with a Panel.......................................................................................... 939

24 SmartPlant Instrumentation User’s Guide

 Preface

Foundation Fieldbus Design: An Overview.................................................................941

Flow of Activities for Foundation Fieldbus Design .................................................942
Preliminary Definitions for Foundation Fieldbus Common Tasks...........................946
Define Segment-Wide Parameters .................................................................................. 947
Spur Cable Lengths Example.......................................................................................... 949
Working with Function Blocks: An Overview.........................................................950
Create a User-Defined Function Block........................................................................... 951
Associate Function Blocks with Instrument Types......................................................... 951
Manage the Function Blocks Supporting Table.............................................................. 952
Working with the Fieldbus Tag Numbers Browser: An Overview ..........................954
Managing Fieldbus Instruments Common Tasks .....................................................955
Define Foundation Fieldbus and Profibus Instrument Type Profiles.............................. 956
Create Foundation Fieldbus and Profibus Instruments ................................................... 957
Associate Function Blocks with Instruments.................................................................. 960
Managing Segments Common Tasks .......................................................................961
Create a Foundation Fieldbus Segment .......................................................................... 962
Edit the Properties of a Foundation Fieldbus Segment................................................... 962
Associate an Instrument with a Segment ........................................................................ 963
Dissociate an Instrument from a Segment ...................................................................... 964
Change Instrument / Segment Association ..................................................................... 964
Delete a Fieldbus Segment.............................................................................................. 965
Enable a Function Block for I/O Assignment................................................................. 965
Change the View in the Fieldbus Tag Numbers Browser............................................... 965
Managing Fieldbus Cables Common Tasks .............................................................967
Create a Home-Run Cable .............................................................................................. 967
Create a Spur Cable ........................................................................................................ 968
Fieldbus Plug-and-Socket Boxes: An Overview ......................................................969
Managing Fieldbus Panels (Plug-and-Socket Boxes) Common Tasks ....................970
Create a Plug-and-Socket Device Panel.......................................................................... 970
Create a Plug-and-Socket Junction Box.......................................................................... 971
Edit the Properties of a Plug-and-Socket Device Panel .................................................. 972
Edit the Properties of a Plug-and-Socket Junction Box .................................................. 973
Working with Terminators: An Overview................................................................974
Managing Terminators Common Tasks ...................................................................975
Create an External Terminator in a Plug-and-Socket Box.............................................. 976
Create an External Terminator on a Terminal Strip........................................................ 976
Create an Internal Terminator......................................................................................... 977
Move an External Terminator to Another Port in a Plug-and-Socket Box ..................... 977
Terminator (Plug-and-Socket Box) — Segment Association....................................... 978
Terminator (Terminal Strip) — Segment Association.................................................. 978
Fieldbus Bricks: An Overview .................................................................................979
Managing Fieldbus Brick Assemblies and Apparatuses Common Tasks ................980
Create a Fieldbus Brick Assembly.................................................................................. 981
Configure a Fieldbus Apparatus ..................................................................................... 982
Making Connections and Associations for Fieldbus Common Tasks ......................985
Define or Edit a Connector Type .................................................................................... 986
Define or Edit a Connector Type Pin Configuration ...................................................... 987
Delete a Connector Type ................................................................................................ 987
Create a Connector.......................................................................................................... 988

SmartPlant Instrumentation User’s Guide 25

Preface

Assign Connector Pins to Cable Wires ........................................................................... 988

Associate a Pin or a Terminal with a Channel ................................................................ 989
Delete a Connector.......................................................................................................... 990
Connect a Home-Run Cable to a Plug-and-Socket Box ................................................. 990
Associate a Segment with a Home-Run Cable ............................................................... 991
Managing Fieldbus I/O Cards and I/O Assignment Common Tasks .......................993
Create a Fieldbus I/O Card ............................................................................................. 993
Effect Fieldbus I/O Assignment...................................................................................... 995
Fieldbus Validation: An Overview...........................................................................996
Fieldbus Validation Common Tasks ........................................................................998
Generate a Validation Report for One Segment ............................................................. 998
Generate a Validation Report for Multiple Segments..................................................... 999
Generate a Validation Report for Multiple Segments from the Fieldbus Tag
Numbers Browser ........................................................................................................... 999
Generate a Segment Wiring Report ................................................................................ 999

Profibus Design: An Overview ...................................................................................1001

Flow of Activities for Profibus Design...................................................................1002
Profibus Design Common Tasks ............................................................................1004
Create a Profibus DP Segment...................................................................................... 1005
Create a Profibus PA Segment...................................................................................... 1005
Associate Profibus PA Instruments with a PA Segment............................................... 1005
Associate Profibus DP Instruments with a DP Segment............................................... 1006
Create a DP-Compatible PLC or DCS Panel ................................................................ 1006
Associate a PLC or DCS Panel with a Profibus DP Segment....................................... 1006
Generate an Enhanced Profibus Layout Report............................................................ 1007

Working with HART Instruments: An Overview ....................................................1008

Flow of Activities for HART Instrumentation .......................................................1009
Define Instrument Type Profiles for HART Instruments ............................................. 1009
Create a HART Instrument ........................................................................................... 1010
Create a Virtual Digital Tag.......................................................................................... 1012
Create an I/O Card Compatible with HART Instruments............................................. 1012
Effect I/O Assignment for HART Instruments ............................................................. 1013

Conventional and Fieldbus Multi-Input Devices: An Overview .............................1014

Managing Multi-Input Devices Common Tasks ....................................................1015
Create a Plug-and-Socket Multi-Input Device Panel .................................................... 1016
Create a Multi-Input Device Panel with Terminal Connections................................... 1017
Create a Multi-Input Instrument with Plug-and-Socket Connections for a Fieldbus
Segment ........................................................................................................................ 1018
Create a Multi-Input Instrument with Terminal Connections for a Fieldbus
Segment ........................................................................................................................ 1020
Create a Multi-Input Instrument with Plug-and-Socket Connections for a Serial
Loop Interface............................................................................................................... 1022
Create a Multi-Input Instrument with Terminal Connections for a Serial Loop
Interface ........................................................................................................................ 1023

26 SmartPlant Instrumentation User’s Guide

 Preface

Telecom Design: An Overview....................................................................................1025

Flow of Activities for Telecom Design ..................................................................1026
Arrangement of Telecom Items in the Domain Explorer .......................................1028
Supporting Tables for Telecom .................................................................................... 1029
Working with Old Equipment....................................................................................... 1030
Creating and Managing Telecom Devices and Cables Common Tasks.................1031
Set Telecom Device Type Profile Defaults................................................................... 1033
Create a Telecom Field Tag.......................................................................................... 1034
Duplicate a Telecom Field Tag..................................................................................... 1035
Create a Telecom Conventional Field Device .............................................................. 1035
Create a Telecom Plug-and-Socket Field Device ......................................................... 1036
Create a Telecom Cable ................................................................................................ 1037
Creating and Managing Telecom Panels Common Tasks......................................1038
Create a Telecom Junction Box .................................................................................... 1038
Create a Splice Panel .................................................................................................... 1039
Create a Distribution Frame.......................................................................................... 1040
Create a Patch Panel...................................................................................................... 1041
Managing Equipment Cabinets and Equipment Items Common Tasks .................1042
Create a PA Cabinet...................................................................................................... 1044
Create an Amplifier....................................................................................................... 1045
Add a Connector to an Amplifier.................................................................................. 1046
Add an Amplifier Channel to an Amplifier .................................................................. 1047
Create a PABX Cabinet ................................................................................................ 1047
Create a PABX Rack .................................................................................................... 1048
Create a Switch ............................................................................................................. 1049
Add a Connector to a Switch ........................................................................................ 1050
Add a Switch Port ......................................................................................................... 1050
Create a Switch Channel............................................................................................... 1051
Create and Associate a Telephone Number .................................................................. 1051
Create an Unassociated Telephone Number ................................................................. 1052
Associate a Telephone Number with a Channel ........................................................... 1052
Create a Miscellaneous Cabinet.................................................................................... 1053
Create a Hub Cabinet .................................................................................................... 1053
Create Hub Equipment.................................................................................................. 1054
Create a Hub Connector................................................................................................ 1055
Add a Port to a Hub ...................................................................................................... 1056
Create an Intercom Cabinet .......................................................................................... 1056
Add Intercom Equipment.............................................................................................. 1057
Add an Intercom Connector.......................................................................................... 1058
Generating Telecom Reports Common Tasks........................................................1059
Generate a Communication Line Report ...................................................................... 1060
Generate a Speaker Load Report .................................................................................. 1061
Generate a Telecommunication Device List................................................................. 1061
Generate a Telecom Device Type Report ..................................................................... 1061
Generate a Telecom Line Number Report .................................................................... 1062
Generate a Telecom Field Equipment Report............................................................... 1062
Generate a Telecom Signal Level Report ..................................................................... 1062
Generate an Actual Load Report................................................................................... 1063

SmartPlant Instrumentation User’s Guide 27

Preface

Loop Drawings Module: An Overview ......................................................................1064

Blocks in SmartPlant Instrumentation: An Overview .............................................1065

Block Types: An Overview ....................................................................................1067
Loop Blocks: An Overview ....................................................................................1069
Shipped Block Files ...................................................................................................... 1070
Managing CAD Drawing Blocks Common Tasks .................................................1072
Add a Block Type ......................................................................................................... 1072
Add a Block to a Block Type........................................................................................ 1073
View a Drawing Block in a CAD Application ............................................................. 1074
Define Insertion Points for Blocks................................................................................ 1074
Copy Blocks to Another <Plant>.................................................................................. 1075
Assigning Blocks Common Tasks..........................................................................1077
Associate a Loop Block ................................................................................................ 1079
Associate Instrument Blocks Automatically (via Instrument Type)............................. 1079
Change the Block Assignment Method from Automatic to Manual............................. 1080
Associate Instrument Blocks Manually ........................................................................ 1081
Update Block Assignments........................................................................................... 1082
Copy Associated Blocks to Other Instrument Tags ...................................................... 1083
Copy Automatically Assigned Blocks to Tags of Other Loops.................................... 1084
Assign an Instrument Block to a Drawing Page ........................................................... 1084
Dissociate Blocks from Instruments ............................................................................. 1085
Specify Border and Logo Blocks for Loop Drawings .................................................. 1086
Assign General Blocks to All Loop Drawings via Instrument Type ............................ 1086

Updating Loop Drawing Properties: An Overview ..................................................1088

Loop Drawing Types and Drawing Properties Common Tasks.............................1089
Set the Date Format in CAD Loop Drawings ............................................................... 1091
Define a Drawing as a Multi-Drawing.......................................................................... 1091
Define a Drawing as a Multi-Page Drawing................................................................. 1092
Modify Properties of a Single-Page Drawing ............................................................... 1093
Maintain CAD Loop Drawing Revisions...................................................................... 1093
Maintain Document References.................................................................................... 1094
Make CAD Drawing Approvals ................................................................................... 1095
Modify Loop Drawing Identifying Information ........................................................... 1095
Update Paths for CAD Drawings and Block Files........................................................ 1096
Update Paths for Existing CAD Drawings And Block Files ........................................ 1096
Associating an External CAD Drawing ........................................................................ 1097
View an External CAD Drawing .................................................................................. 1097

Loop Drawing Generation Methods: An Overview..................................................1098

CAD Loop Drawing Generation: An Overview........................................................1099

Steps in Loop Drawing Generation Using a CAD Application..............................1101
CAD Settings for SmartPlant Instrumentation.............................................................. 1102
Sample Loop Drawing (After Generation) ................................................................... 1110
CAD Loop Drawing Generation Common Tasks ..................................................1111

28 SmartPlant Instrumentation User’s Guide

 Preface

Apply Loop Drawing Generation Method .................................................................... 1112

Generate CAD Loop Drawings..................................................................................... 1112
Show the Latest Generated CAD Drawing ................................................................... 1115
Display CAD Loop Drawing Generation History......................................................... 1115
Delete CAD Loop Drawing Generation History........................................................... 1116
Clear Previous Macro Result Records .......................................................................... 1117
Loop Drawing Reports ...........................................................................................1118
Generate a Report of CAD Loop Drawing Generation Errors...................................... 1118

Macros in SmartPlant Instrumentation: An Overview............................................1119

SmartPlant Instrumentation Macro Structure .........................................................1121
Title Block Macro List............................................................................................1122
Wiring Module Macros - Conventions ...................................................................1126
Generate a Macro Report .............................................................................................. 1128
Using Macros in CAD Blocks: An Overview ........................................................1129
Insert Macros in an AutoCAD Drawing Block............................................................. 1130
Customizing Macro Definitions: An Overview......................................................1132
Create a New Macro Definition.................................................................................... 1132
Delete a Macro Definition ............................................................................................ 1133
Working with User-Defined Macro Functions: An Overview ...............................1134
Standard Functions ....................................................................................................... 1135
Create a User-Defined Macro Function ........................................................................ 1136
Modify a User-Defined Macro Function ...................................................................... 1137
Delete a User-Defined Macro Function ........................................................................ 1138
Using External Macro Data Sources: An Overview...............................................1139
External Macro Naming Conventions ....................................................................1140
External Macro Structure Conventions ..................................................................1141
Connecting to an External Data Source..................................................................1142
Prerequisites for Connecting to a dBase ODBC Profile.........................................1143
Connecting to an ODBC Profile .............................................................................1144
Connect to an ODBC Profile ........................................................................................ 1144
Connecting to Database Platforms Other Than ODBC ..........................................1145
Connect to Database Platforms Other Than ODBC...................................................... 1145
Assigning an External Macro Data Source.............................................................1146
Assign an External Macro Data Source to One or More Loop Numbers ..................... 1146

SmartPlant Instrumentation and MicroStation: An Overview...............................1147

System Requirements .............................................................................................1148
Set MicroStation for SmartPlant Instrumentation......................................................... 1148
Creating Tag Sets....................................................................................................1150
Create Tag Sets ............................................................................................................. 1150
Exporting Tag Sets .................................................................................................1151
Export Tag Sets............................................................................................................. 1151
Importing Tag Sets .................................................................................................1152
Import a Tag Set ........................................................................................................... 1152
Linking a Tag to a Drawing Element .....................................................................1153
Link a Tag to a Drawing Element................................................................................. 1153

SmartPlant Instrumentation User’s Guide 29

Preface

Creating a Cell Library ...........................................................................................1154

Create a Cell Library..................................................................................................... 1154
Fencing Elements for a Cell ...................................................................................1155
Fence Elements for a Cell ............................................................................................. 1155
Defining the Cell Origin .........................................................................................1156
Define the Cell Origin................................................................................................... 1156
Defining the Coordinates of the Cell Origin...........................................................1157
Define the Cell Origin Coordinates .............................................................................. 1157
Add a Cell to the Cell Library....................................................................................... 1157
Previewing a Cell....................................................................................................1158
Preview a Cell ............................................................................................................... 1158
Displaying a Cell on the Desktop ...........................................................................1159
Display a Cell on the Desktop ...................................................................................... 1159
Generating a Report Using MicroStation ...............................................................1160

Hook-Ups in SmartPlant Instrumentation: An Overview .......................................1161

Hook-Up Items: An Overview ....................................................................................1162

Hook-Up Item Libraries and Sub-Libraries: An Overview ....................................1163

Managing Hook-Up Items and Libraries Common Tasks......................................1164
Create an Item Library .................................................................................................. 1165
Set an Item Library As the Active Item Library ........................................................... 1166
Assign the Same Active Item Library to More Than One Plant ................................... 1166
Create User-Defined Sub-Libraries .............................................................................. 1167
Create a Hook-Up Item................................................................................................. 1167
Create Hook-Up Items in Batch Mode ......................................................................... 1168
Sort Hook-Up Items in a Sub-Library........................................................................... 1169
Associate Items with User-Defined Sub-Libraries ....................................................... 1169
Remove Items from a User-Defined Sub-Library......................................................... 1170
Delete Hook-Up Items .................................................................................................. 1171
Delete Hook-Up Sub-Libraries ..................................................................................... 1172
Managing Hook-Ups Common Tasks ....................................................................1173
Create a Hook-Up Type ................................................................................................ 1175
Create Hook-Ups .......................................................................................................... 1175
Associate Hook-Up Types with Instrument Types ....................................................... 1176
Associate Instrument Tag Numbers with Hook-Ups .................................................... 1177
Move Hook-Ups to Another Hook-Up Type ................................................................ 1178
Change a Hook-Ups Sub-Library Association.............................................................. 1179
Associate Items with Hook-Ups ................................................................................... 1179
Dissociate Items from Hook-Ups.................................................................................. 1180
Dissociate Tag Numbers from Hook-Ups..................................................................... 1181
Delete Hook-Ups .......................................................................................................... 1182
Delete Hook-Up Types ................................................................................................. 1182

Hook-Up Drawing Generation: An Overview...........................................................1184

Managing Hook-Up Drawings Common Tasks .....................................................1186
Shipped Enhanced Hook-Ups Symbols ........................................................................ 1188

30 SmartPlant Instrumentation User’s Guide

 Preface

Apply a Drawing Generation Method to Hook-Ups..................................................... 1188

Set Default Generation Method for Hook-Up Drawings .............................................. 1189
Edit Hook-Up Drawing Identifying Fields ................................................................... 1189
Make Approvals for Hook-Up Drawings...................................................................... 1190
Maintain Hook-Up Drawing Revisions ........................................................................ 1191
Add Document References in Hook-Up Drawings....................................................... 1192
Assign Border and Logo Blocks to Hook-Up Drawings .............................................. 1192
Assign an Enhanced Symbol to a Hook-Up.................................................................. 1193
Update Paths for Hook-Up Drawings and Block Files ................................................. 1193
Generate CAD Hook-Up Drawings .............................................................................. 1194
Generate Enhanced Hook-Up Drawings....................................................................... 1196
Generate Hook-Up Drawings in Mixed Mode.............................................................. 1198
Displaying CAD Hook-Up Drawings with the Enhanced Report Utility
Common Tasks .......................................................................................................1200
Display SmartSketch Hook-Up Drawings with the Enhanced Report Utility .............. 1201
Display AutoCAD Hook-Up Drawings with the Enhanced Report Utility .................. 1201
Display MicroStation Hook-Up Drawings with the Enhanced Report Utility.............. 1202
Create a New Macro Definition.................................................................................... 1202
Delete a Macro Definition ............................................................................................ 1204

Hook-Up Reports: An Overview ................................................................................1205

Calculating the Total of Hook-Up Items for a Bill of Material .................................... 1207
Hook-Up Reports Common Tasks..........................................................................1208
Generate a Bill of Material ........................................................................................... 1209
Sort Data in a Bill of Material....................................................................................... 1210
Generate a Hook-Up Item List Report.......................................................................... 1210
Generate a Hook-Up Tag List Report ........................................................................... 1211
Open Reports by Selecting Document Numbers .......................................................... 1211

Browser Module Overview..........................................................................................1212

Browser Manager Overview .......................................................................................1213

Browser Manager Hierarchy...................................................................................1214
Browser Manager Common Tasks .........................................................................1215
Select a Default Browser .............................................................................................. 1216
Define a View Profile ................................................................................................... 1216
Add a New View........................................................................................................... 1218
Duplicate a View .......................................................................................................... 1218
Copy a View to Another Plant ...................................................................................... 1219
Modify a View Profile .................................................................................................. 1220
Delete a View................................................................................................................ 1221
Find a Browser or Browser View ................................................................................. 1221
Browser Groups ......................................................................................................1223
Instrument Index Browser Group ................................................................................. 1223
Process Data and Calculation Browser Group.............................................................. 1226
Specifications Browser Group ...................................................................................... 1227
Wiring Browser Group ................................................................................................. 1228
Hook-Ups Browser Group ............................................................................................ 1229
Loop Drawings Browser Group.................................................................................... 1229

SmartPlant Instrumentation User’s Guide 31

Preface

Control System Browser Group.................................................................................... 1230

Dimensional Data Browser Group................................................................................ 1231
Construction and Commissioning Browser Group ....................................................... 1231
Document Binder Browser Group ................................................................................ 1232
Documents Browser Group........................................................................................... 1232
General Browser Group ................................................................................................ 1233
Telecom Browser Group............................................................................................... 1234

Adding New Browsers: An Overview ........................................................................1235

Adding New Browsers Common Tasks .................................................................1236
Add a Single-Form Browser ......................................................................................... 1237
Test a Multi-Form Browser .......................................................................................... 1237
Create a PowerSoft Browser in InfoMaker................................................................... 1238
Add a PowerSoft Browser ............................................................................................ 1240

Style Settings: An Overview........................................................................................1242

Style Settings Common Tasks ................................................................................1243
Display the Current Style Setting ................................................................................. 1244
Create a View Style ...................................................................................................... 1244
Clear a View Setting ..................................................................................................... 1247
Modify Style Settings ................................................................................................... 1247
Structure the Print Layout............................................................................................. 1249
Clear a Print Layout Structure ...................................................................................... 1251
Duplicate a View Style ................................................................................................. 1251
Print the Style Setting Data........................................................................................... 1252

Sort Settings: An Overview.........................................................................................1253

Sort Settings Common Tasks..................................................................................1254
Display the Current Sorting Sequence .......................................................................... 1254
Create a Sorting Sequence View................................................................................... 1255
Modify a Sorting Sequence View ................................................................................. 1256
Duplicate a Sorting Sequence View ............................................................................. 1257
Clear a Sorting Sequence Setting.................................................................................. 1258

View Filter Settings: An Overview.............................................................................1259

View Filter Settings Common Tasks......................................................................1261
Display the Current View Filter Condition................................................................... 1261
Define a View Filter...................................................................................................... 1262
Modify a View Filter .................................................................................................... 1263
Duplicate a View Filter................................................................................................. 1264
Clear View Filter Settings............................................................................................. 1265

Browser Views: An Overview .....................................................................................1266

Browser Views Common Tasks .............................................................................1267
Open a Browser View................................................................................................... 1269
Edit Data in a Browser View ........................................................................................ 1269
Modify and Save a Field Layout................................................................................... 1270
Modify Document Numbers in a Document Browser View......................................... 1270

32 SmartPlant Instrumentation User’s Guide

 Preface

Copy Data Using the Browser View Buffer ................................................................. 1271

Clear Data from the Buffer ........................................................................................... 1272
Sort Displayed Rows..................................................................................................... 1272
Count Displayed Rows ................................................................................................. 1273
Refresh Displayed Data ................................................................................................ 1273
Find a Value in a Specific Column ............................................................................... 1274
Select Non-Editable Field Indication Color.................................................................. 1274
Open a Module from a Browser View .......................................................................... 1275

Document Binder Module: An Overview ..................................................................1276

Specification Binder Packages ...............................................................................1277
General Document Binder Packages ......................................................................1278
Document Management Common Tasks................................................................1279
Start the Document Binder Module .............................................................................. 1281
Create a New Binder Package....................................................................................... 1281
Assign an Instrument Specification to a Specification Binder Package ....................... 1282
Edit Binder Package Properties .................................................................................... 1282
Number Pages in a General Document Binder Package............................................... 1283
Remove Selected Instrument Specifications From a Specification Binder Package .... 1284
Remove a Single Instrument Specification From a Specification Binder Package ...... 1285
Remove All Instrument Specifications From a Specification Binder Package............. 1285
Delete a Binder Package ............................................................................................... 1286
Associate External Files with a Binder Package........................................................... 1286
Displaying Binder Package Properties ...................................................................1288
Display the Properties of a Binder Package.................................................................. 1288
Troubleshooting......................................................................................................1289
Using Document Binder Notes...............................................................................1291
Document Binder Notes Common Tasks ...............................................................1292
Create a Form Note Template....................................................................................... 1293
Edit a Form Note Template........................................................................................... 1293
Delete a Form Note Template....................................................................................... 1294
Create a Form Note....................................................................................................... 1294
Assign a General Note to a Binder Package ................................................................. 1295
Edit a Note .................................................................................................................... 1296
Specification Binder Package Revisions ................................................................1297
Change Summary Report........................................................................................1299
Enabling Specification Changes Notification.........................................................1300
Binder Package Revision Archive ..........................................................................1301
Revisions Common Tasks ......................................................................................1302
Add a Revision to a Binder Package............................................................................. 1303
Delete a Revision From a Binder Package.................................................................... 1304
Convert Binder Package Revisions to .Zip Format Files.............................................. 1304
Modify the Change Notification of a Specification ...................................................... 1305

Printing from a Binder Package: An Overview ........................................................1306

Printing from a Binder Package Common Tasks ...................................................1307
Print Documents in a Binder Package........................................................................... 1308
Print From a Binder Package to a PDF File.................................................................. 1308
Save From a Binder Package to a .Zip File................................................................... 1309

SmartPlant Instrumentation User’s Guide 33

Preface

Dimensional Data for Piping Module.........................................................................1311

Principles of the DDP Module................................................................................1312
Additional Settings .................................................................................................1313
Starting the DDP Module .......................................................................................1314
Start the Dimensional Data for Piping Module............................................................. 1314
Preliminary Procedures...........................................................................................1315
Defining the Process Connection Class..................................................................1316
Define the Process Connection Class / Rating.............................................................. 1316
Defining the Connection End Preparation..............................................................1317
Define a Process Connection End Preparation ............................................................. 1317
Defining Dimensional Groups................................................................................1318
Define a Dimensional Group ........................................................................................ 1318
Defining Dimensional Group Properties ................................................................1319
Define Dimensional Group Properties.......................................................................... 1319
Duplicating a Dimensional Group ..........................................................................1320
Duplicate a Dimensional Group.................................................................................... 1320
Assigning Dimensional Data Forms.......................................................................1321
Assign a PSR File to a Dimensional Data Form........................................................... 1321
Assign a Dimensional Data Form to a Dimensional Group.......................................... 1321
Associating an Instrument Type with a DDP Group ..............................................1322
Associate an Instrument Type With a Dimensional Group .......................................... 1322
Managing Vendor Data...........................................................................................1323
Display and Access Vendor Data ................................................................................. 1323
Entering Vendor Data .............................................................................................1324
Enter Vendor Data Manually ........................................................................................ 1324
Managing Working Data ........................................................................................1325
Display And Access Working Data .............................................................................. 1325
Editing Working Data.............................................................................................1326
Edit Working Data ........................................................................................................ 1326
Piping Design Area.................................................................................................1327
Enter the Piping Design Area ....................................................................................... 1327
Copying Working Data to Default Data .................................................................1328
Copy Working Data to the Default Library .................................................................. 1328
Copying Default Data to Working Data .................................................................1329
Copy Default Data to Working Data ............................................................................ 1329
Copying from Vendor Data to Working Data ........................................................1331
Copy From Vendor Data to Working Data................................................................... 1331
Modifying Working Data Status.............................................................................1333
Modify Working Data Status ........................................................................................ 1333
Managing Default Dimensional Data .....................................................................1334
Entering Data into the Default Library...................................................................1335
Enter Default Data Into the Default Library ................................................................. 1335
Editing Default Data ...............................................................................................1336
Edit Default Dimensional Data ..................................................................................... 1336
Customizing the Default Library Display and Layout ...........................................1337
Generating a Dimensional Data Sheet....................................................................1338
Generate a Dimensional Data Sheet.............................................................................. 1338

34 SmartPlant Instrumentation User’s Guide

 Preface

Tracking the Data Status History............................................................................1339

Track the Working Data Status History........................................................................ 1339
Generating DDP Reports ........................................................................................1340
Generate A Suspected Data List, Status History, Or Suspected Data History Report.. 1341
Printing Dimensional Data Sheets ..........................................................................1342
Print Dimensional Data Sheets From the Dimensional Data for Piping Module
Window......................................................................................................................... 1342
Print Dimensional Data Sheets From the Working Data Window ............................... 1342
Printing Empty Sheet Forms...................................................................................1343
Print Empty Sheets Forms ............................................................................................ 1343
Construction Flow of Activities..............................................................................1344
Definitions in the Construction Module .................................................................1345
Installation Index Category Definitions..................................................................1346
Edit an Existing Installation Index Category ................................................................ 1346
Editing an Installation Index...................................................................................1347
Edit an Installation Index .............................................................................................. 1347
Deleting an Installation Index.................................................................................1348
Delete an Installation Index .......................................................................................... 1348
Delete an Installation Index .......................................................................................... 1348
Viewing and Modifying Assigned Installation Indexes .........................................1349
Modify Assigned Installation Indexes .......................................................................... 1349
Construction Options ..............................................................................................1351
Construction - Example Scenario ...........................................................................1352
Selecting and Viewing Current Installation Indexes ..............................................1354
View Installation Indexes in the Installation Indexes Dialog Box................................ 1354
Adding an Installation Index ..................................................................................1355
Add an Installation Index.............................................................................................. 1355
Adding an Installation Index Category...................................................................1357
Define a New Installation Index Category.................................................................... 1357
Assign Installation Indexes to Items ............................................................................. 1357
Generating Reports .................................................................................................1359
Construction Module Revisions .............................................................................1360
Add New Construction Module Revisions ................................................................... 1360
Maintaining a Revision Archive.............................................................................1361
Viewing and Editing Archives................................................................................1362
View an Archived Installation Index ............................................................................ 1362

Working in KKS Mode in SmartPlant Instrumentation .........................................1364

Overview....................................................................................................................... 1364
Requirements for Importing Line Data in KKS Mode ................................................. 1367
Propagation of KKS Names in SmartPlant Instrumentation ..................................1368
Example of KKS Naming Propagation......................................................................... 1368
Rename an Item in KKS Mode...............................................................................1371
Scope of KKS Issues for the Current SmartPlant Instrumentation Version...........1372

Import Utility: An Overview.......................................................................................1374

Database Platform Support .....................................................................................1375
Flow of Activities for Importing Data into SmartPlant Instrumentation................1376

SmartPlant Instrumentation User’s Guide 35

Preface

Starting the Import Utility ......................................................................................1377

Link Groups: An Overview ........................................................................................1378

Managing Import Link Groups Common Tasks.....................................................1379
Create a Link Group...................................................................................................... 1380
Rename a Link Group................................................................................................... 1381
Rename a Link in the Link Explorer............................................................................. 1381
Rename a Link in the Import Link Window ................................................................. 1382
Prioritize Links in a Link Group................................................................................... 1382
Duplicate a Link in the Link Explorer .......................................................................... 1383
Duplicate a Link in the Import Link Window............................................................... 1384
Move Links to Another Group...................................................................................... 1385
Associate the Same Links with Several Groups ........................................................... 1385
Dissociate Links From a Group .................................................................................... 1386
Delete Links .................................................................................................................. 1386
Delete a Link Group...................................................................................................... 1386

Import Links: An Overview........................................................................................1388

Moving Links Between Databases or Domains: An Overview..............................1390
Defining Import Links Common Tasks..................................................................1391
Create an Import Link for an ODBC Source ................................................................ 1392
Create an Import Link for an Oracle Source................................................................. 1393
Create an Import Link for a File Source ....................................................................... 1394
Define a Data Import Source in Excel Spreadsheets .................................................... 1396
Prerequisite for Using Microsoft Access as an Import Source ..................................... 1396
Using the Link Explorer Window................................................................................. 1397
Change Link Source Paths ............................................................................................ 1398
Specify a New Default Folder for All Links................................................................. 1398
Export a Group of Links ............................................................................................... 1399
Import Links ................................................................................................................. 1399
Link Properties: An Overview................................................................................1400
Defining Import Link Properties Common Tasks ..................................................1401
Open Link Properties .................................................................................................... 1403
Set Properties for Handling Mismatched Data ............................................................. 1403
Set Import Mode Parameters ........................................................................................ 1404
Specify a Filtering Condition........................................................................................ 1405
Enable Reference Tables for Import ............................................................................. 1407
Set the Tag/Loop Parameters ........................................................................................ 1408
Set Custom Parameters for the Module Import Method ............................................... 1409
Set Column Display for the Module Import Method .................................................... 1410
Set Properties for an Excel Data Source ....................................................................... 1411
Refresh Previously Imported Data................................................................................ 1411
Target Table Definition: An Overview...................................................................1413
Target Column Colors................................................................................................... 1416
Key Numbering System................................................................................................ 1417
Reference Key Definition ............................................................................................. 1417
Changing the Target Column Type............................................................................... 1418
Key Levels .................................................................................................................... 1418

36 SmartPlant Instrumentation User’s Guide

 Preface

Table Definitions Common Tasks ..........................................................................1419

Create a Table Definition on the Basis of Another Definition...................................... 1420
Set a Definition as the Active Definition ...................................................................... 1420
Modify a Table Definition ............................................................................................ 1421
Rename a Table Definition ........................................................................................... 1423
Delete Key Definitions of a Specific Table .................................................................. 1424
Delete a Table Definition.............................................................................................. 1425
Working with Log Files: An Overview ..................................................................1426
Working with Log Files Common Tasks................................................................1427
Create a New Log File .................................................................................................. 1428
Open an Existing Log File ............................................................................................ 1428
View the Current Log File ............................................................................................ 1428
Check the Name of the Current Log File...................................................................... 1429
Close the Current Log File............................................................................................ 1429
Delete an Existing Log File .......................................................................................... 1429
Log the Import Parameters............................................................................................ 1430
Viewing the Source Data ........................................................................................1431
Working with Source Data .....................................................................................1432
View the Source Data ................................................................................................... 1433
Select the Desired Viewing Option............................................................................... 1433
Filter the Displayed Source Data Fields ....................................................................... 1433
Sort the Displayed Source Data Fields ......................................................................... 1434
Associate Additional Source Data ................................................................................ 1434
Built-In Operators and Functions.................................................................................. 1436
SQL Functions Native to the Source Database............................................................. 1437
Primary Keys and Primary Values: An Overview..................................................1439
Map Source and Target Fields Common Tasks......................................................1441
Define Links for Naming Conventions......................................................................... 1442
Open Import Links........................................................................................................ 1443
Define the Import Mapping .......................................................................................... 1444
Configure Source Data for Variable Length Data Fields.............................................. 1445
String Operators in Import Links.................................................................................. 1446
Formulas and Arithmetic Functions in Import Links.................................................... 1447
Tag Class Mapping Codes for Instrument Index Import .............................................. 1448
Process Function Mapping Codes for Instrument Index Import................................... 1450
Fluid State Mapping Codes for Process Data Import ................................................... 1450
Mapping Codes for Wiring Data Import....................................................................... 1451

Import Comparison .....................................................................................................1455

Setting the Import Comparison List Options..........................................................1456
Comparison Options Common Tasks.....................................................................1457
View the Source and Target Rows................................................................................ 1457
Filter the Displayed Target Rows ................................................................................. 1458
Preview and Print the Source and Target Rows............................................................ 1458
Import Data Using the Comparison List ....................................................................... 1459
System Codes: An Overview..................................................................................1460
Working with System Codes Common Tasks ........................................................1461
Define Source Systems ................................................................................................. 1462
Adapt System Codes ..................................................................................................... 1463

SmartPlant Instrumentation User’s Guide 37

Preface

Adapt Unit of Measure Codes....................................................................................... 1464

Adapt Unit of Measure Codes - Special Characters ..................................................... 1465
Import Codes................................................................................................................. 1465
Export Codes................................................................................................................. 1466
View the Currently Selected Source System Name...................................................... 1466
Use Source Codes in an Import Link ............................................................................ 1466
General Import Prerequisites ..................................................................................1468
Matching Naming Conventions..............................................................................1469
Importing Data Common Tasks..............................................................................1470
Test the Import Process................................................................................................. 1471
Run an Import Session from the User Interface............................................................ 1471
Run an Import Session from the Command Line ......................................................... 1473
Disable Test Mode ........................................................................................................ 1475
Importing Data into Multiple Plant Hierarchy Items or Projects ...........................1476
Importing Data into Multiple Plant Hierarchy Items or Projects Common Tasks .1478
Import Data Into Multiple Plant Hierarchy Items ......................................................... 1478
Import Data into Several Projects ................................................................................. 1479
Importing Instrument Index Common Tasks..........................................................1481
Prerequisite for Importing Instrument Types................................................................ 1483
Enable Creation of Complementary Elements for Instrument Index............................ 1484
Set Source Fields as Instrument Type Fields ................................................................ 1484
Associate Source Fields with Existing Instrument Types............................................. 1486
Associate Tag Numbers with Correct Instrument Type Descriptions .......................... 1487
Import Instrument Index ............................................................................................... 1488
Import Instrument Properties ........................................................................................ 1490
Example of Concatenated Sources................................................................................ 1491
Creating Specifications by Data Import Common Tasks .......................................1492
Create Specs Using the Module Import Method........................................................... 1492
Create Specs Using the Single Table Import Method................................................... 1494
Create a Multi-Tag Spec by Data Import...................................................................... 1496
Importing Revisions................................................................................................1498
Import Revisions into the REVISION Table ................................................................ 1499
Import Process Data and Calculation Sheet Revisions ................................................. 1500
Importing Wiring Data ...........................................................................................1502
Importing Wiring Data Common Tasks .................................................................1504
Import Panels ................................................................................................................ 1505
Import Device Panels as Cabinet Child Items .............................................................. 1507
Import Wiring Equipment............................................................................................. 1510
Import Terminal Strips and Terminals.......................................................................... 1512
Import Cables, Cable Sets, and Wires........................................................................... 1514
Import Wiring Connection Data ................................................................................... 1516
Common Error Messages.............................................................................................. 1517
System Codes Table...................................................................................................... 1522
Unit of Measure Codes Table ....................................................................................... 1531

Working with Interfaces..............................................................................................1539

Import System Interfaces .............................................................................................. 1539

38 SmartPlant Instrumentation User’s Guide

 Preface

SmartPlant Electrical Interface..................................................................................1541

Prerequisites for Working with the SmartPlant Electrical Interface ......................1542
Flow of Activities for Creating Control Systems ...................................................1544
Retrieve SmartPlant Electrical Data ............................................................................. 1546
Create Electrical Tags ................................................................................................... 1546
Viewing Electrical Tag Numbers ...........................................................................1547
Associate Electrical Signals with Equipment ............................................................... 1548
Create Wiring Items for SmartPlant Electrical Signals................................................. 1549
Create a Device Panel for an Electrical Tag ................................................................. 1550
Create a Local Signal for Electrical Tags ..................................................................... 1551
Flow of Activities for Defining Power Supplies ....................................................1552
Publish Data for SmartPlant Electrical ......................................................................... 1553

SmartPlant P&ID Interface ........................................................................................1555

Importing SmartPlant P&ID Component Data.......................................................1556
Prerequisites for Importing SmartPlant P&ID Data ...............................................1557
Select SmartPlant P&ID Data for Import ..................................................................... 1558

PDS Interface ...............................................................................................................1560

Prerequisites for Importing PDS Data ....................................................................1561
PDS Code Translation ............................................................................................1562
Code Translation Example............................................................................................ 1562
Importing PDS Data ...............................................................................................1564
Select PDS Data for Import .......................................................................................... 1564
PDS Macro Expansion............................................................................................1568
Define PDS Macro Settings .......................................................................................... 1568
Run PDS Import Links.................................................................................................. 1569

DCS Vendor Interfaces................................................................................................1571

SmartPlant Instrumentation - DCS Vendors: Comparative Terminology .................... 1572
Prerequisites for Working with DCS Vendor Interfaces ........................................1573
Configure SmartPlant Instrumentation to Publish and Retrieve Data in File Mode..... 1575
Flow of Activities for Configuring DeltaV ............................................................1576
Data Limitations for the DeltaV Interface .................................................................... 1577
Retrieve DeltaV Definitions ......................................................................................... 1581
Retrieve DeltaV Data.................................................................................................... 1582
Crucial Fields for the DeltaV Interface......................................................................... 1583
Publish Data for DeltaV................................................................................................ 1587
Flow of Activities for Configuring Yokogawa CENTUM CS 3000......................1588
Data Limitations for the Yokogawa CENTUM CS 3000 Interface .............................. 1589
Retrieve Yokogawa CENTUM CS 3000 Definitions ................................................... 1591
Retrieve Yokogawa CENTUM CS 3000 Data ............................................................. 1591
Publish Data for Yokogawa CENTUM CS 3000 ......................................................... 1592
Retrieve ABB Definitions............................................................................................. 1593
Retrieve Honeywell Definitions ................................................................................... 1594
General DCS Vendor Activities .............................................................................1595
Associate Device Types for DCS Vendors ................................................................... 1595

SmartPlant Instrumentation User’s Guide 39

Preface

View the Log File for a DCS Vendor ........................................................................... 1596

NE-100 Interface ..........................................................................................................1597

NE-100 Interface Common Tasks ..........................................................................1598
Activate the NE-100 Interface Menu Commands......................................................... 1598
Map NE-100 Attributes to SmartPlant Instrumentation Specs Form............................ 1599
Publish SmartPlant Instrumentation Spec Data to NE-100........................................... 1600
Retrieve NE-100 Data to SmartPlant Instrumentation Specs ....................................... 1600

FirstVue Interface........................................................................................................1601
Flow of Activities for Working with FirstVue .......................................................1602
FirstVue Field Conversion Conventions ................................................................1603
Prerequisites for Exporting Data to FirstVue .........................................................1605
Exporting FirstVue Data.........................................................................................1606
Export FirstVue Data .................................................................................................... 1606
Prerequisites for Importing FirstVue Data .............................................................1609
Importing FirstVue Data.........................................................................................1610
Import FirstVue Data Automatically ............................................................................ 1611
Import FirstVue Data Manually.................................................................................... 1612

Masoneilan ValSpeQ Interface...................................................................................1614

Flow of Activities for Working with Masoneilan ValSpeQ...................................1615
Prerequisites for Exporting Data to Masoneilan ValSpeQ .....................................1616
Exporting Masoneilan ValSpeQ Data ....................................................................1617
Export Masoneilan ValSpeQ Data................................................................................ 1617
Prerequisites for Importing Masoneilan ValSpeQ Data .........................................1620
Importing Masoneilan ValSpeQ Data ....................................................................1621
Import Masoneilan ValSpeQ Data................................................................................ 1622

Flowserve Performance! Interface .............................................................................1624

Flow of Activities for Working with Flowserve Performance!..............................1625
Prerequisites for Exporting Data to Flowserve Performance! ................................1626
Exporting Flowserve Performance! Data ...............................................................1627
Export Flowserve Performance! Data........................................................................... 1627
Prerequisites for Importing Flowserve Performance! Data ....................................1630
Importing Flowserve Performance! Data ...............................................................1631
Import Flowserve Performance! Data........................................................................... 1632

Working with SmartPlant Integration.......................................................................1634

Overview....................................................................................................................... 1634
Updating SmartPlant Information in Title Blocks..................................................1637
Updating SmartPlant Information in Title Blocks: Flow of Activities...................1638
Title Block Requirements for Integration Reports .................................................1639
PowerSoft Reports ........................................................................................................ 1639
Enhanced Reports ......................................................................................................... 1640
Associating a Custom Title Block with SmartPlant Instrumentation ........................... 1641

40 SmartPlant Instrumentation User’s Guide

 Preface

Open a Custom Title Block........................................................................................... 1641

Install the Update Title Block Component for SmartPlant Instrumentation................. 1642

Schema Mapping: An Overview.................................................................................1644

General Information About Schema Mapping .......................................................1645
Upgrading the SmartPlant Instrumentation Tool Schema for a New Software
Version....................................................................................................................1647
Upgrade the SmartPlant Instrumentation Tool Schema................................................ 1647
Workflow for Extending the Schema .....................................................................1648
Modify the Tool Schema for a Custom Plant Hierarchy............................................... 1649
Naming Convention Mapping....................................................................................... 1655
Synchronizing Schemas..........................................................................................1657
Synchronize the Map Schema File with the Tool Schema ........................................... 1657
Synchronize an Enumerated List .................................................................................. 1665
Define a Schema for SmartPlant Instrumentation......................................................... 1672
Define a Schema for SmartPlant Instrumentation - Custom Fields .............................. 1674
Export a New Schema Configuration ........................................................................... 1676
Define and Map DDP Data ........................................................................................... 1677
Welcome to the SmartPlant Instrumentation Schema Configuration Wizard............... 1677
Select Domain............................................................................................................... 1678
Schema Options ............................................................................................................ 1678
Define New Schema Configuration .............................................................................. 1678
Select Schema ............................................................................................................... 1678
Select Document Type.................................................................................................. 1678
Select Object Types ...................................................................................................... 1678
Define Object Levels and Restrictions.......................................................................... 1679
Define Filter Condition ................................................................................................. 1679
Select Object Interfaces ................................................................................................ 1679
Select Interface Properties ............................................................................................ 1679
Completing the Schema Configuration Wizard ............................................................ 1680
Export Schema Configuration Utility.....................................................................1681
Publishing in an Integrated Environment: An Overview .......................................1682
Preliminary Settings for Publishing from SmartPlant Instrumentation ........................ 1684
Publishable SmartPlant Instrumentation Documents.................................................... 1685
Publishable Dimensional Groups.................................................................................. 1687
Publish Documents from SmartPlant Instrumentation.................................................. 1690
Issue Request Documents from SmartPlant Instrumentation........................................ 1692
Find Documents to Publish from SmartPlant Instrumentation ..................................... 1694

Revising Documents in an Integrated Environment: An Overview........................1697

Revise a Document .................................................................................................1698
Retrieving in an Integrated Environment: An Overview........................................1700
Retrieve Documents to SmartPlant Instrumentation..................................................... 1702
Retrieving Pipe Runs with Control Valves ................................................................... 1704

Using the To Do List: An Overview ...........................................................................1706

To Do List Common Tasks.....................................................................................1707
Set Preferences for the To Do List................................................................................ 1708

SmartPlant Instrumentation User’s Guide 41

Preface

Open the To Do List ..................................................................................................... 1708

Modify To Do List Task Properties .............................................................................. 1708
Run Tasks from the To Do List .................................................................................... 1709
Task Dependencies ....................................................................................................... 1710
Complete a Task from the To Do List .......................................................................... 1711
Sort To Do List Tasks ................................................................................................... 1711
Filter To Do List Tasks ................................................................................................. 1711
Defer Tasks from the To Do List.................................................................................. 1712
Remove Tasks from the To Do List.............................................................................. 1712
Display Deleted To Do List Tasks................................................................................ 1713
Ignore To Do List Tasks ............................................................................................... 1713
Ignore Task Properties .................................................................................................. 1713
Display Ignored To Do List Tasks................................................................................ 1714
Run a To Do List Report............................................................................................... 1714
Update the To Do List Display ..................................................................................... 1714

Merger Utility: An Overview......................................................................................1715

Database Platform Support .....................................................................................1716
Configuring Your Environment..............................................................................1717
Start the Merger Utility................................................................................................. 1717
Working with Log Files..........................................................................................1719
Setting the Merger Comparison Criteria.................................................................1720
Log File: Common Tasks .......................................................................................1722
Create a New Log File .................................................................................................. 1722
Open an Existing Log File ............................................................................................ 1723
View the Current Log File ............................................................................................ 1723
Close the Current Log File............................................................................................ 1724
Delete an Existing Log File .......................................................................................... 1724
Merging Data: An Overview ..................................................................................1725
Merger Session: Common Tasks ............................................................................1727
Select the Target Plant Hierarchy Item ......................................................................... 1727
Create a New Merger Session....................................................................................... 1728
Open a Merger Session ................................................................................................. 1728
Rename a Merger Session............................................................................................. 1728
Duplicate a Merger Session .......................................................................................... 1728
Delete a Merger Session ............................................................................................... 1729
Selecting the Source Domain: An Overview ................................................................ 1729
Selecting and Matching Source Domains: Common Tasks ...................................1730
Select the Same Source Domain As the Target Domain............................................... 1731
Select a Source Domain from Another ODBC Platform .............................................. 1731
Select a Source Domain from Another Oracle Database .............................................. 1733
Match the Source Projects to the Target Projects ......................................................... 1734
Match the Source Data with the Target Data ................................................................ 1734
Match Source And Target Naming Conventions.......................................................... 1735
Defining Merger Utility Settings: Common Tasks ....................................................... 1736
Define Merger Utility Settings...................................................................................... 1738
Select the Source Modules and Module Data ............................................................... 1739
Select the Source Tables to Be Merged ........................................................................ 1740
Select the Source Item Types to Merge ........................................................................ 1741

42 SmartPlant Instrumentation User’s Guide

 Preface

Specify an Insertion Condition ..................................................................................... 1741

Filter And Sort the Displayed Source Table List.......................................................... 1744
Merging Browser Views ............................................................................................... 1745

Selecting Source Data Using the Comparison List: Overview.................................1746

Selecting Source Data Using the Comparison List Common Tasks ......................1747
Define Comparison List Options .................................................................................. 1750
Define a Comparison List Style.................................................................................... 1751
Compare Source And Target Data ................................................................................ 1752
Compare Data Using Group Mode ............................................................................... 1753
Check for Duplicate Items ............................................................................................ 1756
Restore a Saved PSR File ............................................................................................. 1757
Run the Comparison List by Making an Individual Item Type Selection .................... 1757
Filter the Comparison List Data.................................................................................... 1759
Display Specific Data Columns in the Comparison List .............................................. 1759
Sort the Comparison List Data...................................................................................... 1759
Display the Comparison List for a Child Item Type..................................................... 1760
Start the Transfer Process ............................................................................................. 1761
Perform a Preliminary Configuration ........................................................................... 1761
Running the Comparison List in Multi-Sessions....................................................1763
Analyzing Comparison Reports..............................................................................1765
Merging Supporting Tables ....................................................................................1767
Guidelines for Selecting Item Types and Defining Merger Settings......................1768
Merging Jumpers and Cross Wires.........................................................................1775
Merging Specification Forms that Include Custom Title Blocks ...........................1776
Customizing the Comparison List Display.............................................................1777
Post Merging Actions .............................................................................................1778

Index..............................................................................................................................1779

SmartPlant Instrumentation User’s Guide 43

Preface

Preface
This user's guide describes concepts, procedures, and interface features of SmartPlant
Instrumentation.

Send documentation comments or suggestions to [email protected].

1

44 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Working with SmartPlant Instrumentation: An

Overview
SmartPlant® Instrumentation powered by INtools® is a Windows-based program that
helps you to design and maintain every stage in the life-cycle of plant engineering
systems, from construction, through maintenance and modernization, to de-
commissioning.

This guide provides instructional, procedural, and reference material to help you get
the most from SmartPlant Instrumentation. Use it to learn the basics and later as a
reference to perform specific tasks.

SmartPlant Instrumentation is a straightforward, menu-driven program whose

functions and modules are readily accessible from the menu and toolbars.

SmartPlant Instrumentation includes the following components:

• The Administration module, which provides all of the options required

to define the administrative and security functions of the software.
These options include defining access rights, managing preferences,
creating the working environment, assigning managers, tag convention
definitions, plant hierarchy item definitions, and so forth.
• SmartPlant Instrumentation Domain Explorer, which allows you to
organize instrumentation items, easily navigate to them, and perform
appropriate actions.
• The main SmartPlant Instrumentation Modules, which enable you to
perform a wide variety of engineering activities.
The following utilities enable the transfer of external data into the SmartPlant
Instrumentation database:

• The Import Utility provides the means to import data into SmartPlant
Instrumentation from the most common database file formats such as
Microsoft Access, DBF files, Oracle, SQL Server, Sybase Adaptive
Server Anywhere, ASCII delimited files, and other ODBC compatible
files.
• The Merger Utility provides the means of merging the data of either
two <units> or two <plants> for the purpose of creating one common
database for either the two <units> or the two <plants>.
Related Topics
• Getting Started Common Tasks, page 50

SmartPlant Instrumentation User’s Guide 45

Working with SmartPlant Instrumentation: An Overview

User Assistance
SmartPlant Instrumentation user assistance supplies command information as you
perform tasks. You can access different kinds of information any time you are
running the software. This information could include reference topics, narrative
descriptions or overviews.

SmartPlant Instrumentation offers the following important user assistance features:

Installation Guide — This document provides you with step-by-step procedures for
installing SmartPlant Instrumentation on Oracle or SQL Server database platforms, or
on Sybase Adaptive Server Anywhere. It also contains important configuration
information, useful tips, and troubleshooting advice. The Installation Guide is
presented in the .pdf file format and can easily be printed out. Adobe Reader,
required for the .pdf files, is available from the SmartPlant Instrumentation
installation CD or from the Internet.

User's Guide — This document provides you with detailed information on

SmartPlant Instrumentation Explorer and each SmartPlant Instrumentation
module, along with recommended settings, examples, and useful tips. Also included
in the User Guide are documents which deal with the usage of SmartSketch,
AutoCAD, and MicroStation CAD interfaces and of InfoMaker and Microsoft Access
report generators in SmartPlant Instrumentation.

Tutorial — The tutorial helps novice users acquire the skills necessary to start using
SmartPlant Instrumentation, create a minimal setup for your plant, and all the basic
instrument engineering activities for each module. You will acquire the fundamental
understanding, skills, and practical experience that you need to use the software with
confidence. The tutorial is presented in the .pdf file format and can easily be printed
out. Adobe Reader, required for the .pdf files, is available from the SmartPlant
Instrumentation installation CD or from the Internet.

Online Help — SmartPlant Instrumentation Online Help provides conceptual

overviews and procedures to help you to work efficiently with the software, as well as
context-sensitive help for all windows and dialog boxes. Each context-sensitive help
topic provides accurate reference information for the displayed window or dialog box.

To access context-sensitive help for an open window, do one of the following:

• On the Help menu of any SmartPlant Instrumentation module, click

SmartPlant Instrumentation Help.
• On the toolbar, click the Help icon .
User Interface Features — The user interface provides you with several ways to
see command descriptions:

• ToolTips help you find command names. When you pause the pointer
on a toolbar icon, a yellow label displays the command name.

46 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

• Microhelp messages that appear at the bottom of the window inform

you about the command you are going to execute. Pointing to a
toolbar icon or selecting a menu option displays a brief message on the
status bar.
Technical Support — Intergraph provides extensive technical support all over the
world. To find out how to get technical support, click About SmartPlant
Instrumentation on the Help menu and then click the Tech Support button.

SmartPlant Instrumentation User’s Guide 47

Working with SmartPlant Instrumentation: An Overview

Online Help Text Conventions

Special Displays
The following displays are used for features designed to capture your attention, such
as warnings, important notes, and useful tips.

Caution
• Indicates a caution to which you should pay attention.
Important
• Important information which supplements the main text.
Note
• General information which supplements the main text.
Tip
• Indicates a tip, pointing out a useful feature which makes life easier for
the user.
Keyboard Conventions
Common functions of some keys are described below:

Keys Example / description

Shortcut Combinations of keys can be used as shortcuts. For example, Ctrl + F1
keys means hold down the Control key while pressing F1.
Tab In windows and dialog boxes, pressing the Tab key activates the next
field or command button. To activate the previous item, hold down the
Shift key while pressing the Tab key.
Enter In most windows and dialog boxes, pressing this key is equivalent to
clicking the OK or Save command buttons.
Escape In most windows and dialog boxes, pressing this key is equivalent to
clicking the Cancel command button.
Arrow keys Use these keys to move between fields in data tables.
Numeric If you have an extended keyboard, you can type numbers with the
keypad numeric keypad if you press Num Lock key to turn the Num Lock
indication on.

48 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Mouse Conventions
The left mouse button is the one referred to, unless otherwise stated.

To Do this
Point Position the pointer on an item.
Click Point to an item, then quickly press and release the mouse button.
Double- Point to an item, then quickly press and release the mouse button twice.
click
Drag Point to an item, and while holding down the mouse button on the item,
move the item to a new location. When the pointer is at the desired
location, release the mouse button.

SmartPlant Instrumentation User’s Guide 49

Working with SmartPlant Instrumentation: An Overview

Getting Started Common Tasks

The following general tasks are used when getting started:

Start SmartPlant Instrumentation

This procedure explains how to log on to SmartPlant Instrumentation. where to select
the required domain and if the domain type is Owner operator, your project. After
this, you navigate to the <unit> you are going to work in. Clicking OK on the Open
dialog box brings you to the SmartPlant Instrumentation environment. For more
information, see Start SmartPlant Instrumentation, page 50.

Open a Different Domain

This procedure shows you how you can move from working in the current domain to
a different one. For more information, see Open a Different Domain, page 52.

Change the Logon Password

This procedure allows you to change the password that you use when logging on to
SmartPlant Instrumentation. Changing SmartPlant Instrumentation logon passwords
does not apply to users who log on to the software using Windows authentication
logon method. For more information, see Change the Logon Password, page 52.

Switch to a Different Unit

This procedure makes it possible to switch from the current <unit> to another <unit>.
For more information, see Switch to a Different Unit, page 53.

Open a Module
Use this procedure to open a specific SmartPlant Instrumentation module. You can
open any module whether or not other modules are already open. Access to a
particular module is subject to your having appropriate access rights. For more
information, see Open a Module, page 53.

Related Topics
• Working with SmartPlant Instrumentation: An Overview, page 45

Start SmartPlant Instrumentation

When starting SmartPlant Instrumentation, a splash screen appears, showing the
current version number, followed by the Logon Information dialog box, where you
select the required database and enter your user name and password. After logging
on to SmartPlant Instrumentation, the software displays the Open dialog box, where
you select the desired domain or project in an owner operator domain. After this, you
navigate to the <unit> you are going to work in. Clicking OK on the Open dialog
box brings you to the SmartPlant Instrumentation environment.

50 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Important
• Access to SmartPlant Instrumentation modules is available only after
the System Administrator has created a domain and the Domain
Administrator has set up its resources. See the initialization section
appropriate for your database platform (that is, Oracle, SQL Server or
Sybase Adaptive Server Anywhere) for details.
• User names and passwords are not case-sensitive. The software
displays the password as asterisks.
• If you purchased SmartPlant Instrumentation with an evaluation
license, there is no limit of the number of times that you can log on to
SmartPlant Instrumentation before the expiration date of the license,
however after that date, you will be denied access to SmartPlant
Instrumentation.
Related Topics
• Navigating in SmartPlant Instrumentation, page 51
• Working with SmartPlant Instrumentation: An Overview, page 45

Navigating in SmartPlant Instrumentation

You access SmartPlant Instrumentation items using the SmartPlant
Instrumentation Explorer.

Also, you perform various action from SmartPlant Instrumentation modules using the
menu items or clicking the appropriate toolbar icons in the main SmartPlant
Instrumentation window. A number of other options are available when you are in
this window. The window itself consists of the following areas:

Menu bar — The menu bar contains access to all the actions you will perform in
the module, and also to standard Windows features such as window layouts and
Online Help.

Toolbar — The application toolbar provides you with quick access to each module.
The module toolbars enable you to access the most common actions for the modules.

Application work area — The central region where the main module window
appears.

Status bar — The status bar provides you with quick access to information on the
selected icon or menu item (Microhelp) or the status of a particular process (for
example, exporting data). In addition, it shows the plant hierarchy items and the
current date and time.

Related Topics
• Open a Different Domain, page 52

SmartPlant Instrumentation User’s Guide 51

Working with SmartPlant Instrumentation: An Overview

Open a Different Domain

1. Close all SmartPlant Instrumentation modules that are open.
2. Click File > Open.

3. On the Open dialog box, select a domain .

4. If the project icon appears (only when the domain type is Owner operator),
double-click the icon to select the project you want to work with (As-Built or a
project).
5. Navigate to a desired <unit> by double-clicking the <plant> and <area>
icons to expand the view and display the <units>.
6. Select a <unit> by doing one of the following:

• Double-click the <unit> icon.

• Click the <unit> once to highlight it, then click OK.
Related Topics
• Getting Started Common Tasks, page 50
• Navigating in SmartPlant Instrumentation, page 51
• SmartPlant Instrumentation Explorer: An Overview, page 206
• Working with SmartPlant Instrumentation: An Overview, page 45

Change the Logon Password

Important
• The System Administrator has rights to set logon passwords for
SmartPlant Instrumentation users and is able to override any password
changes made by other users. Therefore, after changing the password,
you must inform the System Administrator of such a change.
• Changing SmartPlant Instrumentation logon passwords does not apply
to users who log on to the software using Windows authentication
logon method.
1. Click File > Change Password.
2. In the Current password field, type your current logon password.
Tip
• Passwords appear masked.
3. In the New password field, type the new password.

52 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Tip
• You can use alphanumeric values in either upper or lower case. The
maximum length of your password can be 15 characters.
4. In the Confirm new password field, retype the new password.
5. Click OK.

Related Topics
• Getting Started Common Tasks, page 50
• Navigating in SmartPlant Instrumentation, page 51
• Working with SmartPlant Instrumentation: An Overview, page 45

Switch to a Different Unit

1. Close all SmartPlant Instrumentation modules that are open.
2. Click File > Open.
3. On the Open dialog box, expand the <plant> and <area> hierarchies and
navigate to the <unit> you require.
4. Select a <unit> by doing one of the following:

• Double-click the <unit> icon.

• Click the <unit> once to highlight it, and then click OK.
Related Topics
• Getting Started Common Tasks, page 50
• SmartPlant Instrumentation Explorer: An Overview, page 206
• Working with SmartPlant Instrumentation: An Overview, page 45

Open a Module
1. Start SmartPlant Instrumentation.
2. Do one of the following:
• Click the appropriate toolbar icon for the module you want to open.
• On the Modules menu, click a desired module name.
Related Topics
• Getting Started Common Tasks, page 50
• Navigating in SmartPlant Instrumentation, page 51
• SmartPlant Instrumentation Explorer: An Overview, page 206

SmartPlant Instrumentation User’s Guide 53

Working with SmartPlant Instrumentation: An Overview

Setting General Preferences Common Tasks

The following tasks are used frequently when setting general preferences:

Display and Customize Preferences

Use this procedure to display the default preferences or set your own preferences in
SmartPlant Instrumentation. Your preference settings do not affect the preferences
that were defined by other users in the current domain or working in the current
project, if the domain type is Owner operator. For more information, see Display
and Customize Preferences, page 54.

Preferences Governed by the .INI File

Use this topic discusses the various preference settings that you can make in the
Intools.ini file. For more information, see Preferences Governed by the .INI File,
page 55.

Display and Customize Preferences

Important
• Domain Administrators have additional options that allow preferences
management from the Administration module.
• Certain interface options are governed by the Intools.ini file. For
details, see Preferences Governed by the .INI File, page 55.
1. Click File > Preferences.
2. In the tree view, beside a desired module, click to expand the hierarchy.
3. Click an option to open a specific page where you can view or customize
preferences.
Note
• The Domain Administrator can restrict the ability of other
users to set their preferences. Therefore, you may find that
you can only view certain options but not change their
values.
Related Topics
• Setting General Preferences Common Tasks, page 54

54 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Preferences Governed by the .INI File

Intools.ini
Document Number and Revision Level Segregation — In the Instrument Index
Standard Browser, when you make a document revision in one <unit> and then log
on to another <unit>, both <units> share the same document number and set of
revisions. To specify a separate document number and set of revisions for the current
<unit>, open the Intools.ini file, and under the [Index] section, type the following
line:
DrawingPerLevel = Y
This setting is needed if, for example, you are publishing documents from different
<units>.

Filter Setting — When you specify a filter setting such as a data range, and then
restart the software, the software updates the date range in every SmartPlant
Instrumentation module in which you use the same filter.

Honeywell Interface Activation — To activate the Honeywell Interface so that the

option is available on the Interfaces menu, type the following line:
Honeywell = Y

ID of the <Unit> Selected Last — When you select a specific <unit> on the Open
dialog box, the software records the <unit> ID in the Intools.ini file under the
[Project] section. The next time you start SmartPlant Instrumentation and display the
Open dialog box, the software displays the <unit> you selected last.

Performance when Generating Enhanced Reports — Sometimes, the response

time between the application server and the database server is very slow when
generating enhanced reports. To improve this performance, open the Intools.ini file,
and under the [Loop] section, change the value of the DDETimeOut parameter to
20000. This parameter has units of milliseconds.

Suppression of Loop Equipment Propagation to Tag Numbers by Default —

When you create a new loop, you can specify whether to apply the P&ID, service,
and equipment to tag numbers. By default, these options are selected; however, you
can specify not to propagate these values to tag numbers that you subsequently
associate with the loop. To do so, open the Intools.ini file, and under the [Index]
section, type the following line:
LoopNoPropagateCheck = 1
This setting prevents the software from removing the equipment reference from tag
numbers that you associate with a loop that has no equipment reference.

X and Y Positions of Certain Windows and Dialog Boxes — If you move a

certain window or dialog box in the screen area, the software saves the X and Y
positions of the window or dialog box in the Intools.ini file under the [Project]
section. This only applies to a small number of windows and dialog boxes.

SmartPlant Instrumentation User’s Guide 55

Working with SmartPlant Instrumentation: An Overview

Smartloop.ini
Hiding Macro Items when Generating Enhanced Reports — If, for a default
macro such as a panel name, you define a filter that hides a particular macro, a dot
appears in place of the macro. The dot is needed to allow editing of the macro filter,
adding new macros to the item associated with the hidden macro, or editing of the
item. If you want to hide the dots, for example when printing the report or saving it
in a different format, you need to define the parameter HideItems = Y in the
Smartloop.ini file.

Related Topics
• Setting General Preferences Common Tasks, page 54

Preferences Dialog Box

Customizing preferences allows you to automate a number of procedures. Your
preference settings do not affect the preferences that were defined by other
SmartPlant Instrumentation users in the current domain or working in the current
project, if the domain type is Owner operator.

The Domain Administrator can restrict the ability of other users to set their
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.

Tree view — Click beside a desired module to expand the hierarchy, and then
click an option to open a specific page where you can set your preferences.

Pages — Using the options on the pages, you can view the default preferences set
by the Domain Administrator. Also, you can overwrite certain default preferences
with you own settings, provided that the Domain Administrator has not disabled these
preferences.

Reset — Resets all the properties for the selected module to their default values.
This option appears when you select a module or some of the other categories such as
Enhanced Reports, Interfaces, or SmartPlant, at the highest level of the tree view.

Reset all — Resets all the properties in the Preferences dialog box to their default
values.

Import — Imports the domain/project preferences from the intools.ini file.

Export — Saves the domain/project preferences to an external .dmp or .txt file.

56 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

General (Preferences)
The options on the General page of the Preferences dialog box enable you to
customize the SmartPlant Instrumentation interface and set general application
preferences. These settings do not affect the preferences that were defined by other
SmartPlant Instrumentation users in the current domain or working in the current
project, if the domain type is Owner operator.

When customizing the general preferences, you can:

• Set the default locations of the main toolbar and the module toolbar.
• Set the toolbar and icon display.
• Automatically start SmartPlant Instrumentation with the unit and
module you last worked in.
• Set print preview options.
• Overwrite the default logo.
Note that the Domain Administrator can restrict your ability to set various
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.

Select toolbar — Allows you to select the toolbar whose display options you want
to define: Main Toolbar or Module Toolbar.

Show toolbar — Makes the currently selected toolbar visible in the application.
Clear the check box to hide the toolbar.

Show toolbar text — Displays text with the icons in the currently selected toolbar.
Clear the check box to hide the text.

Toolbar position — The following options enable you to set the toolbar the position
on your screen. Click the desired option:

• Top— Places the selected toolbar along the top of the screen right
under the menu bar.
• Bottom— Places the selected toolbar along the bottom of the screen.
• Floating— Makes the selected toolbar float on your screen.
• Right— Places the selected toolbar along the right edge of the screen.
• Left— Places the selected toolbar along the left edge of the screen.

SmartPlant Instrumentation User’s Guide 57

Working with SmartPlant Instrumentation: An Overview

Automatic start of the last module — Starts SmartPlant Instrumentation

automatically in the lowest level plant hierarchy item in which you last worked.
After you select this check box, the software bypasses the Select Unit dialog box and
automatically opens the last module that you worked in. If several modules were
open when closing SmartPlant Instrumentation, the software treats the active module
as the last one.

Overwrite logo — Retrieves automatically the current logo from the database and
overwrites the projlogo.bmp file in the [SmartPlant Instrumentation home
folder]\temp folder. The projlogo.bmp file is from where SmartPlant Instrumentation
takes the logo which is used in documents and reports. If you clear the check box, the
software retrieves the logo from the original bitmap file – in this way the
projlogo.bmp file is not changed when switching to another domain, so that you use
the same logo. Clearing the check box also speeds up your work.

Print preview options — The following options enable you to set a print preview
option for report generation.

• Always— Opens print previews automatically, without prompting

you for confirmation.
• Never— Automatically spools reports to the output device, without
prompting you for confirmation.
• Ask user (default) — Prompts you to open a report print preview
before printing.
Current report preview options — The following options enable you to compare a
new report displayed in the Print Preview window with an existing archived report.

• Mark changes only— Marks the changes in the print preview of a

new report, if the currently previewed report is different from the
archived report.
• Generate changes report only— Generates a changes report after
comparing a new report with an archived report.
• Mark changes and generate changes report— Generates a changes
report after comparing a new report with an archived report and marks
the changes in the print preview of the new report.
Display license expiration reminder … days in advance — Allows you to specify
the number of days (between 1 and 37) prior to license expiration that the software
will display an advance warning.

Temporary folder path — Allows you to specify the path to the SmartPlant
Instrumentation temporary folder where the software stores the temporary logo and
custom files. Click Browse to navigate to the path.
For example:

58 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

C:\Program Files\SmartPlant\Instrumentation\TEMP

In the temporary folder, the software creates temporary files during various activities
that you perform in SmartPlant Instrumentation. For example, when you create
specifications, generate CAD drawings, hook-up drawings, or reports, and so forth.

Notes
• In the Specifications module, when you generate the Spec Forms
report, the software generates the report as the specprn.psr file and
saves this file to the folder you specify in the Temporary folder path
box. If you leave this box blank, the software saves the specprn.psr
file to the SmartPlant Instrumentation home folder and not to the PSR
working folder path preference (on the Specifications >
Export/Import page).
• If your CAD application is MicroStation, make sure the path string
does not exceed fifty two characters. A longer path prevents
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation.
• If the System Administrator specified a global path in your domain,
the global path does not apply to the temporary folder path.
Output document folder — Enables you to specify the path to the folder where the
software generates IDEAL report files. Click Browse to navigate to the path.

Copy File Locations Dialog Box

This dialog box allows you to copy the file locations from one Enhanced Reports
module to another, for example; from Enhanced Loop File Locations to Cable
Layout File Locations.

Copy from — Choose from the list the enhanced report that you want to copy the
file locations from.

Copy to — Choose from the list one or more enhanced reports that you want to
copy the file locations to.

Select all — Select this option when you want to copy the file locations from one
enhanced report to all the enhanced reports.

Instrument Index > New Tag (Preferences)

These options allow you to customize the default tag number name template that
appears in the New Tag Number dialog box.

SmartPlant Instrumentation User’s Guide 59

Working with SmartPlant Instrumentation: An Overview

Define new tag name template — These options determine how SmartPlant
Instrumentation displays new tag number names in the New Tag Number dialog box
in relation to the previously created tag number.

• No default — The data field in the New Tag Number dialog box
will not display any default tag, letting you type the number you need.
• Same as the last created tag — The data field in the New Tag
Number dialog box displays the last created tag. You can accept the
displayed number, modify it, or type the number you need.
• Same as the last created tag + 1 — The data field in the New Tag
Number dialog box displays the last created tag plus 1 (one). You can
accept the displayed number, modify it, or type the number you need.
Note
• This option is available for numeric tag names only. If your tag names
are not numeric, the data field in the New Tag Number dialog box
will display the last created tag.
Ignore loop creation when creating new virtual tag — Allows you to create a
virtual tag without being prompted to create a loop associated with the new virtual
tag.

Use loop suffix in instrument tag — Allows you to include the loop suffix in the
name of a newly created instrument tag.

Instrument Index > New Loop (Preferences)

The options in this dialog box allow you to customize the loop number name template
that appears in the New Loop Number dialog box. You can also choose to propagate
the loop service description to the loop drawing reference if desired.

Define new loop name template — These options determine how SmartPlant
Instrumentation displays new loop number names in the New Loop Number dialog
box in relation to the previously created tag number.

• No default — The data field in the New Loop Number dialog box
does not display any default loop, letting you type the number you
need.
• Same as the last created loop — The data field in the New Loop
Number dialog box displays the last created loop. You can accept the
displayed number, modify it, or type the number you need.
• Same as the last created loop + 1 — The data field in the New
Loop Number dialog box displays the last created loop number

60 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

incremented by one. You can accept the displayed number, modify it,
or type the number you need.
• The last existing loop in the unit + 1 — The data field in the New
Loop Number dialog box displays the last existing loop number in the
current unit incremented by one. You can accept the displayed
number, modify it, or type the number you need.
• The last existing loop in the domain + 1 — The data field in the
New Loop Number dialog box displays the last existing loop number
in the current domain incremented by one. You can accept the
displayed number, modify it, or type the number you need.
Note
• The last three options are available for numeric loop names only. If
your loop names are not numeric, the data field in the New Loop
Number dialog box will display the last created loop.
Apply loop service to drawing description — Specifies that in the Loop Drawings
module, a loop service which you define for a loop appears in the Loop Drawing
List dialog box under the Description column. If you clear the check box, the
Description column remains empty.

Instrument Index > Profile (Preferences)

These options allow you to activate or deactivate instrument type profile settings
defined on the Instrument Type Profile dialog box. These preferences only apply
when you create new instruments. You can deactivate certain instrument type profile
settings if you are working in a multi-user environment. This enables creating new
tag numbers on your station according to your local preferences without affecting
global definitions made on the Instrument Type Profile dialog box.

For example, if you clear the Specifications check box, when creating a tag number,
the software ignores specification creation options defined on the General tab of the
Instrument Type Profile dialog box and creates the tag without any specification. If
you then manually generate a specification for the created tag, the software applies
the existing instrument type profile options.

Activate instrument type profile options — The following options allow you to
activate or deactivate instrument type profile options on the Instrument Type Profile
dialog box.

• Wiring— Wiring and I/O profile options.

• Specifications— Instrument specification and maintenance event
profile options
• Hook-ups— Hook-up profile options

SmartPlant Instrumentation User’s Guide 61

Working with SmartPlant Instrumentation: An Overview

• System I/O type— I/O type profile options

• Location— Instrument location profile options
• Custom tables— custom table profile options

Instrument Index > Browse (Preferences)

These options allow you to set your preferences for the browse option in the
Instrument Index module.

Browser view options

Open the Instrument Index module in a browser view — Starts the Instrument
Index module with the default browser view in the browser designated for use with
the Instrument Index module (the Instrument Index Standard Browser or a suitable
PowerSoft Browser). If the Instrument Index module was the last module that you
worked in, and on the General page you selected Automatic start of the last
module, SmartPlant Instrumentation starts with this browser view.

Open the Browser Manager to define a default view before opening — Select
this check box to require the user to select a view in the Instrument Index Standard
Browser or a suitable PowerSoft Browser before opening this browser view. Clear
this check box to open automatically the browser view set as the default in the
specified browser.

Fluid phase for process data — Selects the fluid phase to use as default when
generating new process data sheets for the tags selected in the browser view. The
available fluid phase options are Liquid, Water, Gas/Vapor, Steam, Solid/Powder.

Instrument Index > Duplicate (Preferences)

These options allow you to set your preferences for tag number duplication and tag
creation when running batch loop creation from typical loops. Depending on the
preferences that you set, when duplicating tags, the software can do one of the
following:

• Create new conventional tags based on the instrument type profile of

the source tag number, and when running batch loop creation, create
new conventional tags based on the instrument type profile of the
typical tag number defined for the selected typical loop. You cannot
create typical tags based on the instrument type profile of the source
tag.

62 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

• Create new tags based on the properties of the selected source tag
number, and when running batch loop creation, create new tags based
on the properties of the typical tags defined for the selected typical
loop in the Typical Tag Number Properties dialog box.
Instrument tag duplication and batch creation options
Create new tags according to profile options — Select this option to do the
following:

• Create new duplicated tag numbers based on the instrument type

profile of the source tag number. Note that you also have to activate
the required profile options on the Profile page of the Preferences
dialog box.
• Create new tags based on the instrument type profile of the typical tags
during batch loop creation. Note that you also have to activate the
required profile options on the Profile page of the Preferences dialog
box.
Duplicate source tag data — Select this option to do the following:

• Create new tags based on the properties of the selected source tag
number.
• Create new tags based on the properties of the typical tags defined for
the selected typical loop in the Typical Tag Number dialog box.
When duplicating a tag number, you can also include additional data associated with
source tag numbers. Select the appropriate check boxes below.

Note
• The following check boxes are not applicable when running batch loop
creation.
CAD blocks — Includes all the CAD blocks assigned manually to the source tag,
page numbering in the loop drawing where the blocks are located, and the X, Y, Z
offset coordinates of the block in the loop drawings. In the Loops folder of the
Domain Explorer, manually assigned blocks are shown under instruments as .

Note
• The CAD blocks preference does not apply to blocks assigned to
instruments using the automatic block assignment method. In the
Loops folder of the Domain Explorer, these blocks are shown under
instruments as . Such blocks are always duplicated under the target
instruments.
Specifications — Includes the specifications associated with the source tag. You
can include the process data information in the source specification only if you select
the Process Data check box as well.

SmartPlant Instrumentation User’s Guide 63

Working with SmartPlant Instrumentation: An Overview

Notes
• Instrument specifications are duplicated only if you select the Process
data check box too.
• When duplicating an instrument tag associated with a composite spec,
the software never duplicates the composite spec, regardless of the
preferences that you specify.
• When duplicating a loop, the software always duplicates the loop
composite spec.
Process data — Includes the process data information of the source tag. This
option is required if you want include tag source instrument specifications as well.

Wiring — Includes the entire wiring information of the source tag.

Include custom fields when copying (applicable for tag duplication and batch loop
creation) — Duplicates the tag and loop number with the custom fields of the source
loop, tag, or both.

Instrument Index > Delete Tag (Preferences)

These options allow you to set device cable and control system tag deletion options.
Also, you can enable batch tag deletion without being prompted to confirm the
deletion of each tag.

Delete device cables — Deletes all the device cables associated with the tag number
that you select to delete.

Delete associated control system tags — Deletes all the control system tags
associated with the tag you select to delete.

Change sequence of remaining tags after deletion — Allows you instruct the
software to automatically update tag sequence values in a loop when deleting a tag
number.

Instrument Index > Rename (Preferences)

These options allow you to specify how the software implements renaming of tag and
loop numbers.

Tag number
Display old tag number automatically — Enables automatic display of the old tag
number in the Old tag number field of the Tag Number Properties dialog box.
Clear the check box to leave the Old tag number field empty.

64 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Loop number
Display old loop number automatically — Enables automatic display of the old
loop number in the Old loop number field of the Loop Number Properties dialog
box. Clear the check box to leave the Old loop number field empty.

Apply loop number segment and suffix changes to tags — Enables you to apply
new loop segments to tags associated with this loop. After you change loop segments
in the Rename Loop Number dialog box, you can view both the old and the new list
of tag numbers for tags associated with this loop. Then, you can select those tags
whose segments will be changed automatically according to the loop segments.

SmartPlant Instrumentation User’s Guide 65

Working with SmartPlant Instrumentation: An Overview

Rename drawing file name when renaming the loop — Allows you to rename the
associated CAD drawing file names when renaming loop numbers. After you rename
a loop number, the software opens the Rename Loop Drawing File dialog box,
where you can change the drawing file names.

Instrument Index > Tag Properties (Preferences)

These options allow you to propagate line pipe spec data and P&ID drawing
reference to tag numbers that are associated with lines.

Propagate options
Propagate P&ID drawing when assigning tags to lines — After selecting this
option, on the Tag Number Properties dialog box, the software automatically
displays the P&ID drawing reference that is associated with the line for the current
tag number.

Propagate line pipe spec when assigning tags to lines — After selecting this
option, on the Tag Number Properties dialog box, the software automatically
displays the line pipe spec that is associated with the line for the current tag number.

Instrument Index > Move (Preferences)

This option allows you to specify how the software deals with naming conventions
for tag and loop numbers that you move to another <unit>.

When moving loops or tags

Complete tag or loop names using target naming convention properties — If the
target <unit> naming conventions contain segments that do not exist in the source
<unit> naming conventions, the software can automatically complete the name for
those segments using the properties of the tag or loop number you are moving. Select
this check box to complete the name of the target tag or loop number using the
property values.

For example, if you are moving Tag 101-FE – 100 to a <unit> that has a line number
segment in its tag naming convention, the software names the tag number in the target
<unit> as it was named in the source <unit> and retrieves the line number from the
tag properties to complete the line number segment.

Instrument Index > Custom (Preferences)

Use these options to customize features in the current module.

66 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Custom features for the Instrument Index module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Specifications > General (Preferences)

These options enable you to customize your preferences for the various options and
activities that you can perform in the Specifications module. These include:

• General options, such print options, process data changes notification,

and so forth.
• Opening a specification of an instrument tag selected in the browser
view for the Instrument Index module when starting the Specifications
module with the browser view open.
• Instrument tag creation and data copying options.
To access the general Specifications module preferences, in the Preferences dialog
box, in the tree view pane, click beside Specifications and then click General.

Show notes — For specification and form data template reports, to include notes —
or reference to the notes — on the first page, select Show notes. To omit notes —
or reference to the notes — from the first page, clear Show notes.

Edit fieldbus columns in specs — Allows you to edit data displayed in fieldbus
columns in specification sheets. If you clear the check box, all columns related to
fieldbus data become non-editable in specifications.

Note
• Although you can include fieldbus instruments in a multi-tag spec, the
software does not support editing of fieldbus columns in a multi-tag
spec. In a single-tag spec, you can only edit fieldbus columns if the
instrument type of the spec tag number is Fieldbus.
Print notes on a separate sheet — For specification and form data template
reports, to print the notes section on a separate page, select this check box. To print
notes as displayed, clear this check box. This setting also affects specifications that
you print as part of Binder Packages.

We recommend that you select this check box if the text in the Note box on the spec
data page is long, and the software displays a scroll bar in the Note box.

SmartPlant Instrumentation User’s Guide 67

Working with SmartPlant Instrumentation: An Overview

Display changes notification for process data — In order to have better

synchronization between users, it is prominent to be aware of the process data
changes modifications displayed in a specification for a certain instrument tag. You
can set the software to notify when the process data related to a certain tag has been
changed. If process data has been changed, the appropriate message appears when
you open an existing specification for that tag.

• Always (default) — The software notifies about process data

changes, regardless of whether the specification revision exists or not.
• Never— The software never notifies about process data changes.
• Only when spec revision exists— The software only notifies about
process data changes when the specification has a revision.
Browser view options
Open specification sheet — These options determine what happens when you click
with an instrument tag selected in the browser view.

• Always — If the selected instrument tag is already associated with a

specification, the specification is displayed automatically. If the
selected instrument tag is not associated with a specification, the
Select Specification Page dialog box opens, from which you can
select the page to be used to generate a new specification.
• Never — This option ignores the instrument tag selected in the
browser view and opens the Specifications dialog box as if you had
opened the Specifications module directly.
• Ask user (default) — This option prompts you to display the
specification. If you accept, the result depends on whether a
specification already exists for that tag. If the selected instrument tag
is already associated with a specification, the specification is
displayed. If the selected instrument tag is not associated with a
specification, the Select Specification Page dialog box opens, from
which you can select the page to be used to generate a new
specification.
Tag creation — These options determine if the user can create new tags from the
Specifications module.

• Not allowed (default) — The user cannot create new tags from the
Specifications module.
• Allowed— The user is able to create new tags in the Specifications
module.
Data copying options
This set of options allows you to specify how the software copies or imports data in
the following situations:

68 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

• Copying data from one specification to another

• Importing data from an external specification to the active
specification
• Copying data from the active form data template to the current
specification
• Copying data from a specification to a form data template
Select one of the following options:

• Copy without overwriting existing data— Copies data without

overwriting data that already exists in the target.
• Copy excluding blank fields in source— Copies data except for
source fields that are blank. A blank field is a field that does not
contain a value or only contains spaces.
• Copy all fields— Copies all data fields, overwriting all target data
fields. If there is a source field that does not have a value or only has
spaces, the software updates the corresponding target field
accordingly: if the target field has a value, after copying data, this field
becomes blank with no spaces.
Calibration profile forms
Reuse columns in form page — When defining multiple-point calibration forms,
the software reuses the same data columns (differentiated in the database as aliases
using a suitable suffix). You must select this check box to ensure that these data
columns can be reused so that all the calibration points appear correctly on the form.
This applies either if you define the calibration points in the Specification module
Page Editor by dragging the calibration point fields onto the page, or if you need to
regenerate a calibration form that includes multiple calibration points. If your
calibration forms include single-point calibrations only, you should clear this check
box.

Specifications > Multi-Tag Specifications (Preferences)

These options enable you to customize your preferences for the various options and
activities that you can perform when working with multi-tag specs in the
Specifications module. These include master tag display, the SEE LIST label
customization, tag assignment to process data cases, and so forth.

To access the multi-tag specification preferences, on the Preferences dialog box, in

the tree view pane, click beside Specifications and then click Multi-Tag
Specifications.

SmartPlant Instrumentation User’s Guide 69

Working with SmartPlant Instrumentation: An Overview

Use default print layout — This option affects the layout of the individual tag list
page printout for multi-tag specifications. If you select the check box, the default grid
layout, with one header per column, is applied. If you clear the check box, a multi-
line layout is applied to the specification format, if defined. It is possible to
customize a multi-line layout to display several headers per column. Also, you can
modify the font and column size.

Note
• Where no other format is defined, the default print layout will be used
whether or not this check box is selected.
Show master tag — Allows you to show the master tag number (in parentheses)
next to the multi-tag list in the Tag Number column of a multi-tag specification.

Use only governing case for multi-tag specs — Allows you to specify that only
one tag in a multi-tag specification can be assigned to a case (the governing case).
This preference only applies to new multi-tag specifications that you create. After
you select the check box, when creating a multi-tag specification, only one record of
the same tag appears in the Multi-Tag tab of the specification.

Selecting this check box affects the way SmartPlant Instrumentation displays tag
records of the same tag that is assigned to multiple process data cases. For example,
in the Find Items dialog box of the Specifications module, when a tag is assigned to
multiple cases, the software only displays the governing case.

If you clear the check box, when you create a multi-tag specification, you can add of
the cases in the Multi-Tag tab of the specification.

Customize the SEE LIST label — Allows you to change the default label SEE
LIST, which appears in the main pages of a multi-tag specification. In a multi-tag
specification, the SEE LIST label appears in every field that the multi-tag list format
contains. You can enter any combination of alpha-numeric characters (up to 20
characters) or leave the box blank.

Moving and removing tags from multi-tag list

This option enables you specify how the software behaves when you remove a tag
from a multi-tag list, or move a tag from a multi-tag to a single-tag specification.

Skip individual confirmation — Sets the software to skip a confirmation message

each time you remove a tag from a multi-tag list, or move a tag from a multi-tag list
to a single-tag specification.

If you clear the check box, the software displays a confirmation message each time
you remove a tag from a multi-tag list, or move a tag from a multi-tag list to a single
tag specification.

70 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Specifications > Save as Excel (Preferences)

Generated file path — Allows you to enter the path to the folder where you save
specifications in Excel format. If you leave this box blank, the software saves the
Excel files in the default folder, which is <SmartPlant Instrumentation home
folder>\SaveAsExcel\ResultFiles.

Global path — Displays the global path set by the System Administrator.

Saving method — These options affect both batch mode and individual mode of
saving specifications in Excel format.

• Common Excel file for tags with the same form — Creates a
unified Excel file for all of the specifications based on a given form.
This is the default setting.
• Separate file for each tag— Creates an individual Excel file for each
specification.
Accuracy level — Allows you to define the number of digits that appear after the
decimal point in the Excel file. You can use the spinners or type the number of digits.

Delete temporary Excel files — Deletes working files that the software creates in
the process of exporting specifications in Excel format.

Specifications > Export/Import (Preferences)

These options enable you set preferences when saving specifications as .psr files.
Also, you can specify a default folder for exporting specification data to .isf files, or
for importing specification data from .isf files.

PSR options
PSR working folder — Click Browse to select a working folder in which to keep
specification page files (in .psr format). For best performance, define a folder on
your client computer. If you do not define a PSR working folder, the software keeps
the files in the temporary folder path that you specify under the general preferences.

Note
• The .psr files that the software generates when opening a print preview
do not get saved in this folder but in the temporary folder. You
specify the temporary folder path on the General page of the
Preferences dialog box.
Global path — Displays the global path set by the System Administrator.

SmartPlant Instrumentation User’s Guide 71

Working with SmartPlant Instrumentation: An Overview

Overwrite PSR files — For best performance, make sure that this check box is
cleared. In some network configurations, however, a .psr working file may not be
properly updated from the database. In such a case, select this check box to overwrite
.psr files every time that you save specifications. Note that when you select this
check box, the performance of the software can slow down.

ISF export/import
Default export/import folder — Click Browse to select a folder that you want to
set as your default .isf file folder. The software will display this folder automatically
in all dialog boxes where you need to select a folder for importing data from .isf files,
or for exporting data to .isf files.

Specifications > Custom (Preferences)

Use these options to customize features in the current module. For details of
acceptable parameters and values, contact Intergraph Support, page ???.

Custom features for the Specifications module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

If, in the Report Management dialog box of the Administration module, the Domain
Administrator assigned the template title block Specs default TB with PB Units to
specifications, you need to place the title block correctly in the layout of a spec page.
To do so, enter the TitleFooterHeight parameter and define a value.

Value — Type the value of the parameter.

If you use the template title block Specs default TB with PB Units in specifications
you create using SmartPlant Instrumentation options, the optimal value is 798. If you
created a spec page in InfoMaker, you may need to enter a different value, depending
on your page layout settings.

Wiring > General (Preferences)

The general preferences for wiring allow you to enforce name uniqueness for wiring
items.

Naming options
Enforce unique names for wiring items — Select this check box to enforce the
name uniqueness for wiring items.

72 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Wiring > I/O Cards (Preferences)

These preferences allow you to determine if the software will allow to create multiple
wiring equipment items or just one item under a vacant slot.

To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click I/O Card.

Assign slots for racks

• All slots (vacant and occupied)— Allows you to create multiple
wiring equipment items or double-width I/O cards under vacant slots.
• Vacant slots only— Allows you to create only one wiring equipment
item per vacant slot. The software will not allow you to add a double-
width card or another wiring equipment item under an occupied slot.

Wiring > I/O Assignment (Preferences)

These preference options enable you to determine the I/O types of the instrument tags
that become available in the I/O Assignment window. One setting allows you to
make all instrument tags be available in the I/O Assignment window regardless of
their I/O type. The other setting limits the availability of instrument tags only to
those instruments whose I/O type is identical to the I/O type of the current I/O card.

Note that after you effect an I/O assignment and your preference was set to the Same
I/O type for tag and I/O card, you can still change the I/O type of the I/O card if
you need to do so. The software does not verify the compatibility of a changed I/O
type with instrument tags already associated with I/O cards.

To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click I/O Assignment.

I/O assignment validation

• Same I/O type for tag and I/O card — Limits the I/O type of the
instrument tag to be the same as the I/O type of the I/O card selected in
the I/O Assignment window. Note that the software validates I/O
type compatibility also upon connection.
• All I/O types — Allows the selection of all instrument tag I/O types
in the I/O Assignment window and upon connection.

SmartPlant Instrumentation User’s Guide 73

Working with SmartPlant Instrumentation: An Overview

Wiring > CS Tags (Preferences)

These options allow you to set the appropriate Control System tag name uniqueness
level. Control System tag name uniqueness can be set on the plant level or can be
customized. You can also choose to define your Control System tag names as not
unique.

To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click CS Tags.

CS tag name uniqueness — Use these options to determine at what level in the
Wiring module the software prevents duplication of a Control System tag name.

• Custom— Allows access to the following options where you can set
the Control System tag name uniqueness level separately for each
Control System, or for tag names not assigned to I/O cards.
• Per plant— Allows the use of a specific CS tag name in the plant
only once.
• Not unique— Allows the use of the same CS tag name more than
once at any level in the plant.
DCS uniqueness
The following options allow you to set the required uniqueness level for a Distributed
Control System (DCS):

• Plant— Set uniqueness at the plant level.

• Per panel— Set uniqueness at the panel level.
• Per terminal strip— Set uniqueness at the terminal strip level.
• Not unique— Allow use of the same Control System tag name at any
level.
PLC uniqueness
The following options allow you to set the required uniqueness level for a
Programmable Logic Controller (PLC):

• Plant— Set uniqueness at the plant level.

• Per panel— Set uniqueness at the panel level.
• Per terminal strip— Set uniqueness at the terminal strip level.
• Not unique— Allow use of the same Control System tag name at any
level.

74 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Unassigned CS tag
The following options allow you to set the required uniqueness level for Control
System tag names of tags that are not assigned to I/O cards:

• Unique— Allow the use of a CS tag name of an unassigned tag only

once.
• Not unique— Allow the use of the same CS tag name for any tag that
is not assigned to an I/O card.

Wiring > Copy Items (Preferences)

This preference allows you to determine whether to include jumpers, internal
connections, and cable lengths when duplicating wiring items.

To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Copy Items.

When copying items

Duplicate jumpers — Select this check box to include source panel jumpers in the
duplication process. Clear this check box to exclude source panel jumpers when
duplicating a panel.

Retain cable length — Select this check box to retain the cable length property
when copying or duplicating a cable. Clear this check box (default value) not to
retain the cable length of the source cable.

Copy internal connections — Select this check box to preserve the internal
connections within a copied item. This means that the software will retain the cables
and cross wires that connect among the various terminal strips within the item that
you are copying or duplicating.

Note that SmartPlant Instrumentation performs the operation described when

duplicating an item or when copying items from the Reference Explorer to the
Domain Explorer or from the Domain Explorer to the Reference Explorer as
follows:

• Cross wires and cross-cables— The software does not duplicate or

copy any cross wires or cables whose wires are also used to connect
terminal strips that are located outside of the terminal strip that you are
copying.
• System cross-cables— Internal connections that use system cross-
cables are duplicated even when other wires belonging to that cable
are connected to other items.

SmartPlant Instrumentation User’s Guide 75

Working with SmartPlant Instrumentation: An Overview

• User-created cross cables— Internal connections that use cross

cables created by users will be duplicated as long as all the wires of the
user-created cross cable are connected internally to the selected item.
If there are wires connected to another item, the user-created cross
cable will not be duplicated.
• Cables— Cables connected only on one end and not connected on
their other end will be duplicated when copying an item to which the
cable is connected. For example, when copying a junction box, the
connected cable will be duplicated if the multi-pair cable that is
connected on the terminal strip is not connected on its other end.
Device cables will not be duplicated if they are connected to device
panels.
• Jumpers — When duplicating jumpers, your Duplicate jumpers
preference setting overrides all other settings. Therefore, the software
duplicates jumpers only if you select the Duplicate jumpers
preference.
• Naming conventions— When the software creates a copy of a cable
during a duplication of an item, it uses the following naming
convention: Copy of +<source cable name>.

Wiring > Jumpers (Preferences)

This option allows you to set SmartPlant Instrumentation to name jumpers
automatically using the default naming format.

To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Jumpers.

Automatic naming
Name jumpers automatically — Allows you to select name jumpers automatically.
Select this check box in the following cases:

• When making connections using connection types whose definitions

contain jumpers. In this case, the software automatically names the
created jumpers using the following default format: J<first terminal
name>/<second terminal name>. For example, J1+/3sh. You
cannot modify the default format.
Clear this check box to name new jumpers by incrementing the jumper
number, for example J1/1, J1/2 and so forth.

76 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

• When adding new jumpers to a terminal strip in the Connection

window. In this case, the software suggests a jumper name in the New
Jumper Connection dialog box. The suggested jumper name is based
on the default format mentioned in the previous paragraph. You can
accept the suggested name or type another jumper name as needed.
Clear this check box to prevent the software from suggesting jumper
names when making new jumper connections on the New Jumper
Connection dialog box.
Propagate tag signal through jumpers — Allows you to instruct the software to
propagate tag signals through jumpers. If you do not select this preference, the
software will not propagate tag signals through jumpers.

Wiring > Reports (Preferences)

These preferences allow you to fine-tune the printing of wiring reports.

To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Reports.

General settings for Panel-Strip and I/O Map reports

Show wire tag and color in separate columns — Adds an additional column to
panel-strip reports. Adding an extra column improves the display of the cable, cable
set, wire, and color fields.

Include unclaimed As-Built items — Includes in the reports not only items
claimed for a specific engineering project, but also the items that have not been
claimed.

Restart pagination for each terminal strip when not previewing the report —
When not previewing a report before printing, restarts the pagination of the report for
each terminal strip. (This preference is available for reports with adjacent
connections only.)

Include channel information in Panel-Strip reports

I/O channels — Includes all the channels that are child items of terminal strips
under I/O cards.

Apparatus — Includes all the apparatus channels.

Channels — Includes all the channels that are not child items of terminal strips
under I/O cards.

SmartPlant Instrumentation User’s Guide 77

Working with SmartPlant Instrumentation: An Overview

Wiring > Cross Wiring (Preferences)

These options enable you to change the definitions for the matching signals whose
strips you cross-wire automatically.

To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Cross Wiring.

Automatic cross wiring

These options determine how the software implements cross wiring.

• Different strips, same panel— Performs automatic cross wiring of

two signals between two different strips belonging to the same panel
(this is the default selection).
• Different panels (no DCS or PLC panels)— Performs automatic
cross wiring of signals between two strips belonging to two different
panels in the current plant, except for strips with channels (that is, I/O
cards).
• Different panels including DCS or PLC panels (terminal sequence
connection) — Performs automatic cross wiring of signals between
two strips belonging to two different panels in the current plant,
including strips with channels where the connection will be done
according to the terminal sequence that is shown in the dialog box.
Note that we do not recommend using the third option unless you are
absolutely certain that this option will select matching signals. In any
case, do not forget to change the setting back to the default (Different
strips, same panel) when done!
Default wire color — Select the required wire color from the list. Selecting the
default wire color determines the cross-wire color in the Connection window. The
wire color data in the list is retrieved from the Wire Color dialog box.

Wiring > Custom (Preferences)

Use these options to customize features in the current module.

Custom features for the Wiring module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

78 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Process Data > General (Preferences)

The options on this page allow you to customize various options in the Process Data
module. You can enable automatic conversion of values when changing the units of
measure, select the default gas/vapor, liquid/water fluid state properties. You can
also determine how a process data sheet opens in the browser view.

To access the general Process Data module preferences, in the Preferences dialog
box, in the tree view pane, click beside Process Data and then click General.

General options
Convert units of measure automatically — Select this check box to automatically
convert numerical data when changing the units of measure.

Enable velocity auto recalculation — Select this check box to automatically

recalculate the velocity parameters for a control valve.

Highlight required process data properties — Select this check box to

automatically highlight the required fields in the Process Data window. Note that in
the Calculation module, the software also highlights the same fields in a calculation
sheet.

Browser view options

Open process data sheet — These options determine what happens when you click
with an instrument tag selected in the browser view.

• Always— Always opens a process data sheet for the tag selected in
the browser view when you open the Process Data module.
• Never— Never opens a process data sheet for the tag selected in the
browser view when you open the Process Data module.
• Ask user (default) — Prompts you whether you want to open a
process data sheet for the tag selected in the browser view when you
open the Process Data module.
Tag creation — Select an option to determine whether users are allowed to create
new instrument tags in the Process Data module.

• Allowed— Allows users to create new instrument tags in the Process

Data module.
• Not allowed— Prohibits users from creating new instrument tags in
the Process Data module.
Process data report display options — Allows you to determine how the software
displays the Notes field on the report by varying the area on the report taken up by
the custom fields. The available options are:

SmartPlant Instrumentation User’s Guide 79

Working with SmartPlant Instrumentation: An Overview

• Full-length custom fields — Each custom field occupies a full row

in the report. Select this option to display the Notes field in the
minimum available area.
• Short custom fields — Each group of custom fields occupies a
single row of the report. Select this option to display the Notes field in
an intermediate-sized area of the report.
• No custom fields — Custom fields do not appear on the report.
Select this option to display the Notes field in the maximum available
area.

Process Data > Custom (Preferences)

Use these options to customize features in the current module. For details of
acceptable parameters and values, contact Intergraph Support.

Custom features for the Process Data module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Calculation > General (Preferences)

These options enable you to customize preferences for opening calculation sheets.

To access the general Calculation module preferences, in the Preferences dialog box,
in the tree view pane, click beside Calculation and then click General.

Browser view options

Open calculation sheet — These options determine what happens when you click
with an instrument tag selected in the browser view.

• Always— Always opens a calculation sheet for the tag selected in the
browser view when you open the Calculation module.
• Never— Never opens a calculation sheet for the tag selected in the
browser view when you open the Calculation module.
• Ask user (default) — Prompts you whether you want to open a
calculation sheet for the tag selected in the browser view when you
open the Calculation module.
Tag creation — Select an option to determine whether users are allowed to create
new instrument tags in the Calculation module.

80 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

• Allowed— Allows users to create new instrument tags in the

Calculation module.
• Not allowed— Prohibits users from creating new instrument tags in
the Calculation module.

Calibration and Maintenance > Custom (Preferences)

Use these options to customize features in the Calibration module. For details of
acceptable parameters and values, contact Intergraph Support, page ???.

Custom features for the Calibration module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Loop Drawings > General (Preferences)

These options enable you to define various general loop drawing preferences and
some drawing preferences that are specific to the CAD program that you are using.

Plot drawing — Enables you to set the default option for printing CAD loop
drawings at the time of generation. After you select this check box, the software
automatically prints loop drawings you generate using your CAD application. This
preference affects the Send to plotter or printer check box selection on the CAD
Options tab of the Generate Loop Drawings dialog box.

Notes
• This preference does not affect printing loop drawings generated using
the Enhanced Report Utility.
• If you do not want to print CAD loop drawings but save them
automatically at the time of generation, clear this check box and then
specify the output drawing folder path on the Preferences > Loop
Drawings > CAD File Locations page.
• Regardless of this check box setting, when generating a batch of CAD
loop drawings, the software only opens the CAD drawing generated
last in the batch. It is not possible to set the software to open a print
preview of every CAD loop drawing when generating multiple loop
drawings.
Generate null macro list — Select this check box to generate a list of macros that
are used in the Macro report but which do not return a value when executed.

SmartPlant Instrumentation User’s Guide 81

Working with SmartPlant Instrumentation: An Overview

Generate undefined macro list — Select this check box to generate a list of macros
that are used in the Macro report but are not found in the SmartPlant Instrumentation
database.

Use macro functions — Select this check box to enable the use of macro functions
with macros in CAD drawings. You define macro functions in the Loop Drawings
module, in the User-Defined Macro Functions dialog box.

Display references to wiring reports automatically — Select this check box to

display references to wiring reports generated in the title block of a specific CAD
drawing. After generating a report in the Wiring module, a reference to this report
appears automatically in the Document Reference dialog box, where you can add a
reference description.

Explode block in AutoCAD — Enables you to edit the loop drawing by separating
the drawing block into elements.

Create error.log file — Select this check box to create the error.log file in the
location specified on the General preferences page under Temporary folder path.
This file is created during the loop generation process.

Use macro symbol (&) to retrieve data — Select this option according to the CAD
program you are using:

• For SmartSketch users — Always select this check box because in

SmartSketch all macros have the `&' prefix. If you clear the check
box, only the macro strings will appear in the drawings.
• For AutoCAD users — Select this check box if you have manually
added the `&' prefix to the macros. Any macros that do not have the
`&' prefix do not retrieve data in AutoCAD drawings but are displayed
only as macro strings.
MicroStation version — Select your MicroStation version from this list. The
available options are: MicroStation 95 and MicroStation SE/J.

AutoCAD macro result type — Select the required macro result from the list. This
way you determine the macro result type in AutoCAD while generating a loop
drawing. You can set the macro result type as Text or as Attribute.

Revision macro order — Select the relation between the order of revisions and the
order of the macros that you have set in the title block. The options are:

• Ascending— In ascending order, macro number 1 contains the first

added revision, so that the last added revision appears at the bottom of
the list in the title block.
• Descending— In descending order, macro number 1 contains the last
added revision, so that the last added revision appears at the top of the
list in the title block.

82 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Generation options — Select your default preferences for generating new loop
drawings. You can change these preferences manually when defining loop drawing
generation settings in the Generate Loop Drawings dialog box. From the list, select
one of the following:

• Per loop — Enables you to generate drawings using the loops

selected in the Domain Explorer.
• Per page — Enables you to type a desired page number in the Page
number box in the Generate Loop Drawings dialog box and generate
the specified drawing page only.
• Per block — Enables you to select a block from the Block name list
in the Generate Loop Drawings dialog box and generate loop
drawings only for the loops that use this block.
Default generation method — Allows you to specify the default method for
generating loop drawings from the Domain Explorer. The software uses the default
generating method if you do not specify any generation method for the loops you
select in the Domain Explorer. The following methods are available:

• Enhanced Report — Generates enhanced loop drawings using the

Enhanced Report Utility. When you select this option, you specify the
details of the generation method and other application-specific options
on the Enhanced SmartLoop > View (Preferences), page 98 and
Enhanced Reports - File Locations preferences pages.
• SmartSketch — Generates loop drawings using Intergraph
SmartSketch as the CAD program. You must specify the appropriate
file locations on the Loop Drawings > CAD File Locations
(Preferences), page 84 preferences page. You can also specify
application-specific options on this page.
• AutoCAD — Generates loop drawings using AutoCAD as the CAD
program. You must specify the appropriate file locations on the Loop
Drawings - CAD File Locations preferences page. You can also
specify application-specific options on this page.
• MicroStation — Generates loop drawings using MicroStation as the
CAD program. You must specify the MicroStation version on this
page and the appropriate file locations on the Loop Drawings - CAD
File Locations preferences page. You can also specify other
application-specific options on this page.
Date format — Type the date format for display in any loop drawing after
generation. The valid date formats are the same as the formats you use in Windows,
for example, dd/mm/yy, mm/dd/yyyy, and so forth).

SmartPlant Instrumentation User’s Guide 83

Working with SmartPlant Instrumentation: An Overview

Loop Drawings > CAD File Locations (Preferences)

These options enable you to define the default paths for generating and saving loop
drawings using your CAD application: SmartSketch, AutoCAD, or MicroStation.

Note for MicroStation Users

• MicroStation paths must not have spaces. Paths with spaces prevent
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation. If you installed MicroStation in the
default Program Files folder, you must reinstall MicroStation in a path
that does not have spaces.
Global path — Displays the global path set by the System Administrator.

CAD folder — Click Browse to navigate to the folder containing the executable file
of the CAD application installed on your computer. For example:
C:\Program Files\SmartSketch\program

CAD configuration folder — Click Browse to navigate to the folder containing the
CAD configuration file of the CAD application installed on your computer.

CAD function folder — Click Browse to navigate to the folder containing the CAD
function files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\CADFunc

Note
• If your CAD application is SmartSketch, the CADFunc folder contains
a shipped file pid.igr. This is a template file on which all your
SmartSketch drawings are based. The default print sheet size is
defined in the pid.igr file as A3 Wide. If you want to generate
drawings using a different print sheet size, you must open the pid.igr
file in SmartSketch and modify the sheet settings as you require.
Changes that you make in the pid.igr file affect both loop drawings
and hook-up drawings you generate in SmartSketch. If you want the
print sheet size of loop drawings not to affect the print sheet size of
hook-up drawings, duplicate the CADFunc folder with all its content
and define a different path setting preference for hook-up drawings on
the Hook-Ups > CAD File Locations page.
Important
• If your CAD application is MicroStation, make sure the path string
does not exceed fifty two characters. A longer path prevents
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation. If your CAD function folder path is
longer than allowed, you need to copy the CADFunc folder and its
content to another location, for example, C:\CAD\CADFunc.

84 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Open drawing files from — Click Browse to navigate to the default folder from
which saved loop drawings are to be opened. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\DWG

Drawing block folder — Click Browse to select the path to be used as the default
for new block files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\Blocks

Save drawings automatically — Enables you to define the default path for saving
CAD loop drawings automatically as files at the time of generation.

Output drawing folder (available after selecting Save drawings automatically) —

Enables you to click Browse and then specify the default path for saving CAD loop
drawings automatically as files at the time of generation. The path that you specify
appears on the General tab of the Generate Loop Drawings dialog box when you
select the CAD generation method. On the Generate Loop Drawings dialog box,
you can modify the path for a specific generation. When generating a batch of loop
drawings using the As previously applied option on the Generate Loop Drawings
dialog box, the software always uses the preference setting. The following setting is
an example of the default folder where you want the software to save all your CAD
loop drawings automatically:
C:\Program Files\SmartPlant\Instrumentation\CAD\My CAD Loop
Drawings

The file format of the saved files depends on the CAD application you have selected.

Loop Drawings > Custom (Preferences)

Use these options to customize features in the current module.

Custom features for the Loop Drawings module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Browser > Reports (Preferences)

These options enable you to define the printing preferences for the Browser module
reports.

Printing without preview

These options allow you to customize your printout when printing without a preview
if the total column width exceeds the width of your page.

SmartPlant Instrumentation User’s Guide 85

Working with SmartPlant Instrumentation: An Overview

Print all columns if exceeding page width — Select this option if the width of
your paper cannot accommodate all the columns of the report. When you select this
option, the software prints out subsequent pages containing the additional columns
that do not fit the width of the first page. If you do not select this option and your
report has more columns than the width of your paper can allow for, only the columns
that fit the paper width are printed out.

Show first column on each page — If you selected Print all columns if exceeding
page width, you can select this option to print out the first column on every page of
the report. This is helpful for showing on each printed page which items the rest of
the data belongs to.

Browser > Fonts (Preferences)

These options enable you to set the font properties of the headers and body text in all
windows in the Browser module, including report sheets.

Font — Select a font from the list of available Windows fonts.

Font style — Select a font style from the list of available styles: Regular, Italic,
Bold, or Bold Italic.

Size — Select a font size from the list of available font sizes.

Sample — Indicates the appearance of the font according to the properties that you
have selected.

Reset — Resets the SmartPlant Instrumentation font defaults for body text in the
Browser view and in the Print Preview window in the Instrument Index module.
The font defaults are:

• Font – MS Sans Serif

• Font style – Regular
• Size – 8

Browser > Custom (Preferences)

Use these options to customize features in the current module. For details of
acceptable parameters and values, contact Intergraph Support.

Custom features for the Browser module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

86 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Hook-Ups > General (Preferences)

These options allow you to customize general hook- up drawing preferences, such as
generation settings, drawing block path, macro symbol, and so forth. Also, you can
set tag association preferences and preferences for displaying a prompt message when
removing a hook-up type from an instrument type. Note that you define the CAD
program and file locations for hook-ups under the Loop Drawings preferences.

General drawing preferences — You use these options to define your general
drawing that appears on the second and all other subsequent sheets of any multi-sheet
hook-up drawings that you generate. You must define these options to enable the
General drawing option in CAD tab of the Generate Hook-Up Drawings dialog
box.

Drawing block name

Enter the required block name as follows, depending on the CAD application
installed on your machine:

• For Enhanced Report Utility — Type the name of the drawing

block that you have selected in the Drawing block file name and
path box.
• For MicroStation — Type the name of the cell in the cell library
that you have selected in the Drawing block file name and path box.
• For SmartSketch or AutoCAD— The value in this field appears
automatically after you specify the drawing block file name and path.
Drawing block file name and path

Click Browse to navigate to the required file or enter the required file name as
follows, depending on the CAD application installed on your machine:

• For Enhanced Report Utility— Type the exact path of a .dwg file.
• For SmartSketch— Type the exact path to a .sym .dwg or .dgn file.
• For AutoCAD— Type the exact path of a .dwg file.
• For MicroStation— Type the exact path of a cell library (.cel file).
Global path

Displays the global path set by the System Administrator.

Use global border/logo

Select this check box when you do not have your own border and logo, in order to use
the Default General Blocks dialog box options to specify the border and logo for all
of your hook-up drawings. Note that if you already have your own border and logo in

SmartPlant Instrumentation User’s Guide 87

Working with SmartPlant Instrumentation: An Overview

the hook-up drawings, selecting the check box and defining the border and logo in the
Default General Blocks dialog box cause the software to display two borders and
two logos in the same hook- up drawing.

Clear this check box to insert the border and logo using your CAD application. This
check box is only available after selecting Enable hook- up drawing generation.

Use macro symbol (&) to retrieve data

• For SmartSketch — If you use SmartSketch, you must

select this check box because in SmartSketch all macros
have the & prefix. If you clear the check box, the software
displays only macro properties in the drawings.
• For AutoCAD — Select this check box if you manually
added the & prefix to the macros. Note that in this case,
macros that do not have the & prefix do not retrieve any
data in AutoCAD drawings but are displayed only as macro
properties.
Revision macro order

Select the relation between the order of revisions and the order of the macros that you
have set in the title block.

• Ascending— In ascending order, macro number 1 contains the first

added revision, so that the last added revision appears at the bottom of
the list in the title block.
• Descending— In descending order, macro number 1 contains the last
added revision, so that the last added revision appears at the top of the
list in the title block.
Tag association — Selects the allowed assignments of tags to hook-ups.

• Limit to a single hook-up type— Restricts the assignment of each

tag number to one particular hook-up only.
• Limit to a single hook-up type— Restricts the assignment of each
tag number to one hook-up type only.
• Do not limit— Allows you to assign each tag to any hook-up without
restriction.
Remove hook-up type from instrument type

88 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Display prompt messages

Select this check box if you want the software to prompt you before removing a
hook-up type from an instrument type.

Units of measure for hook-up items — Determines whether you can assign a unit
of measure name or code to a hook-up item when defining or modifying hook-up item
properties. The software displays codes or names of hook-up item units of measure
in the Item Properties dialog box, in the Units of measure list.

• Display unit of measure names — Allows you to display the names

in the Units of measure list.
• Display unit of measure codes — Allows you to display the codes
in the Units of measure list.
Default generation method — Allows you to specify the default method for
generating hook-up drawings from the Domain Explorer. The software uses the
default generating method if you do not specify any generation method for the hook-
ups or hook-up types you select in the Domain Explorer. The following methods are
available:

• Enhanced Report— Generates hook-up drawings using the

Enhanced Report Utility.
• SmartSketch— Generates loop drawings using Intergraph
SmartSketch as the CAD program.
• AutoCAD— Generates loop drawings using AutoCAD as the CAD
program.
• MicroStation— Generates loop drawings using MicroStation as the
CAD program.

Hook-Ups > CAD File Locations (Preferences)

These options enable you to define the default paths for generating and saving hook-
up drawings using your CAD application: SmartSketch, AutoCAD, or MicroStation.

Note for MicroStation Users

• MicroStation paths must not have spaces. Paths with spaces prevent
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation. If you installed MicroStation in the
default Program Files folder, you must reinstall MicroStation in a path
that does not have spaces.
Global path — Displays the global path set by the System Administrator.

SmartPlant Instrumentation User’s Guide 89

Working with SmartPlant Instrumentation: An Overview

CAD folder — Click Browse to navigate to the folder containing the executable file
of the CAD application installed on your computer. For example:
C:\Program Files\SmartSketch\program

CAD configuration folder — Click Browse to navigate to the folder containing the
CAD configuration file of the CAD application installed on your computer. For
example:
C:\Program Files\SmartSketch\program

CAD function folder — Click Browse to navigate to the folder containing the CAD
function files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\CADFunc

Note
• If your CAD application is SmartSketch, the CADFunc folder contains
a shipped file pid.igr. This is a template file on which all your
SmartSketch drawings are based. The default print sheet size is
defined in the pid.igr file as A3 Wide. If you want to generate
drawings using a different print sheet size, you must open the pid.igr
file in SmartSketch and modify the sheet settings as you require.
Changes that you make in the pid.igr file affect both hook-up drawings
and loop drawings you generate in SmartSketch. If you want the print
sheet size of hook-up drawings not to affect the print sheet size of loop
drawings, duplicate the CADFunc folder with all its content and define
a different path setting preference for loop drawings on the Loop
Drawings > CAD File Locations page.
Important
• If your CAD application is MicroStation, make sure the path string
does not exceed fifty two characters. A longer path prevents
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation. If your CAD function folder path is
longer than allowed, you need to copy the CADFunc folder and its
content to another location, for example, C:\CAD\CADFunc.
Open drawing files from — Click Browse to navigate to the default folder from
which saved hook-up drawings are to be opened. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\DWG

Drawing block folder — Click Browse to select the path to be used as the default
for new block files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\Blocks

90 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Copy file locations from CAD loop drawings

Copy — Copies file location preferences set on the Loop Drawings > CAD File
Locations tab. This overrides all the existing settings that appear on the current tab.

Save drawings automatically — Enables you to define the default path for saving
CAD hook-up drawings automatically as files at the time of generation.

Output drawing folder (available after selecting Save drawings automatically) —

Enables you to click Browse and then specify the default path for saving CAD hook-
up drawings automatically as files at the time of generation. The path that you
specify appears on the CAD Options tab of the Generate Hook-Up Drawings dialog
box when you select CAD as a generation method or use the As previously applied
option to generate a batch of hook-up drawings in mixed mode. On the CAD
Options tab of the Generate Hook-Up Drawings dialog box, for a specific
generation, you can modify the default path setting if needed. The following setting
is an example of the default folder where you want the software to save all your CAD
hook-up drawings automatically:
C:\Program Files\SmartPlant\Instrumentation\CAD\My CAD Hook-Up
Drawings

The file format of the saved files depends on the CAD application you have selected.

Hook-Ups > Reports (Preferences)

These options allow you to set or customize item display options in certain reports
that you can generate in the Hook-Ups module.

Tag display level — You can set the software to display tag numbers on the highest
or lowest level of your plant hierarchy. This setting apply to BOM, Hook-Up Tag list
report, and hook-up drawings. Note that in the Domain Explorer or Hook-Up
Explorer, tag numbers and other items are always displayed on the lowest plant
hierarchy level. The default highest level is Plant. The default lowest level is Unit.
The Domain Administrator makes plant hierarchy level definitions in the Plant
Hierarchy dialog box of the Administration module.

• Highest plant hierarchy level — Allows you to display tag numbers

in reports on the highest level of the plant hierarchy. This way you
include in a report all tag numbers that appear in all <units> that
belong to the current highest plant hierarchy level item.
• Lowest plant hierarchy level — Allows you to display tag numbers
in reports on the lowest level of the plant hierarchy, that is, tags
displayed in the Domain Explorer or Hook-Up Explorer for the
current <unit>.
Show pipe spec names in reports — Select this check box to display the pipe spec
names of pipe specs associated with hook-up sub- libraries.

SmartPlant Instrumentation User’s Guide 91

Working with SmartPlant Instrumentation: An Overview

Bill of Material
Hide item number row when total quantity is zero — Allows you not to include
in BOM the item number whose quantity is zero.

Enable the use of edit mode — Allows you to select the Edit mode check box in a
BOM print preview.

Sort hook-up items in generated drawings — Use these option buttons to

determine how the hook-up items are sorted in reports.

• By item number— Allows you to sort the hook-up items in order of

the item numbers.
• By item order— Allows you to sort the hook-up items by their order
of their assignment to a hook-up.

Hook-Ups > Custom (Preferences)

Use these options to customize features in the current module.

Custom features for the Hook-Ups module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Document Binder > General (Preferences)

Printing and revision location — These options determine whether you can work
with SmartPlant Instrumentation during generation of revisions or preparation of
document packages for printing. The options are:

• Client— Select if you are working with a client installation of

SmartPlant Instrumentation.
• Remote server— Select if you use APITools to generate revisions
and prepare document packages for printing.
Include external documents in page numbering — Select to include in the page
numbering external documents that appear in a General Document Binder package.
Clear the check box to include only SmartPlant Instrumentation documents in the
page numbering. Note that the option to include external documents only applies
when you set the page numbering options for General Document Binder packages to
Consecutive page numbering for all documents.

92 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Document Binder > Specification Binder (Preferences)

These options enable you to customize viewing format for the Specification List in
the Document Binder window.

Select specification list display — These options determine the specification list
layout setup in a print preview and how it is printed. The options are:

• Fixed columns— Use to display the specification list with a fixed set
of pre-defined columns. The orientation of the list is portrait when
printed.
• User defined columns from Browser module— Use to display the
specification list with the columns defined in the default view for the
Document Binder Browser group. The orientation of the list is
landscape when printed.
Revision options
When removing specifications, delete associated specification binder revisions
— When you remove a specification from a Specification Binder package, select this
check box to specify deletion of Specification Binder package revisions. Clear the
check box to keep the revisions when you remove the specification.

View specification and specification binder revisions independently — Select to

view separate listings for revisions of a specification when it was independent and
when it was part of a Specification Binder package. This means that in the Document
Binder module, a specification displays only revisions created since you added it to
the Specification Binder package, and in the Specifications module, the specification
displays only revisions created before you added it to the Specification Binder
package.

Clear to view a unified revision listing. This means than in either module, when you
open a given specification, it displays all revisions that you created for that
specification.

Changes report options — These options determine how the software compares
the current report with previous revisions. The options are:

• Compare current report with last revision only— When running a

comparison report, the software always compares the current report
with the last saved revision.
• Compare current report with any previous revision— When
running a comparison report, the software allows you to select a
previously saved revision to compare with.

SmartPlant Instrumentation User’s Guide 93

Working with SmartPlant Instrumentation: An Overview

Re-order tags automatically by tag number when adding new instrument

specifications. — Select to display the tags in tag number order after adding new
instrument specifications to the Specification Binder package. Clear the check box to
display the tags in the order that they were added to the package.

Document Binder > General Document Binder (Preferences)

This option determines the format in which the software displays reports. Your
selection only affects those reports for which an option exists to display them as
enhanced reports or as standard SmartPlant Instrumentation reports.

Report display format

Enhanced reports (where available) — When selected, displays the report as an
enhanced report, if the specified report is available in this format. When cleared,
displays the report using the standard (PowerSoft) report format.

Document Binder > Custom (Preferences)

Use these options to customize features in the current module.

Custom features for the Document Binder module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Calibration and Maintenance > General (Preferences)

These preferences allow you to set the default point at which the software performs a
loop error calculation. These settings do not affect the preferences that were defined
by other SmartPlant Instrumentation users in the current domain or working in the
current project, if the domain type is Owner operator. Also, it is possible to set
preferences that determine how the software defines maintenance event record names
when users create such records in As-Built.

The Domain Administrator can restrict the ability of other users to set their
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.

To access these preferences, on the Preferences dialog box, in the tree view pane,
click Calibration and Maintenance > General.

94 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Validations
Validate mandatory fields for data entry — Select to generate warning messages
where the user does not enter data values in mandatory fields; clear to ignore any data
that is missing in those fields.

Loop error calculation

Calculation method — Select a calculation method from this list to determine how
a loop error will be calculated. The options are:

• Ask user — Select to open the Loop Error Calculation Method

dialog box, where you can select the desired loop error calculation
method.
• Normal— Select to calculate a loop error automatically according to
normal values.
• Absolute— Select to calculate a loop error automatically according to
absolute values.
• Root Mean Square— Select to calculate a loop error automatically
according to root mean square values.
Calculate at point — Type a number from 1-100 or use the spinners to enter the
default percentage point at which the software performs the loop error calculation.

Reports
Display AF and AL graphs in the Instrument Calibration Result report to print
all pages of this report including the As Found and As Left graphs that appear on the
second page of the report. Clear the check box to print only the tabular data that
appears on the first page of the report.

Define maintenance event record name by

The following options enable you to determine how the software defines a name for a
maintenance event record that you can create in the Instruments folder of the
Domain Explorer. Names of maintenance event records accept up to fifty
characters.

• Tag number, then event date— The maintenance event records are
displayed as follows: 101 -FT -100 02-03-07.
• Event date, then tag number— The maintenance event records are
displayed as follows: 02-03-07, 101 -FT -100. We recommend that
you select this option if you instrument tag number strings are long.
When you create a maintenance event record, the record name
characters that exceed sixty characters are truncated.
• Event date only— The maintenance event records are displayed as
follows: 02-03-07.

SmartPlant Instrumentation User’s Guide 95

Working with SmartPlant Instrumentation: An Overview

Note
• If you set the software to create maintenance event record names using
a combination of tag number and date, the software automatically
inserts a space character between the tag number and date. The date
format depends on the Maintenance event date format preference.
Maintenance event date format — Allows you to specify a date format that the
software uses when defining names of maintenance event records. The valid date
formats are the same as the formats you use in Windows, for example, dd/mm/yy,
mm/dd/yyyy, and so forth).

Calculation > Custom (Preferences)

Use these options to customize features in the current module.

Custom features for the Calculation module

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Enhanced Reports > General (Preferences)

Use these options to customize the display of items for all enhanced report types
before generation. Also, you can set your preferences for the generation status
window.

General
Show generation status window — Select to show the generation status window
when generating enhanced reports. Note that the items that appear in the window do
not reflect the actual items that in the reports after generation.

Display warning message when closing document — Select to display a warning

message in the Enhanced Report Utility whenever you close a report. Clear this
option if you do not want to receive a warning message every time you close a report.

View
View-only mode — Select to open the report in view-only mode. Clear to allow
editing of the report, redlining, saving, and so forth.

Display color property of cross wires — Select to display labels indicating the
colors of cross wires where defined. Clear to hide the color labels.

96 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Sort wires by wire sequence in set — Select to sort wires according to the
sequence number in the cable set. Clear to sort wires according to the wire IDs. If
you are not sure that the wire IDs match the actual sequence of the wires, for
example, if you imported cable data or added wires manually, it is recommended that
you select this option.

Split strip display between sheets — Select to display strips in a split manner
between two sheets where those strips would otherwise appear on the margin of one
of the drawing sheets.

Enlarge terminals with multiple connections — Select to enlarge terminals with

multiple connections so that you can view all the multiple connections separately.
When a terminal has several connections, the software duplicates this terminal as
many times as there are connections and displays this terminal as one item that
contains several terminals attached underneath each other.

Replace missing symbols with default terminal symbol — Select to replace all
terminal symbols that the software cannot find with the default terminal symbol
term.sym. Clear this check box to display the text `Symbol is missing' for all terminal
symbols that the software cannot find.

Drawing
Disable macro generation and annotation options — Select to disable macro
generation in enhanced reports and also to disable macros, SmartText and redlining.
Disabling these options speeds up report generation.

Gap connectors on intersection — Select to specify that connector lines that are
crossed appear in generated enhanced reports with gaps on intersections. The
connector that appears with a gap is the connector that is generated second. Clear this
option to speed up report generation.

By-pass strips — Select to re-draw any connector lines that intersect strips so that
those connector lines by-pass the strips. Clear this option to speed up report
generation.

Redraw all connections — Select to redraw all the connectors on the sheet to
minimize the number of connector overlaps and intersections. Clear this option to
speed up report generation.

Optimize overlapping connectors — Select to separate overlapping connectors

from one another. Clear this option to speed up report generation.

Optimize overlapping wires and cable sets — Select to separate the lines that
represent different sets and wires of a particular cable where they overlap one
another. Clear this option to speed up report generation.

SmartPlant Instrumentation User’s Guide 97

Working with SmartPlant Instrumentation: An Overview

Enforce wiring connections to opposite sides of adjacent terminals — Select to

force the Enhanced Report Generator to always draw wiring connections from the
right side of one terminal to the left side of the adjacent terminal when the
configuration was wired between the left sides of both terminals, or between the right
sides of both terminals.

Set loop drawing orientation from right to left (top to bottom, custom mode
only) — Select to generate the drawing with field devices drawn at the right edge of
the drawing sheet, or from top to bottom (vertical orientation) of the drawing sheet.
Clear to generate the drawing in the conventional way with the with field devices
drawn at the left edge of the drawing sheet.

Copy file locations — Opens the Copy file locations dialog box to allow you to
copy the data on the File Locations tab of a specific enhanced report type to one or
more other enhanced report types.

Enhanced Reports > Layers (Preferences)

SmartPlant Instrument allows you to predefine up to six different layer names for use
when generating reports in the Enhanced Report Utility. These layers can then be
used to display different attributes of your drawing, such as symbols, texts, wiring
and so forth. You can then select to see one specific layer or a combination of certain
layers. These layers can then be transferred to AutoCAD and MicroStation formats
when saved as an external file.

Use these options to customize the names of the layers used in enhanced reports.

Layers
Shows a list of the enhanced report layers.

Name — Describes the use of the layer.

Value — Type your own names for each layer as desired.

Note
• If you leave a field value empty, the layer will not be available for
selection. Any items that would be created on the unnamed layer are
created on the default layer instead.

Enhanced SmartLoop > View (Preferences)

Use these options to customize the display of items in Enhanced SmartLoop reports
before generation.

98 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

Overall shield connected to another strip (without signal) — Select to display the
overall shield (without signal) connected to another strip. If you clear the check box
this strip is not displayed, unless it has a signal in which case it is displayed whether
the checkbox is checked or cleared.

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Unconnected DCS / PLC terminals — Select to display unconnected DCS / PLC

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Unconnected Apparatus terminals — Select to display unconnected Apparatus

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Vertical orientation — Select to display the drawing vertically (custom generation

only or when no layout has been defined for a drawing).

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Loop drawing reference — Select to display on the report a reference to an

external drawing.

CS block when tag has no wiring — Select to display Control System tags that are
assigned to the generated loop where those Control System tags do not have wiring
connections.

Instrument list — Select to display a list of instruments on the report that do not
have wiring. When displaying the list, the following options are available:

• All instruments in loop— Displays instruments that are included in

the loop wiring as well as non-wiring instruments.

SmartPlant Instrumentation User’s Guide 99

Working with SmartPlant Instrumentation: An Overview

• Non-wiring instruments only— Displays only those instruments that

are not included in the loop wiring.
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Panel-Strip > View (Preferences)

Use these options to customize the display of items in Panel-Strip reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

Overall shield connected to another strip — Select to display the overall shield
connected to another strip. If you clear the check box, this strip is not displayed.

100 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Unconnected DCS / PLC terminals — Select to display unconnected DCS / PLC

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Unconnected Apparatus terminals — Select to display unconnected Apparatus

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Leftmost strip descriptions on the left — Select to place all the descriptions of the
leftmost strips to the left of the strips. Clear this check box to retain all the
descriptions of the leftmost strips above the strips.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross-wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

SmartPlant Instrumentation User’s Guide 101

Working with SmartPlant Instrumentation: An Overview

Wiring Equipment Connections > View (Preferences)

Use these options to customize the display of items in Wiring Equipment Connections
reports before generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

Overall shield connected to another strip — Select to display the overall shield
connected to another strip. If you clear the check box, this strip is not displayed.

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Unconnected Apparatus terminals — Select to display unconnected Apparatus

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

General signals assigned to strips — Select to display general signals such as

power supplies or multiplexed wiring, that are assigned to strips.

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.

102 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Segment Wiring > View (Preferences)

Use these options to customize the display of items in Segment Wiring reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

Overall shield connected to another strip — Select to display the overall shield
connected to another strip. If you clear the check box, this strip is not displayed.

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Unconnected DCS / PLC terminals — Select to display unconnected DCS / PLC

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Unconnected Apparatus terminals — Select to display unconnected Apparatus

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

SmartPlant Instrumentation User’s Guide 103

Working with SmartPlant Instrumentation: An Overview

General signals assigned to segments — Select to display general signals such as

power supplies or multiplexed wiring, that are assigned to wiring segments.

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Virtual tags — Select to display the existing virtual tags in a generated segment
wiring report.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross-wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Communication Line > View (Preferences)

Use these options to customize the display of items in Communication Line reports
before generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

104 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Display options
DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Internal Cross Wiring > View (Preferences)

Use these options to customize the display of items in Internal Cross- Wiring reports
before generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

SmartPlant Instrumentation User’s Guide 105

Working with SmartPlant Instrumentation: An Overview

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Fieldbus Loop > View (Preferences)

Use these options to customize the display of items in Fieldbus Loop reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

Overall shield connected to another strip — Select to display the overall shield
connected to another strip. If you clear the check box, this strip is not displayed.

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Unconnected DCS / PLC terminals — Select to display unconnected DCS / PLC

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

106 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Unconnected Apparatus terminals — Select to display unconnected Apparatus

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Vertical orientation — Select to display the drawing vertically.

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Loop drawing reference — Select to display on the report a reference to an

external drawing.

CS block when tag has no wiring — Select to display Control System tags that are
assigned to the generated loop where those Control System tags do not have wiring
connections.

Instrument list — Select to display a list of instruments on the report that do not
have wiring. When displaying the list, the following options are available:

• All instruments in loop— Displays instruments that are included in

the loop wiring as well as non-wiring instruments.
• Non-wiring instruments only— Displays only those instruments that
are not included in the loop wiring.
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross - wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.

SmartPlant Instrumentation User’s Guide 107

Working with SmartPlant Instrumentation: An Overview

Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Network Class > View (Preferences)

Use these options to customize the display of items in Network Class reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross - wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.

108 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

• Orthogonal— Represents connectors as lines consisting of horizontal

and vertical sections.
Note
• When generating an enhanced report with many
connectors, where the layout settings for the connectors are
set to diagonal, the connector names do not appear directly
over their respective connectors.

Strip Signals > View (Preferences)

Use these options to customize the display of items in Strip Signal reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

Overall shield connected to another strip — Select to display the overall shield
connected to another strip. If you clear the check box, this strip is not displayed.

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Unconnected DCS / PLC terminals — Select to display unconnected DCS / PLC

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Unconnected Apparatus terminals — Select to display unconnected Apparatus

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

SmartPlant Instrumentation User’s Guide 109

Working with SmartPlant Instrumentation: An Overview

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Single Speaker > View (Preferences)

Use these options to customize the display of items in Single Speaker reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

110 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Report end point level — Select to specify whether to report the end point level
from Amplifier or DCS.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Enhanced PA Amplifier > View (Preferences)

Use these options to customize the display of items in PA Amplifier reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

SmartPlant Instrumentation User’s Guide 111

Working with SmartPlant Instrumentation: An Overview

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Cable Block Diagram > View (Preferences)

Use these options to customize the display of items in Cable Block Diagram reports
before generation.

Enhanced Reports > Hook-Ups > View (Preferences)

Use these options to customize the display of items in enhanced hook-up drawings
before generation.

Display options
Use these options to display a tag list and an associated item list on your hook-ups
drawing.

112 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Tag list — Select this check box to display the tag list on your hook-ups drawing.
Clear the check box not to show the tag list.

Associated item list — Select this check box to display the associated item list on
your hook-up drawing. Clear the check box not to show the associated item list.

Panel-Signals > View (Preferences)

Use these options to customize the display of items in Panel-Signals reports before
generation.

Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.

Display options
All jumpers — Select to display all the jumpers between the entry and exit points of
a signal on a cabinet. Clear to display one line for all the midway jumpers.

Overall shield connected to another strip — Select to display the overall shield
connected to another strip. If you clear the check box, this strip is not displayed.

DCS / PLC attributes — Select to display the attributes of DCS / PLC devices
when placing them on the drawing layer. The displayed attributes are: whether it is
connected to a CS tag, channels, number of slots and cabinet name.

Unconnected DCS / PLC terminals — Select to display unconnected DCS / PLC

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Unconnected Apparatus terminals — Select to display unconnected Apparatus

terminals. If you clear the check box, the software replaces the terminals with a
break-in-sequence symbol.

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).

Terminal discontinuities — Select to display a gapping symbol which indicates

discontinuity in a sequence of terminals. A gapping symbol appears between
terminal symbols wherever there is a gap in a terminal sequence.

Leftmost strip descriptions on the left — Select to place all the descriptions of the
leftmost strips to the left of the strips. Clear this check box to retain all the
descriptions of the leftmost strips above the strips.

SmartPlant Instrumentation User’s Guide 113

Working with SmartPlant Instrumentation: An Overview

All terminals on each strip — Select to display all the terminals on all strips that
appear in the drawing. Clear this check box to display all the terminals on the main
(selected) strip and only wired terminals that carry signals on the other strips.

Signal path up to selected panel only — Select to display the signal path from the
field devices up to the selected panel only. Clear this check box to display the entire
signal path from the field devices up to the control system.

Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.

Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Cross wiring — Set the desired connector representation for cross-wiring
connections. Select one of the following:

• Diagonal— Represents connectors as straight diagonal lines between

the short horizontal lines that come from the terminals.
• Orthogonal— Represents connectors as lines consisting of horizontal
and vertical sections.
Note
• When generating an enhanced report with many connectors, where the
layout settings for the connectors are set to diagonal, the connector
names do not appear directly over their respective connectors.

Symbol Editor > View (Preferences)

Use this option to customize the display of items in the Symbol Editor.

Display options
Origin point — Select this check box to display the origin point of any symbol that
you open in the Symbol Editor. Clear the check box to hide the origin point.

Enhanced Reports > Custom (Preferences)

Use these options to customize features in the current module.

114 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Custom features for enhanced reports

Parameter — Enables you to type the parameter for the feature that you want to
customize in this module.

Value — Type the value of the parameter.

Enhanced Reports > Drawing (Preferences)

Use these options to specify the default report generation method, drawing area units
and spacing of rows and columns. These options apply to Enhanced SmartLoop or
Fieldbus Loop reports only.

Generation method
Select the default generation method to use when you do not specify a generation
method on the Generate Loop Drawings dialog box for a particular loop.

• By Loop— Displays items such as strips that are common to a

number of signals once only on the drawing.
• By Signal— Displays each signal path separately on the drawing so
that common items such as strips appear repeatedly; once in each
signal representation.
• Custom by Loop — Displays Enhanced SmartLoop or Fieldbus
Loop reports using custom symbols that you define for each item and
allows you to specify the placement of the symbols on the drawing
sheet by displaying the Domain Explorer in the Enhanced Report
Utility and dragging items from it onto the drawing sheet.
• Custom by Signal— Displays Enhanced SmartLoop or Fieldbus
Loop reports using custom symbols and showing separate signal paths.
Display each signal on separate page — (available for By Signal and Custom by
Signal options only)

Select to display each signal path on a separate drawing sheet.

Group by location (available for By Signal and Custom by Signal options only) —
Select to organize panels or strips that belong to the same location in the same
column of the drawing, if possible.

Drawing area parameters — When you select the Custom by Loop or Custom by
Signal generation method for a particular loop, the drawing area parameters allow
you to specify the optimum spacing between separate graphical elements on the
drawing sheet. The optimum spacing can vary according to the sizes of the symbols
that you use.

SmartPlant Instrumentation User’s Guide 115

Working with SmartPlant Instrumentation: An Overview

Units — Select the units to specify for the spacing values: inches, millimeters, or
twips.

Row spacing — Type a value to specify the spacing between rows on the drawing
sheet.

Column spacing — Type a value to specify the spacing between columns on the
drawing sheet.

Reset — Resets the drawing area parameters with default values of 0.79 inches and
1.77 inches for row and column spacing respectively.

Enhanced Reports > File Locations (Preferences)

Use these options to set the file paths for the default layout, symbols, logo bitmap,
and output files for the selected report type. These file paths apply to all generated
enhanced reports of the selected report type.

Global path — Displays the global path set by the System Administrator.

Template for default layout — Allows you to select the .sma file that you want to
use as the page template for the selected report. Type the path and file name in the
box or click Browse to navigate to the file. For example:
C:\SmartPlant\Instrumentation\RAD\Template\A4wide.sma

The following is a list of standard .sma files that SmartPlant Instrumentation supplies:

Template File Description

A3tall.sma A3 portrait
A3wide.sma A3 landscape
A4tall.sma A4 portrait
A4wide.sma A4 landscape
Atall.sma 11 in x 8.5 in letter portrait
Awide.sma 11 in x 8.5 in letter landscape
Btall.sma 11 in x 17 in portrait
Bwide.sma 11 in x 17 in landscape

Title block for default layout — Allows you to select the .sym file that you want to
use as the default title block in the template. Type the path and file name in the box
or click Browse to navigate to the file. For example:
C:\SmartPlant\Instrumentation\RAD\Templates\Types\Loop\
Loop_Wide.sym

116 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Logo file — Allows you to select the .sym file that you want to use as the logo in
the default title block. This logo does not appear on enhanced reports automatically.
You need to perform a procedure in the Enhanced Report Utility to save the logo as
part of the default layout. Type the path and file name in the box or click Browse to
navigate to the file.

Automatic save options — Save reports automatically — Select to save the

specified enhanced reports automatically as files at the time of generation. If you
clear the check box, the software prints the reports at a printer when you generate
them without a print preview.

Save without printing — This option becomes available when you select Save
reports automatically. When you select this option, the software automatically
saves reports that you generate without a print preview but does not print them at
your printer. If you clear the check box, the software saves and prints the reports at a
printer when you generate them without a print preview.

Output report folder — Click Browse to navigate to the default folder where you
want the software to save all your enhanced reports automatically. For example:
C:\SmartPlant\Instrumentation\RAD\My Drawings\

Save as type — Select the file type for saving enhanced reports automatically.

Symbol folder — Allows you to define the default folder for all the .sym files that
appear as items on generated enhanced reports. Type the folder name in the box or
click Browse to navigate to the folder. For example:
C:\SmartPlant\Instrumentation\RAD\Symbols\

Custom symbol folder — Allows you to define the default folder for all the .sym
files that you use for Enhanced SmartLoop and Fieldbus Loop reports when using the
Custom by Loop or Custom by Signal generation method. Type the folder name in
the box or click Browse to navigate to the folder. For example:
C:\SmartPlant\Instrumentation\RAD\Symbols\Custom\

Enhanced Reports > File Locations (continued)

(Preferences)
Use these options to set the file paths for the symbols used for instrument list tables.

Global path — Displays the global path set by the System Administrator.

Symbol file for instrument list table header — Allows you to select the .sym file
that you want to use as the header symbol for the table used to display a list of
instruments on the report. Type the path and file name in the box or click Browse to
navigate to the file.

SmartPlant Instrumentation User’s Guide 117

Working with SmartPlant Instrumentation: An Overview

Symbol file for instrument list table details — Allows you to select the .sym file
that you want to use as the symbol for the table rows used to display a list of
instruments on the report. Type the path and file name in the box or click Browse to
navigate to the file.

Enhanced Reports > Fonts (Preferences)

These options allow you to set the font properties of the headers and body text for all
enhanced reports of the selected report type. Also, the font style and size become the
default settings of SmartText, macro attributes and names of SmartPlant
Instrumentation items. Note that the font options do not affect the title block or other
external data such as channel information. To change the font size of the title block
in a enhanced report, edit the corresponding title block symbol (for example,
loop_wide.sym).

Font — Select a font from the list of available Windows fonts. Note that if you
select a font other than a TrueType font (indicated by a TT symbol), the text appears
in the Enhanced Report Utility with a yellow-green font, regardless of any subsequent
change you try to make to the font color in the Enhanced Report Utility. It is
therefore recommended to choose a TrueType font.

Font style — Select a font style from the list of available styles: Regular, Italic,
Bold or Bold Italic.

Size — Select a font size from the list of available font sizes.

Sample — Indicates the appearance of the font according to the properties that you
have selected.

Reset — Resets the SmartPlant Instrumentation font defaults. These defaults are:

• Font – MS Sans Serif

• Font style – Regular
• Size – 8

Enhanced Reports > Title Block (Preferences)

The options on this page allow you to determine the default alignment of the title
block, the relative position of the drawing area, and the working area margins for all
enhanced reports of the selected report type.

Alignment — Displays the position of the title block origin and the edges of the
drawing area on the page, when you use a symbol file (.sym) as the title block. Drag
the title block icon to the position you require. You can position the title block in any

118 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

corner of the drawing or at the center of any of its edges. Note that the alignment
does not change the orientation of the title block.

Horizontal — Select the horizontal alignment for the title block origin: left, center,
or right. Note that you cannot select center for both the horizontal and vertical
alignments.

Vertical — Select the vertical alignment for the title block origin: top, center, or
bottom. Note that you cannot select center for both the horizontal and vertical
alignments.

Drawing area relative to title block — Specifies where the drawing area should be
located in relation to the title block origin. For example, if you place the title block at
the bottom left corner, you can place the drawing to the right of the title block, above
the title block, or above and to the right of the title block. If you place the title block
at the center of any of the edges of the drawing, you can only specify one position for
the drawing.

Reset — Resets the title block in its default position at the bottom left corner of the
page, with the drawing area above the title block.

Size — Allows you to specify the area of the drawing sheet that the title block can
occupy by setting its maximum size.

Units — Select the units to specify for the title block height or width: inches,
millimeters, or twips.

Maximum size — Type a value for the maximum height or width of the title block.
The dimension affected, height or width, depends on the alignment specified for the
title block.

Set size — Select this check box if you want to specify a maximum size for the title
block. Clear the check box to allow the title block to take up as much space as
needed on the title block. It is recommended that you select this check box if the title
block is very tall or very wide, to avoid overlap with other graphical elements on the
drawing sheet.

Working area margins — Displays the margins of the initial working area on the
drawing page. Drag the edges of the working area to set the margins to the position
you require. Note that when you set the working area margins, the defined area
includes the title block. The software generates the drawing starting from the top left
corner at the position relative to the title block that you specified on the Title Block
tab. If any drawing elements extend beyond the right and bottom limits of the
working area, the software displays those elements on a new sheet.

Units — Select the units to specify for the working area margins: inches,
millimeters, or twips.

SmartPlant Instrumentation User’s Guide 119

Working with SmartPlant Instrumentation: An Overview

Left — Specifies the width of the left margin of the working area in the specified
units.

Right — Specifies the width of the right margin of the working area in the specified
units.

Top — Specifies the width of the top margin of the working area in the specified
units.

Bottom — Specifies the width of the bottom margin of the working area in the
specified units.

Reset — Resets the working area margins with a default value of 20 twips for all
margins.

Enhanced Reports > Connectors (Preferences)

The options on this page allow you to determine the format of the lines that represent
connectors for various items. Note that the first connected wire of a cable always
inherits the properties of the cable and that the first connected wire of subsequent
cable sets always inherits the properties of the cable set. For the Custom by Loop
and Custom by Signal generation methods, the software displays the wires
individually and assigns them the format that you specify.

Format
Item — Allows you to select the type of wiring item for which the formatting
definitions apply, for example, cable, cable set, wire, jumper.

Reset — Resets the formatting definitions to their default values for the selected
item.

Style — Allows you to specify the line style for the connector representation. The
box beside this list indicates the visual appearance of the style that you select. You
should not change the default style used for jumpers; if you do so, the software will
not display the jumpers.

Color — Displays the current color that the software uses for the connector
representation. To change the connector color, click the ellipsis to open the Color
dialog box.

Units — Select the units to specify for the connector width: inches, millimeters, or
twips.

Width — Specifies the connector width in the selected units.

120 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Enhanced Reports > Pagination and Revisions

(Preferences)
The options on this page allow you to determine the starting page number and
revision order for the specific enhanced report type.

Pagination options
Start from page number — Select the desired page number to appear on the first
drawing sheet.

Revision options
Revision macro order — Select the relation between the order of revisions and the
order of the macros that you have set in the title block. The options are:

• Ascending— In ascending order, macro number 1 contains the first

added revision, so that the last added revision appears at the bottom of
the list in the title block.
• Descending— In descending order, macro number 1 contains the last
added revision, so that the last added revision appears at the top of the
list in the title block.

Interfaces > DCS Vendors (Preferences)

Use this option while preparing SmartPlant Instrumentation data that you want to
publish for the DCS vendor (such as DeltaV, Yokogawa)

DCS vendor options

Fieldbus mode — Determines whether you can work with fieldbus devices you
created in SmartPlant Instrumentation or with fieldbus devices you downloaded to
SmartPlant Instrumentation. Select this check box if you are preparing fieldbus data
for publishing to the DCS vendor software. When the check box is selected, on the
Fieldbus tab of the Tag Number Properties dialog box, the contents of the fieldbus
device revision list is limited according to the manufacturer that you select on the
General tab. Your selection of manufacturer and fieldbus device revision then
determines function block association for a given instrument. The software displays
only those function blocks that belong to the downloaded fieldbus devices and makes
the Function Blocks supporting table inaccessible.

If you clear this check box, you can work with function blocks you create in
SmartPlant Instrumentation. The software hides function blocks belonging to
fieldbus devices you previously downloaded.

SmartPlant Instrumentation User’s Guide 121

Working with SmartPlant Instrumentation: An Overview

SmartPlant Integration > General (Preferences)

The options on this page allow you to specify various preferences that are applicable
when working in an integrated environment or with particular interfaces.

Relative tolerance — Type a value using a decimal point with `1' preceded by the
number of zeros representing the accuracy that you require, for example: 0.01,
0.0001.

Output XML folder

Global path — Displays the global path set by the System Administrator.

Default folder for XML files — This option applies when you use the SmartPlant
Electrical, DeltaV, or Yokogawa interfaces. Click Browse to select a working folder
in which to keep the .xml files containing your published data.

Graphical report format

Determines the output format for view files when publishing documents. Available
options are:

• Native (brw, spd, ssf)— Generates published reports in native

format. Select this option if you want to generate reports for which the
title block issue data is updated in SmartPlant Foundation. The native
format depends on the report type: for Browser, Instrument Index, and
Wiring reports, the report file extension is .brw; for process data
sheets, the report file extension is .spd; for spec sheets, the report file
extension is .ssf. Note that this option does not apply to DDP reports,
and if selected, DDP reports will be generated as PDF files only.
• PDF— Generates published reports in .pdf format.
• Both— Generates published reports in both native and .pdf formats.
• None— Disables publishing of view files when you publish
documents.

SmartPlant Integration > To Do List (Preferences)

These options enable you to specify the way that the software handles tasks in the To
Do List when you are working in an integrated environment.

Task execution — Use these option buttons to determine how the software executes
tasks in the To Do List when the user implements the Run command.

• Execute — Click to specify that Run executes the task immediately.

• Submit — Click to specify that Run submits the task for execution at
a later stage for batch mode execution.

122 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Enable claim and release of basic engineering data — Select this check box to
allow the software to generate tasks for claiming basic engineering data into a project
or releasing claimed basic engineering data back to As-Built.

Enable claim and release of wiring data — Select this check box to allow the
software to generate tasks for claiming wiring data into a project or releasing claimed
wiring data back to As-Built.

Delete failed tasks — Select this check box to allow the software to delete tasks for
which implementation failed.

Activate instrument type profile — When running a task that results in the
creation of a new instrument, if you select this check box, the software applies
instrument type profile options according to the settings specified under Preferences
> Instrument Index > Profile, provided the appropriate options are defined for the
specific instrument type. If you clear the check box, the software creates the
instrument type without applying the profile options.

Display tasks for all plant hierarchy items — Select this check box to display the
tasks for all plant groups in the current plant. Clear the check box to display tasks in
the current lowest plant hierarchy item only.

Claim and Merge Options (Preferences)

The options on this page only apply in an owner operator domain. These options
allow you to set preferences for claiming As-Built items for a project from
SmartPlant Instrumentation or merging project data with As-Built. When working
with As-Built data, you can either claim items directly or copy them to the Claim
Buffer. Then, your Project Administrator can claim these items in the
Administration module. When working in a project, you cannot merge items directly.
It is only possible to copy project data to the Administration module Merge Buffer
for merging.

These preferences determine how the software claims, merges, or copies to the Claim
Buffer or Merge Buffer the sub-items and parent items associated with the items you
select for claiming or merging from the explorer windows. Documentation dealing
with claiming and merging data appears in the Administration module Help. For
common tasks associated with claiming data, see Scoping Data for Projects Common
Tasks in the Administration User's Guide. For common tasks associated with
merging data, see Merging Project and As-Built Data Common Tasks in the
Administration User's Guide.

The following table shows the related data or items that the software can include in
the Claim Buffer or Merge Buffer when you select a main item belonging to a
specific item type.

SmartPlant Instrumentation User’s Guide 123

Working with SmartPlant Instrumentation: An Overview

Main Item Related Items/Data Included with the Main Item

Loop Tags with basic engineering data (process data, calculation,
calibration, dimensional data for piping, and specification sheets,
hook-up associations), wiring items that have a signal propagated
to the loop or tag. If you placed a device panel inside a cabinet or
junction box, when claiming the loop, this device panel is not
claimed or merged together with the cabinet or junction box
because this device panel does not have a signal propagated to the
loop. You must claim or merge such a device panel manually.
Instrument Basic engineering data, wiring items that have a signal propagated
to the instrument.
Wiring item All wiring sub-items and control system tags that appear in the
(panel, rack, appropriate wiring item folder in the Domain Explorer.
wiring equipment,
and so forth
Terminal strip Terminals
Cable Cable sets, wires
Wire Cables, cable sets

Notes
• The Claim Buffer and Merge Buffer are only accessible from the
Administration module. For more information about the Claim
Buffer, see the Administration module Help, Claim Buffer in the
Administration User's Guide. For more information about the Merge
Buffer, see the Administration module Help, Merge Buffer in the
Administration User's Guide.
• Preferences that you set do not affect preferences the Project
Administrator defines on the Preferences for Scoping and Merging
Data dialog box of the Administration module.
Include when claiming or merging items
No sub-items — Affects only items you selected in an explorer window. The
associated sub-items are claimed, or copied to the buffer as dummy items. In the
project, dummy items appear as view-only and are marked by a specific color defined
in the Administration module. In the Domain Explorer, dummy items appear with
the indicator . The associated wiring sub-items that do not have a signal (for
example, disconnected terminals or spare wires) are not processed at all. When
merging items, the software ignores dummy items.

Sub items — Allows you to claim, merge, or copy to the buffer the associated sub-
items. After you select this option, you can select any combination of the check
boxes if you want the software to include wiring data when you perform a desired
claim or merge operation using shortcut menu commands of an explorer window.

124 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

For example, if you do not select any check box, and then, in the Domain Explorer,
select a loop or a tag, the software includes all the engineering data but does not
include any wiring items that have a signal propagated to the loop or tag. The
engineering data that the software includes consists of process data, calculation,
calibration, dimensional data for piping, and specification sheets, and hook-up
associations. To include these wiring items, you must select the Wiring data of tags
and loops check box.

Note
• When you select a tag for claiming or merging, the basic engineering
data is selected automatically. You cannot claim or merge a specific
instrument, process data sheet, and so forth.
Wiring data of tags and loops — Allows you to claim, merge, or copy to the buffer
all the wiring items that have a signal propagated to the tags and loops you select for
claiming.

Tags and loops with lowest level sub-items only — Only available after you select
Wiring data of tags and loops. Allows you to claim, merge, or copy to the buffer
only the terminals and wires that have a signal propagated to the tags and loops you
select for claiming. The intermediate sub-items are processed as dummy.

Wiring equipment sub-items — Only available after you select Wiring data of
tags and loops. Allows you to claim, merge, or copy to the buffer all the wiring
items that are associated with wiring equipment. For example, if you claim a tag
associated with an apparatus, the software also claims all of the sub-items associated
with the apparatus.

Non-connected terminals and spare wires — Only available after you select
Wiring data of tags and loops. Allows you to claim, merge, or copy to the buffer
the non-connected terminals and spare wires together with the other associated wiring
items that have a signal.

Wires connected to terminals — Allows you to claim, merge, or copy to the buffer
all the wires that are connected to terminals associated with the parent items. For
example, if you claim a panel, the software also claims the panel strips, the terminals,
and the wires that are connected to the terminals.

Note
• If you selected a loop or tag, and also selected the Wiring data of tags
and loops check box, the Wires connected to terminals check box
does not apply to the wiring items associated with the loop or tag. In
this case, the software always claims, merges, or copies to the buffer
all the wires that have signal propagated to the tag.

SmartPlant Instrumentation User’s Guide 125

Working with SmartPlant Instrumentation: An Overview

When claiming items, include parent items as

Dummy items — Allows you to claim or copy to the Claim Buffer parent items as
dummy items. For example, if you claim an instrument, the source loop number
appears in the project as a dummy item.

Fully-functional items — Allows you to claim or copy to the Claim Buffer parent
items as fully-functional items. For example, if you claim an instrument, the source
loop number appears in the project as a fully-functional item.

Note
• When you claim instruments directly from the Instruments folder of
the Domain Explorer, the source loop is always claimed as a dummy
item. In this case, this preference does not apply.
When merging items
Convert parent items to dummy items — Allows you to copy items to the Merge
Buffer and display their parent items in the Merge Buffer as dummy items. When
your Project Administrator merges the items that you copied, the software converts
those parent items that remain in the projects to dummy items. For example, when
merging a strip, the strip is removed from the project and the parent panel remains in
the project as a dummy panel. The software automatically removes the dummy
parent item from the project if this item does not have any other sub-items.

Leave parent items a fully-functional items — Allows you to copy items to the
Merge Buffer and display their parent items in the Merge Buffer as fully-functional
items. When your Project Administrator merges the items that you copied, the
software leaves those parent items that remain in the project as fully-functional items.

Copy revision data — Includes revision data of the documents associated with
items that you claim.

Reclaim items — Allows you to claim the same items again. When an item exists
in a project, reclaiming the item results in an automatic update of the project item
properties, connections and associations. If you deleted an item, this item reappears
in the project after reclaiming.

Report Generator (Preferences)

The options on the Report Generator page enable you to select whether to use the
default report generator, InfoMaker. This setting does not affect the preferences that
were defined by other SmartPlant Instrumentation users working in the current
domain or, if the domain type is Owner operator, in the current project.

Default report generator

Report generator — Select an option: InfoMaker or None.

126 SmartPlant Instrumentation User’s Guide

 Working with SmartPlant Instrumentation: An Overview

Report generator program path — Type the full path and filename or click
Browse to navigate to the InfoMaker executable file.

SmartPlant Instrumentation Server (Preferences)

These options enable you to specify preferences when using the SmartPlant
Instrumentation Server.

Enhanced report format — Enables you to specify the file type when generating
enhanced reports using IDEAL. Available options are:

• SMA – Generates files in the native format of the Enhanced Report

Utility.
• PDF – Generates files as PDF output.
Log file path — Enables you to specify the path to the folder where the software
creates the log file output. Click Browse to navigate to the path. Note that if no path
is defined or the path definition is invalid, the software generates the log file in the
Temp folder defined in Windows.

Module Icons (Preferences)

These options enable you to customize the main toolbar by adding, removing, and
rearranging the icons on the main toolbar in any sequence. These settings do not
affect the preferences that were defined by other SmartPlant Instrumentation users in
the current domain or working in the current project, if the domain type is Owner
operator.

The Domain Administrator can restrict the ability of other users to set their
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.

Note the following limitations:

• An icon cannot appear on the main toolbar more than once.

• You cannot change the original icon assignment.
• You cannot modify the icon image.
Placing an icon on the main toolbar
Do one of the following:

• Drag an icon from the Available icons pane and drop it in the
Selected icons pane.

SmartPlant Instrumentation User’s Guide 127

Working with SmartPlant Instrumentation: An Overview

• Double-click an icon or its name in the Available icons pane.

• Select an icon and click Add.
Removing an icon from the main toolbar
Do one of the following:

• Drag an icon from the Selected icons pane and drop it in the
Available icons pane.
• Double-click an icon or its name in the Selected icons pane.
• Select an icon and click Remove.

128 SmartPlant Instrumentation User’s Guide

 Searching for Tag and Loop Numbers: An Overview

Searching for Tag and Loop Numbers: An

Overview
SmartPlant Instrumentation provides you with several options to find the tag and loop
numbers that you require to work with.

You can look for your tag and loop numbers in the SmartPlant Instrumentation
Explorer or you can use the search facilities provided in the pertinent modules. For
more information, see Search for Items in SmartPlant Instrumentation Explorer, page
233.

While working in a module, you can search for tag or loop numbers in different ways.
You can enter search parameters and find tag or loop numbers that match the search
parameters that you specified. If you do not specify any search parameters, the
software finds all the existing tag or loop numbers in the current <unit>. In the
Process Data and Calibrations modules, you can search for tag numbers either in the
current <unit>, or in all the <units> of the current <plant>. You can also look for
typical tags created in the current domain.

You search for tag numbers in the Find Tag dialog box. There are many cases where
the software opens the Find Tag dialog box. You can look for tag numbers after
clicking Find in dialog boxes that prompt you to enter a tag number. Also, you can
look for tag numbers when opening a process data sheet, when editing, duplicating, or
deleting a tag number, or when calculating or calibrating tag numbers, and so forth.

You search for loop numbers in the Find Loop dialog box. The software opens the
Find Loop dialog box whenever you need to search for a loop number. There are
many cases where the Find Loop dialog box opens: clicking Find in a dialog box
that prompts you to enter a loop number opens the Find Loop dialog box. For
example, you can click Find when you want to edit or duplicate one or more loop
numbers in the Instrument Index module.

Related Topics
• Search for Items in SmartPlant Instrumentation Explorer, page 233
• Searching for Tag and Loop Numbers Common Tasks, page 130

SmartPlant Instrumentation User’s Guide 129

Searching for Tag and Loop Numbers: An Overview

Searching for Tag and Loop Numbers Common

Tasks
The following tasks are used frequently when searching for tag or loop numbers:

Search for All Tag Numbers

This topic explains how to find all the existing tag numbers in the current <unit>. In
the Calibration and Process Data modules, you can search for tag numbers in all the
<units> of the current <plant>. In the Process Data module, you can find tag
numbers in all units when searching for tag numbers to generate instrument reports.
For more information, see Search for All Tag Numbers, page 131.

Search for Typical Tags

This help topic explains how to find all the existing typical tag numbers in the current
domain. For more information, see Search for Typical Tags, page 134.

Use Search Parameters to Find Tag Numbers

This help topic explains how to find tag numbers by entering search parameters.

Entering search parameters in the Find Tag dialog box enables you to narrow down
your search. You can narrow your search to the maximum by entering all the search
parameters. It is up to you what search parameters to specify. You can use wildcards
in the fields where you type values.

Leaving some of the Search parameter fields empty widens the search. If you do
not specify any search parameters, the software finds all the existing tag numbers.

After the search is complete, the software displays the tag numbers that match your
search parameters in the Search results data window.

For more information, see Use Search Parameters to Find Tag Numbers, page 132.

Search for All Loop Numbers

This topic explains how to find all the existing loop numbers in the current <unit>.
For more information, see Search for All Loop Numbers, page 134.

Use Search Parameters to Find Loop Numbers

This help topic explains how to find loop numbers by entering search parameters.

130 SmartPlant Instrumentation User’s Guide

 Searching for Tag and Loop Numbers: An Overview

Entering search parameters in the Find Loop dialog box enables you to narrow down
your search. You can narrow your search to the maximum by entering all the search
parameters. Leaving some of the Search parameter fields empty widens the search.
It is up to you which search parameters to specify. If you do not specify any search
parameters, the software finds all the existing tag numbers in the current <unit>.
Note that you can use wildcards in the fields where you type values.

After the search is complete, the loop numbers that match your search parameters are
displayed in the Results data window.

For more information, see Use Search Parameters to Find Loop Numbers, page 135.

Search for Typical Loops

This help topic explains how to find all the existing typical loops in the current unit.
For more information, see Search for Typical Loops, page 136.

Related Topics
• Searching for Tag and Loop Numbers: An Overview, page 129

Search for All Tag Numbers

1. In the Find Tag dialog box, do not enter any other values in the Search
parameter fields.
Tip
• In the Calibration or Process Data module, select Look in the entire
current plant if you want to find tags in all the <units> of the current
<plant>.
2. Click Find.
Tip
• Select the Show more search results check box to hide the search
parameter fields and enlarge the Search results data window to
display more tag rows. Clear this check box to return to normal view.
3. Select the required tag numbers in the Search results data window and click OK.

Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129

SmartPlant Instrumentation User’s Guide 131

Searching for Tag and Loop Numbers: An Overview

Use Search Parameters to Find Tag Numbers

Note
• To specify search parameters in the Calibration module, you need to
perform a separate procedure.
1. In the Find Tag dialog box, from the Tag class list, select the desired tag class.
Tip
• A conventional tag is an instrument that does not belong to the
Fieldbus, Telecom, Typical, or Electrical classes.
2. Use the following fields and lists in the Search parameters group box for search
parameters that narrow your search:
Search Explanation Example
Parameter
Tag Number Type the whole tag number you are looking for. 101-FT – 2225/1
Include any prefix, suffix, and separator
characters. You can use wildcards if needed. Or use a wildcard:
101-FT%
Process Select a process function to narrow your search Flow
function to tags belonging to the selected process Pressure
function.. (This parameter is available in the
Instrument Index and Process Data modules
only.)
Instrument Select an instrument type to narrow your search D/P Type Flow
type to tags belonging to the selected instrument Element (FE), Mass
type. Flow Transmitter
(FT)
Status Select a tag status to narrow your search to tags An existing device,
associated with the selected status. a new instrument, a
relocated device
Location Select a tag location, for example, Field, to Equipment room,
narrow your search to tags for which you have junction box
defined this location.
I/O type Select a I/O type to narrow your search to tags AO (analog output)
for which you have defined this I/O type. DI (Digital input)
Prefix Type the tag number prefix to find all the tag 101
numbers that have this prefix in their names. Do
not include the separator characters. The <unit>
number segment in the tag number name is
usually the tag number prefix. You can also use
wildcards if needed.

132 SmartPlant Instrumentation User’s Guide

 Searching for Tag and Loop Numbers: An Overview

Search Explanation Example

Parameter
Number Type the numeric segment of a tag number to 2315
find all the tag numbers that have this numeric
segment. You can also use wildcards if needed.
Suffix Type the suffix segment of the tag number to 1 ( the number
find all the tags that contain this suffix. Do not following the slash (
type the slash ( / ) character. You can also use / ) in tag number
wildcards if needed. 101-FT – 2225/1)
Search Explanation Example
Parameter
Equipment Select equipment to narrow your search to tags
for which you have defined this equipment.
Line Select a line to narrow your search to tags with
which you have associated this line. (This
parameter is not available in the Process Data
and Specifications modules.)
Form Select a specification form number to narrow
number your search to tags for which you have defined
this form number. (This parameter is available
in the Specifications module only.)
Date range Type dates or use spinners to narrow your
search to a given date range. (This parameter is
available in the Specifications module only.)

3. To broaden the search to include all of the <units> in a given <plant>, select
Look in the entire <plant>.
Tip
• This field is available in the Calibration module, and in the course of
various procedures in the Process Data and Specifications modules.
4. Click Find.
Tip
• Select the Show more search results check box to hide the search
parameter fields and enlarge the Search results data window to
display more tag rows. Clear this check box to return to normal view.
5. In the Search results data window, do one of the following:
• Select the desired tag number.

SmartPlant Instrumentation User’s Guide 133

Searching for Tag and Loop Numbers: An Overview

• Press and hold down Ctrl to select multiple tag numbers.

Multi-selection is available in the Calculation module when you select
tags for batch calculation, in the Process Data module for instrument
report generation, and in the Specifications module. You can also
select the Select all check box to select all the displayed tag numbers.
6. Click OK.

Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129

Search for Typical Tags

Note
• It is possible to search for typical tags only in the Instrument Index
module.
1. When editing, deleting, duplicating or moving tags in the Instrument Index
module, in the Enter Tag Number dialog box, click Find.
2. In the Find Tag dialog box, select Typical tag from the Tag class list.
3. Do not enter any other values in the Search parameter fields.
4. Click Find.
Tip
• Select the Show more search results check box to hide the search
parameter fields and enlarge the Search results data window to
display more tag rows. Clear this check box to return to normal view.
5. Select the desired tag numbers in the Search results data window and click OK.

Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129

Search for All Loop Numbers

1. In the Find Loop dialog box, do not enter any other values in the Search
parameter fields.
2. Click Find.
Tip
• Select the Display more results check box to enlarge the Search
results data window and display more rows. Clear this check box to
return to normal view.

134 SmartPlant Instrumentation User’s Guide

 Searching for Tag and Loop Numbers: An Overview

3. Select the required loop numbers in the Search results data window and click
OK.

Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page
129

Use Search Parameters to Find Loop Numbers

1. Use the fields and lists in the Search parameters group box to enter your search
parameters to narrow your search. The following search parameters are available:
Search Explanation Example
Parameter
Loop name Type the whole loop number you are looking 101F -2225\A
for. Include any prefix, suffix, and separator
characters. You can use wildcards if needed. 101F-%
The Search Results data window will display
this loop number if it exists.
Loop Type the numeric segment of the loop number to 2225
number find all the loop numbers that have this numeric
segment. You can also use wildcards if needed.
Loop prefix Type the loop number prefix to find all the loop 101
numbers that have this prefix. Do not include
the separator characters. The <unit> number
segment in the loop number name is usually the
loop number prefix. You can also use wildcards
if needed.
Loop suffix Type the suffix segment of the loop number to A
find all the loops that have this suffix. You can
also use wildcards if needed.
Measured This search parameter is used to find all the Density (D)
variable existing loop numbers that have the measured
variable that you select from this list. Pressure (DP)
Loop type This search parameter is used to find all the Electrical Loop
existing loop numbers that have the loop type (Electrical),
that you select from this list.
Open Loop (Open)
Loop This search parameter is used to find all the Indication and
function existing loop numbers that have the loop Alarm (IA),
function that you select from this list.
Control (C)

SmartPlant Instrumentation User’s Guide 135

Searching for Tag and Loop Numbers: An Overview

Search Explanation Example

Parameter
Generation This search parameter is used to find all the CAD (a loop
type existing loop numbers that used a specific type drawing generated
of loop drawing generation. by an external CAD
engine)

Manual (a loop
drawing generated
by using the manual
method

2. If required, select the Fieldbus check box to narrow your search to the loop
numbers that contain tags with a fieldbus I/O type.
3. Click Find.
4. Select one or more loop numbers in the Search results data window.
Tips
• The Select all option is not available when duplicating an existing
loop number.
• Select the Show more search results check box to hide the search
parameter fields and enlarge the Search results data window to
display more loop rows. Clear this check box to return to normal
view.
5. Click OK.

Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129

Search for Typical Loops

You perform the search in the Instrument Index module.

Using the Typical Loop Management dialog box:

1. Click Edit > Typical Loop Management.
2. In the Find typical loop field, type the name of the typical loop you want to find.
As you type the software highlights the typical loop names in the data window.
Using the Batch Loop Creation dialog box:
1. Click Edit > Batch Loop Creation.
2. Click Find.

136 SmartPlant Instrumentation User’s Guide

 Searching for Tag and Loop Numbers: An Overview

3. In the Find Typical Loop dialog box, do one of the following:

• Enter the required search parameters, and click Find.
• Click Find, and from the Search results data window, select the
required typical loop.
Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129

SmartPlant Instrumentation User’s Guide 137

Supporting Tables: An Overview

Supporting Tables: An Overview

Supporting tables are dialog boxes that allow you to manage the contents of select
lists in SmartPlant Instrumentation. For example, when creating or editing a panel,
the values that you select from the lists are held in the relevant supporting tables.

To access a supporting table, click next to the list arrow in the relevant dialog box,
or when in the Wiring Module or Instrument Index Module window, click Tables
and then the relevant menu command.

Note that in a multi-user installation, SmartPlant Instrumentation allows only one user
at a time to edit a given supporting table record.

For a detailed list and description of all the supporting tables in the SmartPlant
Instrumentation, see Supporting Tables in SmartPlant Instrumentation, page 139.

Related Topics
• Supporting Tables Common Tasks, page 139

138 SmartPlant Instrumentation User’s Guide

 Supporting Tables: An Overview

Supporting Tables Common Tasks

The following tasks are used frequently when managing supporting tables.

Add a New Value to a Select List

This option shows you how to add a new value to a select list. All values are stored
in the supporting tables that you can access from various windows and dialog boxes.
You can access a supporting table from a menu by selecting the appropriate item from
the Tables menu or by clicking in a dialog box. For more information, see Add a
New Value to a Select List, page 148.

Manage a Custom Table

This option shows you how to use custom tables, as defined by the Domain
Administrator, to contain supporting data for instruments. After you enter your data
in a Custom Table dialog box, you can use this data as additional tag attributes when
setting a profile in the Instrument Type Profile dialog box, and when editing tag
number properties in the Tag Number Properties dialog box. For more information,
see Manage a Custom Table, page 149.

Customize Manufacturer-Specific Field Headers

Some field headers on the Distributed Control System (DCS) dialog box,
Programmable Logic Controller (PLC) dialog box, I/O Card Properties dialog
box, and some appropriate reports use manufacturer-specific terminology. Therefore,
these dialog boxes display field headers according to the panel manufacturer you
select from the Manufacturer list when editing panel properties. The procedure
outlines how to customize these field headers according to manufacturer-specific
terminology. For more information, see Customize Manufacturer-Specific Field
Headers, page 148.

Related Topics
• Supporting Tables in SmartPlant Instrumentation, page 139
• Supporting Tables: An Overview, page 138

Supporting Tables in SmartPlant Instrumentation

The following table lists all the available supporting tables and the description of their
functions. You can access these supporting tables by clicking next to a list arrow
or by clicking an appropriate command on the Tables menu in the Instrument Index
and Wiring modules.

SmartPlant Instrumentation User’s Guide 139

Supporting Tables: An Overview

Supporting Table Description

General Process Allows you to define a sub-category for the General process
Function Sub- function in the Instrument Types dialog box.
Categories
Instrument Allows you to maintain the contents of the Status select list on
Statuses the Tag Number Properties dialog box.
I/O Types Allows you to maintain the contents of the System I/O type list
on the Tag Number Properties dialog box.
Instrument Allows you to specify general or specific instrument locations
Locations within the <plant>.
Equipment Allows you to categorize the equipment that your instruments are
installed on. Equipment is also categorized according to different
types, for example, you can specify the equipment type as:
pumps, compressors, burners, silos, and so forth.
Equipment Types Allows you to add new equipment types to the Equipment type
select list in the Equipment dialog box. You can categorize the
equipment that your instruments are installed on according to
different types, such as pumps, compressors, burners, silos, and
so forth.
P&ID Drawing Allows you to store P&ID drawing references used for making
References associations with tag numbers in the Instrument Index and Loop
Drawings modules.
Lines Allows you to categorize and modify line data in your <plant>.
This dialog box also enables you to access the Line Properties
dialog box where you can create a new line or edit the properties
of an existing line.
Line Types Allows you to create, view, edit, and delete line types.
Instrument Allows you to customize instrument criticality data. Then, you
Criticality can define criticality for a particular tag in the Associate
Categories and Criticality dialog box that you access from an
Instrument Index Standard Browser view.
Instrument This supporting table holds certification information for
Certification instruments that are certified for hazardous environment.

140 SmartPlant Instrumentation User’s Guide

 Supporting Tables: An Overview

Supporting Table Description

Instrument Allows you to control the content of the Manufacturer lists in
Manufacturers the Tag Number Properties and Find Tag dialog boxes as well
as the Manufacturer column in an Instrument Index Standard
Browser view.

The URL feature on the Instrument Manufacturer dialog box

allows you to enter a desired URL that can be double-clicked to
automatically launch the Internet Explorer and go to the pertinent
Web site if you are connected to the Internet.
Instrument Models Allows you to store instrument model data in the current domain.
All instrument models are categorized by instrument
manufacturer.
Function Blocks Allows you to add new user-defined function blocks to your
instrument index, delete the redundant ones, or modify the
definition of existing user-defined function blocks.
Intrinsically Safe Allows you to create and manage intrinsically safe circuit types
Circuit Types which you can associate with tag numbers while editing tag
number properties. The intrinsically safe circuit types that are
held in this supporting table then become available in the Wiring
module where you can carry out the intrinsic safety calculation.
Loop Measured Allows you to enter or modify the loop process variable identifier
Variables which is used in the loop naming conventions. The loop process
variable identifier is the first letter in the loop name that comes
after the loop prefix.
Loop Types Allows you to maintain the contents of the Loop type select list
on the Loop Number Properties, Typical Loop Properties, and
Find Loop dialog boxes.
Loop Functions Allows you to enter or modify the loop function identifier which
is used in loop naming conventions. The loop function identifier
is used to identify the succeeding letters that follow the loop
measured variable identifier in the loop name.
Associated Allows you to view equipment tags that are associated with
Electrical signals that are defined in SmartPlant Electrical and the
Equipment equipment type to which each signal belongs.
Associated This supporting table holds all the available associated electrical
Electrical equipment types to which SmartPlant Electrical signals can
Equipment Types belong.
Circuits This supporting table holds circuit values that appear in the
Circuit list on the Electrical tab of the Tag Number Properties
dialog box.

SmartPlant Instrumentation User’s Guide 141

Supporting Tables: An Overview

Supporting Table Description

Rated Voltage This supporting table holds rated voltage values that you can use
in the Rated voltage list on the Power Supply tab of the Tag
Number Properties dialog box.
Frequency This supporting table holds frequency values that you can use in
the Frequency list on the Power Supply tab of the Tag Number
Properties dialog box.
Number of Phases This supporting table holds number of phases values that you can
use in the Number of phases list on the Power Supply tab of the
Tag Number Properties dialog box.
Operating Modes This supporting table holds operating mode values that you can
use in the Operating mode list on the Power Supply tab of the
Tag Number Properties dialog box and the properties dialog
boxes of panels that support power supply. SmartPlant
Instrumentation provides you with pre-defined operating modes
(Continuous, Intermittent, Spare, and Standby), which are the
only values that are recognized by SmartPlant Electrical. You
cannot delete or modify these values.
Signal Types This supporting table holds signal type values that are used to
define HART instrument properties. To fill this table, you need to
download DeltaV definitions.
Linearity Types This supporting table holds linearity type values that are used to
define HART instrument properties. To fill this table, you need to
download DeltaV definitions.
Panel Types Allows you to maintain the contents of the Panel type list when
editing the properties of a panel.
Panel Allows you to customize the options on the Manufacturer list on
Manufacturers the Properties dialog boxes listed below. The URL field on the
Panel Manufacturer dialog box allows you to enter a desired
URL. You can then double-click this URL to automatically start
the Internet Explorer and go to the pertinent Web site if you are
connected to the Internet. This supporting table also allows you
to define field headers that use manufacturer-specific
terminology.
Panel Models Allows you to manage the contents of the Model list when
creating or editing a panel. SmartPlant Instrumentation classifies
panel models according to manufacturer. You can find the data
used in the other columns in the manufacturer's catalog. Note
that selecting a different model does not change any other data.
Panel Area Allows you to manage the data contained in the Area
Classifications classification list on any of the panel properties dialog boxes.

142 SmartPlant Instrumentation User’s Guide

 Supporting Tables: An Overview

Supporting Table Description

Terminal Strip Allows you to manage the data contained in the Type list on the
Types Terminal Strip Properties dialog box. You can use this dialog
box to categorize a terminal strip where the terminal strip
represents a hardware device or a DCS/PLC I/O termination.
Terminal Strip Allows you to manage the contents of the Manufacturer list on
Manufacturers the Terminal Strip Properties dialog box.
Terminal Strip Allows you to manage the contents of the Model select list on the
Models Terminal Strip Properties dialog box. SmartPlant
Instrumentation classifies terminal strip models according to
manufacturer. You can classify a terminal strip model/MFG for
control si/s cards and hardware devices.
Terminal Types Allows you to manage the contents of the Type select list on the
Terminal Properties dialog box. Also, you can classify the
terminals whenever their type needs to be defined. You can
replace the default graphic image of terminal sides that appear in
the Connection window and the appropriate reports.
Terminal Allows you to manage the contents of the Manufacturer select
Manufacturers list on the Terminal Properties dialog box.
Terminal Models Allows you to manage the contents of the Model select list on the
Terminal Properties dialog box. Terminal models are classified
according to manufacturer.
Terminal Colors Allows you to manage the contents of the Color select list on the
Terminal Properties dialog box. You can also select and
customize the graphical representation of the color names defined
in this supporting table. This sets the precise colors for the bar
connecting terminals in the Connection and Cross-Wiring
windows.
Wiring Equipment Allows you to manage the contents of the Wiring equipment
Types types select list. Wiring equipment type is one of the properties
used to define wiring equipment items, such as I/O cards, I/O
terminations, fieldbus bricks, safety barriers, relays, amplifiers,
and so forth.
Wiring Equipment Allows you to manage the contents of the Manufacturers select
Manufacturers list. Wiring equipment manufacturer is one of the properties used
to define wiring equipment items, such as I/O cards, I/O
terminations, fieldbus bricks, safety barriers, relays, amplifiers,
and so forth.
Wiring Equipment Allows you to manage the contents of the Models select list.
Models Wiring equipment model is one of the properties used to define
wiring equipment items, such as I/O cards, I/O terminations,
fieldbus bricks, safety barriers, relays, amplifiers, and so forth.

SmartPlant Instrumentation User’s Guide 143

Supporting Tables: An Overview

Supporting Table Description

Wiring Equipment This supporting table holds wiring equipment category values.
Category The categories that exist in this supporting table are available for
selection in the Categories select list of the New Wiring
Equipment dialog box. You can add your own categories and
then set their properties as you require. However, you cannot
modify or delete the categories that are supplied to you with the
software.
Cable Types Enables you to manage cable type data that appears on the Cable
Properties dialog box, Type select list. The Cable Types dialog
box holds all the data that pertains to the cable types in the
current <plant>. Users can view the data or delete it as needed.
This dialog box provides access to the Cable Type Properties
dialog box, where you can create a new cable type or edit the
properties of an existing cable type.
Cable Enables you to manage the data in the Cable Manufacturers
Manufacturers supporting table, which contains all the items of the
Manufacturer select list on the Cable Properties dialog box.
Cable Models Allows you to manage the data in the Cable Models supporting
table, which contains all the items of the Model select list on the
Cable Properties dialog box. SmartPlant Instrumentation
classifies cable models according to manufacturer.
Cable Colors Allows you to manage the contents of the Color select list on the
Cable Properties dialog box.
Cable Glands Enables you to manage the data in the Cable Glands supporting
table, which contains all the items of the End 1 and End 2 select
lists in the Glands group box of the Cable Properties dialog
box. This way, you can assign cable glands to selected cable
types. Once assigned to a cable type, the gland attributes
automatically propagate to all the cables of that type.
Cable Harnesses Allows you to define and maintain the contents of the Cable
harness select list on the Cable Properties dialog box.
Conductor Cross- Enables you to manage the conductor cross-section data for the
Sections cables in the current <plant>. The values that appear in this
dialog box are available in the Cross-section select list on the
Cable Properties dialog box.
Wire Types Allows you to manage the contents of the Type list on the Wire
Properties dialog box.
Wire Colors Allows you to manage the contents of the Color list on the Wire
Properties dialog box.

144 SmartPlant Instrumentation User’s Guide

 Supporting Tables: An Overview

Supporting Table Description

Connector Types A connector type defines pin configuration and other properties.
When you define connectors for a cable, selecting a connector
type copies these properties for the cable connector. This
supporting table allows you to create and manage the connector
types required for your plug-and-socket boxes and for cables that
require connectors.
Connector Allows you to manage the contents of the Manufacturer select
Manufacturers list on the Connector Types dialog box.
Connector Models Allows you to manage the contents of the Model select list on the
Connector Types dialog box. Connector models are classified
according to the Manufacturer column. The information used in
the other columns can be found in the manufacturer's catalog.
Controllers The controller is the processing hardware that controls and
supervises I/O cards. This supporting table allows you to define
and manage your I/O card controllers. You can define new
controllers, edit the properties of existing controllers, and delete
controllers.
Channel Types Allows you to manage the contents of the Channel Type select
list on the Channels dialog box.
Segment-Wide Allows you to define default settings that serve as design rules for
Parameter Profiles the various Fieldbus segments.
Standard Widths Each routing trunk that you define consists of positions. Instead
of defining new positions for each additional trunk, you select the
positions from the list of standard positions. Instead of defining
the width for each standard position that you can add to a trunk,
you select it from the standard width list that you set in this
supporting table. You use the widths that you add in this
supporting table to define the positions in a routing trunk. The
width that you define here is a standard unit and therefore can be
used several times to characterize different positions.
Standard Routing Each routing section of type trunk that you define consists of
Positions positions. (Building sections do not have positions.) Instead of
defining new positions for each additional trunk, you select the
positions from the list of standard positions that you define in this
supporting table.
Maximum Number The maximum number of cables limits the number of cables that
of Cables a position can contain. After you have defined widths and
created positions, you need to set the maximum number of cables
per defined-width position that you want to associate with a
routing trunk.

SmartPlant Instrumentation User’s Guide 145

Supporting Tables: An Overview

Supporting Table Description

Routing Sections Defining routing sections is the last step in creating the <plant>
cable routing before associating routing with cables. The cable
routing sections contain the positions that convey the cables
between the instruments. Using this supporting table, you can
add or edit a routing section and select positions to be included in
a trunk section. The positions that you can select are those for
which you have already defined the maximum number of cables.
Cable Drums Allows you to define and manage the cable drums in your
<plant>. Note that cable drums are categorized according to
cable type.
Pulling Areas Allows you to define the pulling areas in your &lt;plant&gt;.
The pulling area in the &lt;plant&gt; is the area allocated to
cables and the cable drums they are wound on. The purpose of
allocating pulling areas is both to organize the &lt;plant&gt;
drums in designated areas and to regularly use the cables from
these areas.
DCS Block Types Allows you to manage the block type data for control system
tags. The values that appear on this dialog box are available in
the Block Type select list on the Control System Tag
Properties dialog box.
DCS Function Enables you to manage the DCS function block I/O termination
Block I/O data for control system tags. The values that appear on this
Termination dialog box are available in the Function block I/O termination
select list on the Control System Tag Properties dialog box.

Notes
• For the various actions that you can perform with supporting tables,
see Supporting Tables Common Tasks, page 139.
• For the supporting tables used in Telecom, see Supporting Tables for
Telecom, page 147.
Related Topics
• Supporting Tables: An Overview, page 138

146 SmartPlant Instrumentation User’s Guide

 Supporting Tables: An Overview

Supporting Tables for Telecom

The following table lists all the available Telecom supporting tables and the
description of their functions. You can access these supporting tables by clicking
next to a list arrow or by clicking Tables > Telecom and then an appropriate
command in the Instrument Index and Wiring modules.

Supporting Description
Table
Telecom Allows you to create and manage telecom device types. You define
Device Types the required telecom device type profile for your telecom tag numbers
so that new tags that you create can acquire the necessary properties.
SmartPlant Instrumentation provides a number of predefined telecom
device types, such as AL (alarm), CAM (camera), and so forth. You
can add new telecom device types and modify the shipped ones as
desired. You can also delete a telecom device type that is not in use,
but the software does not let you delete a telecom device type that you
already used to create a tag number.
Telecom Line Allows you to maintain the contents of the Telecom line list when
Numbers creating a telecom field device in the Plug-and-Socket Box wizard
and the Line number list on the Tag Number Properties dialog box.
Telecom Field Allows you to maintain the contents of the Field equipment select list
Equipment on the Tag Number Properties dialog box.
Telecom Allows you to maintain the contents of the Signal level select list on
Signal Levels the Tag Number Properties dialog box.
Panel Sub- Allows you to maintain the contents of the Sub-system select list on
Systems the Equipment Panel Properties dialog box.
Telephone Allows you to define new telephone numbers that you can associate
Numbers with existing switch channels in PABX cabinets.
Telephone Allows you to manage the contents of the Telephone number status
Number select list on the Telephone Number Properties dialog box.
Statuses
Telephone Allows you to manage the contents of the Telephone number usages
Number select list on the Telephone Number Properties dialog box.
Usages
Intercom Allows you to define new intercom numbers that you can later
Numbers associate with amplifiers.
PA Zones Allows you to manage the PA zone definitions which are available for
selection on the Category Properties tab of the Wiring Equipment
Properties (Amplifier) dialog box.

SmartPlant Instrumentation User’s Guide 147

Supporting Tables: An Overview

Supporting Description
Table
Alarm Zones Allows you to manage the alarm zone definitions which are available
for selection on the Category Properties tab of the Wiring
Equipment Properties (Amplifier) dialog box.
PABX Allows you to manage the contents of the PABX categories select list
Categories on the PABX Cabinet Properties dialog box.

Note
• For the various actions that you can perform with supporting tables,
see Supporting Tables Common Tasks, page 139.
Related Topics
• Supporting Tables: An Overview, page 138

Add a New Value to a Select List

1. Open the appropriate supporting table by clicking in the appropriate dialog box
or by selecting the appropriate menu item on the Tables menu.
2. In the appropriate supporting table dialog box, click New.
3. Type the required value in the fields provided, and press Tab to move to the next
field.
4. Click New to enter another new value, if desired.
5. Click OK to accept the new values and close the dialog box.

Related Topics
• Supporting Tables Common Tasks, page 139

Customize Manufacturer-Specific Field Headers

1. Do one of the following to open the Panel Manufacturers dialog box:
• In the Wiring module, click Tables > Panel > Manufacturers.
• Click next to the Manufacturer select list on the appropriate dialog
box: Distributed Control System (DCS) Properties, Programmable
Logic Controller (PLC) Properties, or I/O Card Properties.
2. On the Panel Manufacturers dialog box, click Headers.
3. From the Wiring item list, select the item type for which you want to customize
the field headers.
4. Under Custom Field Header, type the text you require next to the appropriate
value that appears under Field Header in Data Dictionary.

148 SmartPlant Instrumentation User’s Guide

 Supporting Tables: An Overview

5. Repeat steps 3 and 4 as many times as you require.

6. Click OK.

Related Topics
• Supporting Tables Common Tasks, page 139

Manage a Custom Table

1. In the Instrument Index Module menu, click Tables > Custom Tables, and then
select the custom table you want to open.
2. To add a new record, click New, and then type a unique name and an optional
description.
3. To edit an existing record, click a value that you want to edit, and modify as
needed.
4. To delete a record, select the row that you want to delete, and click Delete.
5. Click OK.
Note
• The Domain Administrator has rights to create the required custom
tables for each <plant>. If the Domain Administrator does not create
any custom tables, the Custom Tables menu option is not available.
Related Topics
• Supporting Tables Common Tasks, page 139
• Supporting Tables: An Overview, page 138

SmartPlant Instrumentation User’s Guide 149

SmartPlant Instrumentation Interface Languages: An Overview

SmartPlant Instrumentation Interface

Languages: An Overview
You can replace the SmartPlant Instrumentation interface language. The System
Administrator must first add languages to the database. After adding a language to
the database, you can replace your current language with the added one.

The following languages are currently available as add-ins:

• English (default)
• French (partial translation)
• German (only some terms are translated)
• Custom (for languages other than English, French, or German)
After adding the desired interface language, you can do the following:

• Replace the existing interface language with the new interface

language.
• Translate interface text phrases.
Notes
• Translated text appears in the main SmartPlant Instrumentation
interface, the Administration module, and in the Import and Merger
utilities. The text strings are stored in the In_catalog.db file.
• Text in the following software components is not translated:
• Initialization and Update interfaces
• Rule Manager
• Internal Setup
• SAP Interface
• Fluke Wizard
• External Editor
• Process Data Editor
• Text strings for other software components are located in the following
separate resource files:

150 SmartPlant Instrumentation User’s Guide

 SmartPlant Instrumentation Interface Languages: An Overview

Resource File Description

MenuLibrary80.dll All user interface text strings for the Domain and Reference
Explorers and Preferences for the Enhanced Report Utility
SmartLoop8.drx Menu labels, ToolTips, and Microhelp for the Enhanced Report
Utility
Resource File Description
SymbolEditor8.drx Menu labels, ToolTips, and Microhelp for the Symbol Editor
SmartPlantEN.dll Dialog box labels and error messages for the Enhanced Report
Utility and Symbol Editor
ESLAboutEN.dll Text in the About box for the Enhanced Report Utility
SEAboutEN.dll Text in the About box for the Symbol Editor

Related Topics
• Interface Languages Common Tasks, page 152

SmartPlant Instrumentation User’s Guide 151

SmartPlant Instrumentation Interface Languages: An Overview

Interface Languages Common Tasks

Replace the Interface Language with a Language from the Database
This procedure explains how to replace the current SmartPlant Instrumentation
interface with a language from the database. For more information, see Replace the
Interface Language with a Language from the Database, page 152.

Replace the Interface Language with a Language from an External File

This procedure explains how to replace the interface language with a language from
an external file. In this mode, all the terms and phrases are retrieved from a language
file instead of being retrieved from the database, which improves the performance.
For more information, see Replace the Interface Language with a Language from an
External File, page 153.

Translate Interface Text Phrases

This procedure explains how to replace the phrases in the current interface text with
your customized text in the target language. After switching to the target language,
all the phrases in the column representing that language replace the original phrases
of the interface language without overwriting them. Empty fields in the target
language do not overwrite the original phrases. This way you can always revert to the
original phrases of the interface language. For more information, see Translate
Interface Text Phrases, page 154.

Prefixes and Suffixes in the Interface Text

This topic contains a table with the information about the prefixes and suffixes that
you can use when customizing new interface text phrases. For more information, see
Prefixes and Suffixes in the Interface Text, page 157.

Related Topics
• SmartPlant Instrumentation Interface Languages: An Overview, page
150

Replace the Interface Language with a Language from the

Database
1. On the menu bar, click Tools > Select Language.
2. On the Select Language dialog box, do one of the following:
• From the Language list, select the language with which you want to
replace the current interface language.
• Click Default to revert the language to the default language, which is
English.

152 SmartPlant Instrumentation User’s Guide

 SmartPlant Instrumentation Interface Languages: An Overview

3. Do one of the following:

• Select the Optimize speed check box to speed up the translation
process. This allows the software to load the interface text to your
computer memory and retrieve it from there.
• Clear the Optimize speed check box to retrieve the interface text from
the database. This frees the memory resources but decreases the
performance.
4. Click OK to close the dialog box and change the interface language.

Related Topics
• Interface Languages Common Tasks, page 152
• SmartPlant Instrumentation Interface Languages: An Overview, page
150

Replace the Interface Language with a Language from an

External File
Important
• Use this procedure only if you experience memory problems while
working on your local computer.
1. On the menu bar, click Tools > Select Language.
2. Select Optimize speed.
3. Select Use file to retrieve the interface text from a pre-defined .psr file, and then
do one of the following:
• In the data field, type the path and filename of the appropriate
language file.
• Click Browse to navigate to the language file.
Caution
• The software does not check whether the specified .psr file is suitable
for translation. If you select an unsuitable file, the software will
display the 'Expression not valid' message when you try to use various
options in SmartPlant Instrumentation.
4. To update your language file, do one of the following:
• Select Overwrite existing file to update the contents of the external
language file after running an update for the application. This action
overwrites all existing data in the language file with the data retrieved
from the database.
• Clear Overwrite existing file to leave the language file contents
unchanged.

SmartPlant Instrumentation User’s Guide 153

SmartPlant Instrumentation Interface Languages: An Overview

5. Click OK to close the dialog box and change the interface language.

Related Topics
• Interface Languages Common Tasks, page 152
• SmartPlant Instrumentation Interface Languages: An
Overview, page 150

Translate Interface Text Phrases

Important
• The System Administrator must first add the specified target language
to the database.
1. On the menu bar, click Tools > Edit Translation Text.
2. Do one of the following:
• Click Open to navigate to a language (.psr) file that contains the
interface text.
• Click Retrieve to retrieve the interface text from the database.
Important
• After you click Update, these commands become permanently
disabled, and you will no longer be able to perform either of these
operations to load the interface text again.
3. In the desired language column, type the phrases you want.
Tips
• The column headers that appear depend on the available languages, for
example: Custom Phrase, French Phrase, German Phrase, and so
forth.
• You can compare phrases more easily by moving two columns closer
together. Drag a column header and drop it in the desired location.
Important
• If you leave any fields blank for the target language, text from the
Original Phrase column (English) will appear in those fields in the
interface after switching languages. This is useful for terms that are
the same in your language as in English; otherwise, you should not
leave fields blank in order to prevent the occurrence of phrases
belonging to more than one language appearing in the interface.
• Make sure that you add the same prefixes, suffixes and punctuation
marks that appear in the corresponding original phrases of that

154 SmartPlant Instrumentation User’s Guide

 SmartPlant Instrumentation Interface Languages: An Overview

interface language, for example: ~, &. For details, see Prefixes and
Suffixes in the Interface Text, page 157.

SmartPlant Instrumentation User’s Guide 155

SmartPlant Instrumentation Interface Languages: An Overview

4. Do one of the following:

• Click Update to save the changes to the database. (If you want to save
the changes to an external language file and not to the database, do not
click Update.)
• Click Save File to save the translated interface text to an external
language file with a .psr extension.
5. Click Close to close the Edit Translation Text dialog box.
Important
• You must exit and then restart the application for your text changes to
take effect.
6. Select the language that you have translated by means of one of the following
options:
• To select a language from the database, see Replace the Interface
Language with a Language from the Database, page 152.
• To select a language from an external file, see Replace the Interface
Language with a Language from an External File, page 153.
Related Topics
• Interface Languages Common Tasks, page 152
• SmartPlant Instrumentation Interface Languages: An Overview, page
150

156 SmartPlant Instrumentation User’s Guide

 SmartPlant Instrumentation Interface Languages: An Overview

Prefixes and Suffixes in the Interface Text

The following table contains information about the prefixes and suffixes that you can
use when customizing new interface text phrases.

Prefix/Suffix Function Syntax Example

& Specifies a menu item. &<interface text> &Action
Underlines the letter
following the '&' symbol.
&& Displays the '&' symbol. && Operators &&
Functions
~n Starts a new line. <interface ~nContinue?
text>~n<interface
text>
~r Starts a new paragraph <interface Warning~n~r
(functions like the Enter text>~r<interface
key in Microsoft Word). text>
It is usually used in
conjunction with ~n.
~t Adds a tab entry. <interface &Action~tCtrl+A
text>~t<interface
text>

Related Topics
• Interface Languages Common Tasks, page 152
• SmartPlant Instrumentation Interface Languages: An Overview, page
150

SmartPlant Instrumentation User’s Guide 157

Revision Management: An Overview

Revision Management: An Overview

When managing revisions, you can add revisions to documents in SmartPlant
Instrumentation, update them as needed, archive and compare new and existing
document revisions, and delete obsolete revisions. A document is a report or drawing
that has a document number. Also, you can add a document number when adding a
revision to an item .

The software allows you to add a revision to a specific report, drawing, or item , for
example, to a specific I/O card in the Wiring module. You add revisions to reports in
the report print preview and to items in the dialog boxes where you can edit the item
properties. Also, you can create global revisions.

In the Administration module, in the Report Management dialog box, the Domain
Administrator has rights to define revision management settings individually for each
report that you can generate in SmartPlant Instrumentation.

In the database, each report is assigned to the report type, which can be a list or a non-
list type report. The report type determines how you can manage revisions created
for a specific report, for an item , or a group of items. For list-type reports, the
Domain Administrator can enable SmartPlant Instrumentation users to manage
revisions either per document or per item .

In accordance with the revision management setting, you can either create a revision
whose document number and revision number become shared for a specific item and
for reports generated for that item (when the setting is per-item ), or create a unique
revision for a particular report (when the setting is per-document).

Regardless of the revision management setting, any document numbers and revisions
that you create in the software are shared with the document numbers and revisions
created for the same items in the Enhanced Report Utility. For example, a drawing
created in the Enhanced Report Utility automatically inherits the same document
number and revision that you assigned to an Enhanced SmartLoop report generated in
SmartPlant Instrumentation.

When working in an integrated environment, you can specify whether to use

SmartPlant Instrumentation revisions or external revisions created when working in
an integrated environment. .

To place issue data on title blocks for enhanced reports, use the Place Drawing
Property Label command in the Enhanced Report Utility. For more information, see
Place Property Labels on a Drawing Sheet in the Enhanced Report Utility User's
Guide, under Working with Templates and Title Blocks.

158 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Global Revisions: An Overview

Global revisions enable you to perform a revision activity in batch mode.

At the first stage of applying global revisions, you select a revision activity, and
define the default revision settings, such as revision values, numbering method, and
revision details. At the second stage, you select the required items in a specific
module, and apply the defined revision settings.

Revision activities include:

• Add revision - select the required numbering method and add a new
revision.
• Update revision - change the existing revision value without changing
the numbering method. For example, you can update a revision from
A1 to A2.
• Upgrade revision - involves changing the revision numbering method.
For example, you can upgrade a revision from P0 to A.
• Delete revisions - delete all revisions for the selected items.
• Delete last revision - delete only the last revision.
You can add global revisions to non-list-type reports for which the Domain
Administrator selected the Per Document revision management setting in the Report
Management dialog box.

An exception is Enhanced Report Utility reports, which are always assigned to the
Per Item revision management setting. The document number and global revision
that you create in SmartPlant Instrumentation are shared with the document number
and revision created in the Enhanced Report Utility.

Note
• Items that have archive options defined as Save to database, any
revisions are only saved to the archive after closing the Global
Revisions dialog box. Adding a revision and then deleting the
revision, before closing the dialog box, results in the revision not being
archived.
Related Topics
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158

SmartPlant Instrumentation User’s Guide 159

Global Revisions: An Overview

Revision Management Common Tasks

The following tasks are used frequently when managing global and local revisions:

Add Global Revisions

This option enables you to add a global revision to items that belong to any of the
following modules: Specifications, Process Data, Calculation, Loop Drawings, Hook-
Ups, Wiring, and Dimensional Data. For more information, see Add Global
Revisions, page 163.

Define Settings for Upgrading Revisions

This option enables you to define default settings for upgrading revisions globally.
These settings include revision numbering method, and revision details. For more
information, see Define Settings for Upgrading Revisions, page 164.

Update Revisions Globally

You can update the existing revision values globally for the items used in the
following modules: Specifications, Process Data, Calculation, Loop Drawings, Hook-
Ups, Wiring, and Dimensional Data. For more information, see Update Revisions
Globally, page 165.

Upgrade Revisions Globally

After defining the default settings for upgrading revisions, you use this option to
apply these settings to the selected items in batch mode. For more information, see
Upgrade Revisions Globally, page 166.

Delete Global Revisions

You can perform batch deletion of revisions if you have the appropriate access rights.
You have the option to delete all revisions for the selected items in the specified
module, or delete only the last revisions. For more information, see Delete Global
Revisions, page 167.

Filter Items for Global Revisions

You can filter the items in the data window of the Global Revisions dialog box when
adding, updating, upgrading, or deleting revisions in batch mode. On the Wiring tab
of the Global Revisions dialog box, you can also filter the Wiring module items per
report. For more information, see Filter Items for Global Revisions, page 162.

160 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Add Local Revisions

You can add revisions locally to a specific SmartPlant Instrumentation document or
item , depending on revision management settings defined by the Domain
Administrator. For all list-type reports, the revision management setting is always
Per Document. For certain non-list-type reports, the Domain Administrator has
rights to define the setting as either Per document or Per Item . For more
information, see Add Local Revisions, page 168.

Edit Local Revisions

Use this procedure to edit existing local revisions. For more information, see Edit
Local Revisions, page 170.

Delete Local Revisions

Use this procedure to delete existing local revisions. For more information, see
Delete Local Revisions, page 171.

Related Topics
• Global Revisions: An Overview, page 159
• Revision Management: An Overview, page 158

SmartPlant Instrumentation User’s Guide 161

Global Revisions: An Overview

Filter Items for Global Revisions

1. In the Global Revisions dialog box, click one of the following tabs:
Specifications, Process Data, Calculations, Loops, Hook-Ups, Wiring, or
Dimensional Data.
Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
2. If you selected the Wiring tab, do the following:
• Under Filter parameters, from the Report for list, select the item for
which you want to apply revisions: Panels, Cables, or DCS/PLC.
• From the Report type list, select a report type appropriate for the item
you selected in the previous step.
Tip
• To set new filter parameters, first click Clear.
3. For all tabs, under Filter parameters, type values in one or more of the text
boxes to specify the parameters that you want to use for filtering the data.
4. Select the Display current <unit> data only check box to display the data in the
current <unit>. Clear this check box to display all data at the level of the current
<plant>.
Tip
• On the Hook-Ups tab, data is filtered at the <plant> level only.
5. Select Activate filter to apply the filter parameters on the items.
Tip
• If you select the Activate filter check box first, the software filters the
data as you select or type the filter parameters.
6. Select Enable wildcard search to use a wildcard, if required, in your search.
Tips
• The Enable wildcard search is enabled only when Activate filter has
been selected.
• The % character is used as the wildcard symbol in your filter.

162 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

7. Click Refresh to update the data window as needed.

8. Click Apply.

Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158

Add Global Revisions

1. In the main window of any SmartPlant Instrumentation module, click Tools >
Global Revisions.
2. On the Settings tab of the Global Revisions dialog box, from the Activity list,
select Add revision.
3. In the Revision field, enter the desired revision value.
4. Do the following to enter the revision details:
• In the Revised by field, enter the initials of the person performing the
revision. The default is the current user's initials, if previously defined
by the System Administrator.
• In the Date field, enter the date of revision, if required.
• Fill out the other fields as needed.
5. Click one of the following tabs: Specifications, Process Data, Calculations,
Loops, Hook-Ups, Wiring, or Dimensional Data.
Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
6. In the data window, filter the items as needed. For details, see Filter Items for
Global Revisions, page 162.
7. In the data window, select the items for which you want to add a global revision
defined on the Settings tab by doing one of the following:
• Select the desired tag numbers (hold down Ctrl or Shift to make
multiple selections).
• Select the Select all check box to select all the tag numbers in the data
window.

SmartPlant Instrumentation User’s Guide 163

Global Revisions: An Overview

8. Click Apply to add a revision to each of the selected items.

9. If you want to add revisions for other modules, repeat the appropriate steps for
each module.
Note
• Items that have archive options defined as Save to
database, any revisions are only saved to the archive after closing the
Global Revisions dialog box. Adding a revision and then deleting the
revision, before closing the dialog box, results in the revision not being
archived.
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158

Define Settings for Upgrading Revisions

1. With any main window open, click Tools > Global Revisions.
2. On the Settings tab, from the Activity list, select Upgrade revision.
3. To change the numbering method for items that do not currently have revisions,
from the Initial revision numbering method list, select one of the following
numbering methods you want to start with:
• P0— for preliminary number sequence P0, P1, P2,...
• 0— for number sequence 0, 1, 2,...
• A— for number sequence A, B, C,...
Tip
• The initial revision numbering method only affects items that do not
have revisions. For items that already have revisions, the software
adds a new revision line using the existing revision numbering
method.
4. To change the numbering method for items that currently use the preliminary
revision numbering method (P0, P1, P2,...), select Switch to another numbering
method, and from the Continue using numbering list, select one of the
following new revision numbering methods:
• 0— for number sequence 0, 1, 2,...
• A— for number sequence A, B, C,...
5. Do the following to enter the revision details:

164 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

• In the Revised by field, enter the initials of the person performing the
revision. The default is the current user's initials, if previously defined
by the System Administrator.
• In the Date field, enter the date of revision, if required.
• Fill out the other fields as needed.
6. Click the appropriate module tab to apply the defined settings. For details, see
Upgrade Revisions Globally, page 166.
Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• Revision Upgrade Example, page 167

Update Revisions Globally

1. With any main window open, click Tools > Global Revisions.
2. On the Settings tab, from the Activity list, select Update revision.
3. In the Revision field, enter the desired revision value.
4. Do the following to enter the revision details:
• In the Revised by field, enter the initials of the person performing the
revision. The default is the current user's initials, if previously defined
by the System Administrator.
• In the Date field, enter the date of revision, if required.
• Fill out the other fields as needed.
5. Click one of the following tabs: Specifications, Process Data, Calculations,
Loops, Hook-Ups, Wiring, or Dimensional Data.

SmartPlant Instrumentation User’s Guide 165

Global Revisions: An Overview

Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
6. In the data window, filter the items as needed. For details, see Filter Items for
Global Revisions, page 162.
7. In the data window, do one of the following to select the items whose revisions
you want to update:
• Select the desired tag numbers (hold down Ctrl or Shift to make
multiple selections).
• Select the Select all check box to select all the tag numbers in the data
window.
8. Click Apply to apply the new revision value to all the selected items in batch
mode.
9. If you want to update revisions for other modules, repeat the appropriate steps for
each module.

Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158

Upgrade Revisions Globally

1. Define the settings for upgrading revisions globally. For details, see Define
Settings for Upgrading Revisions, page 164.
2. Select the desired module tab and filter the items as needed. For details, see
Filter Items for Global Revisions, page 162.
3. To change the numbering method for items that do not currently have revisions,
from the Initial revision numbering method list, select one of the following
numbering methods you want to start with:
• P0— for preliminary number sequence P0, P1, P2,...
• 0— for number sequence 0, 1, 2,...
• A— for number sequence A, B, C,...
4. In the data window, do one of the following to select the items for which you
want to upgrade revisions:

166 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

• Select the desired tag numbers (hold down Ctrl or Shift to make
multiple selections).
• Select the Select all check box to select all the tag numbers in the data
window.
5. Click Apply to apply the new revision value to all the selected items in batch
mode.
6. If you want to upgrade revisions for other modules, repeat the appropriate steps
for each module.

Revision Upgrade Example

This example is based on the following parameters:

• Initial numbering method: P0

• Switch to numbering method for preliminary revisions: A
With the above parameters, the following results are obtained for subsequent
revisions (on clicking Apply in the module sub folders of the Global Revisions
dialog box):

Previous 1 2 2 Comments
None P0 A B First revision uses initial numbering method (P0); subsequent
revisions use switch to numbering method (A, B, and so
forth.)
P2 A B C First and subsequent revisions use switch to numbering
method (A, B, and so forth.)
A B C D Incremented by one step each time from the previous revision
B C D E Incremented by one step each time from the previous revision
1 2 3 4 Incremented by one step each time from the previous revision
2 3 4 5 Incremented by one step each time from the previous revision

Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• Upgrade Revisions Globally, page 166

Delete Global Revisions

1. In the main window of any SmartPlant Instrumentation module, click Tools >
Global Revisions.

SmartPlant Instrumentation User’s Guide 167

Global Revisions: An Overview

2. On the Settings tab of the Global Revisions dialog box, from the Activity list,
select one of the following:
• Delete revisions — select to delete all revisions for the selected
items.
• Delete last revision— select to delete the last saved revision for each
selected item .
3. Click one of the following tabs: Specifications, Process Data, Calculations,
Loops, Hook-Ups, Wiring, or Dimensional Data.
Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
4. In the data window, filter the items as needed. For details, see Filter Items for
Global Revisions, page 162.
5. In the data window, do one of the following to select the required items:
• Select the desired tag numbers (hold down Ctrl or Shift to make
multiple selections).
• Select the Select all check box to select all the tag numbers in the data
window.
6. Click Apply to delete the revisions for the selected items.
7. If you want to delete revisions for other modules, repeat the appropriate steps for
each module.

Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158

Add Local Revisions

1. In the Revisions dialog box, select one of the revision numbering methods from
the Revision method list (use P0, P1, P2... for preliminary revisions or 0, 1, 2 / A,
B, C, and so forth for normal serial revisions).

168 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Tip
• If you select a revision numbering method other than preliminary
revisions (P0, P1, P2...), you will not be able to return to the
preliminary revision method and this option will be disabled.
2. If needed, in the Drawing number field, type the number of the document
associated with the item for which you create the revision. In drawings and
reports, this number appears in the title block.
3. Click New to add a new revision.

SmartPlant Instrumentation User’s Guide 169

Global Revisions: An Overview

Tips
• If you are working in an integrated environment in a module that
supports publishing and retrieving of documents, clicking New opens
the Revise dialog box for the integrated environment instead of the
SmartPlant Instrumentation Revisions dialog box.
•The software automatically increments the revision number according
to the selected revision method. You can overwrite SmartPlant
Instrumentation revisions if desired.
4. Add or edit the revision data as needed.
Note
• If the document for which you are making a revision contains a
custom-title block, the User-defined fields data window becomes
available for you. In this data window, you can view the user-defined
fields that you added to the custom title block that you created.
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• View an Archived Revision, page 171

Edit Local Revisions

1. In the Revisions dialog box, select the revision that you want to edit.
2. Make the desired changes according to the revision table:
3.
Field Description
No The revision number. This is incremented automatically according to
the revision method selected, you can overwrite it if required.
By Type the initials of the person performing the revision. The default is
the current logged-in user initials, if previously defined by the System
Administrator.
Date The default is today's date, you can modify it if required.
Description Description of the changes made or the purpose of the revision.
Checked By Type the name of the person checking the revision, if required.
Approved Type the name of the person approving the revision, if required.
By

4. Make changes for other revisions as desired.

5. Click OK to apply your changes.

170 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Delete Local Revisions

1. On the Revisions dialog box, select the revision that you want to delete.
2. Click Delete.

Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158

View an Archived Revision

1. In the Administration module, select the desired archiving option. For details, see
Set Archiving Options for Report Comparison in the Administration User's
Guide, under Domain and Project Administration, Report Management.
2. In SmartPlant Instrumentation application, save a revision for the desired
document.
Important
• For enhanced reports, you must perform revisions from the Enhanced
Report Utility if you want them to be archived for performing report
comparison or viewing a changes report.
• The software archives revisions for browser view reports separately
for each view regardless of any existing filter or sort sequence.
3. On the Print Preview toolbar, click to open the Document Revision Archive
dialog box where you view the revision.
4. Double-click the desired revision or revisions to open the print preview.

Related Topics
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158

SmartPlant Instrumentation User’s Guide 171

Global Revisions: An Overview

Report Comparison: An Overview

Report comparison is available if you have saved revisions for a particular report.
For every saved report revision, there is an archived report, stored according to the
archiving option. The Domain Administrator defines an archiving option for each
report.

When comparing reports, you can generate a comparison report to view the report
fields in which the values are different.

Notes
• Report comparison is only available if the System Administrator has
selected Audit trail options in the Domain Definition window for the
current domain, and if the Domain Administrator has selected one of
the options for saving revisions of the specified report in the Report
Management dialog box in the Administration module.
• For enhanced reports, you must perform revisions from the Enhanced
Report Utility if you want them to be archived for performing report
comparison.
• You cannot perform report comparison for Powersoft browsers.
Using report comparison, you can do the following:

• Compare the currently previewed report with an archived report. For

details, see Comparing the Current Report with an Archived Report,
page 175.
• Compare two archived reports. For details, see Comparing Archived
Reports, page 174.
Related Topics
• Setting Font and Color for Report Comparison, page 173
• Viewing Archived Reports, page 176

172 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Setting Font and Color for Report Comparison

This option enables you to set a comparison color and font style prior to comparing
reports. The preset color and font style appear in a previewed report after comparing
this report with an existing archived report. You can also set the grayscale and font
style to appear in a printed report after report comparison. In a previewed report, the
comparison color and font style indicate the differences between the previewed report
and an archived report selected for comparison.

Set Font And Color for Report Comparison

1. On the Tools menu of any SmartPlant Instrumentation module, click Data
Comparison Display Options.
2. Beside the Highlight color for display field, click .
3. In the Color dialog box, choose the color that you require.
4. Click OK to return to the Data Comparison Display Options dialog box.
Tip
• The highlight color you have set appears after report comparison in
any report print preview to indicate the differences between the current
and the archived report.
5. Beside the Grayscale field, click .
6. In the Grayscale dialog box, move the slider to the required position.
7. Click OK to close the Grayscale dialog box.
Tip
• The grayscale you have set appears after report comparison in a
printed report to indicate the differences between the current and the
archived report.
8. Under Font style, do the following if required:
a. Select Bold to mark the differences between the current and the archived
report in bold.
b. Select Italic to mark the differences between the current and the archived
report in italic.

Related Topics
• Report Comparison: An Overview, page 172

SmartPlant Instrumentation User’s Guide 173

Global Revisions: An Overview

Comparing Archived Reports

This option enables you to compare between two archived reports.

Compare the Currently Previewed Report With an Archived

Report
1. In the Print Preview window, do one of the following:

• On the Print Preview window toolbar, click

• On the View menu, click Compare Reports.
2. In the Report Comparison Options dialog box, click Compare two archived
reports.
3. Click OK.
4. In the Select Archived Revisions for Report Comparison dialog box, do the
following:
a. From the Compare data window, select the revision corresponding to the
source archived report.
b. From the With data window, select the revision corresponding to the target
archived report that you want to compare with the source report.
Tip
• If there is a long list of revisions in either of the data windows, type
the desired revision number in the Revision filter box and select
Activate.
Note
• If the archived and the currently previewed reports are different, in the
previewed report the software marks the differences in color. If
required, you can set your own comparison highlight color and font
style to indicate the differences for report display. You can also set a
grayscale and font style to indicate the differences in a printed report.
For details, see Setting Font and Color for Report Comparison, page
173
Related Topics
• Comparing the Current Report with an Archived Report, page 175
• Report Comparison: An Overview, page 172

174 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Comparing the Current Report with an Archived

Report
The option enables you to compare the currently previewed report with an archived
report.

Compare the Currently Previewed Report With an Archived

Report
1. In the Print Preview window, do one of the following:

• On the Print Preview window toolbar, click .

• On the View menu, click Compare.
2. In the Report Comparison Options dialog box, click Compare the current
report with an archived report.
3. Click OK.
4. In the Report Revision Archive dialog box, select the revision corresponding to
the archived report that you require.
Tip
• If there is a long list of revisions in the data window, type the required
revision number in the Revision filter box and select Activate.
5. Click OK to reopen the Print Preview window.
Tip
• If the archived and the currently previewed reports are different, in the
previewed report the software marks the differences in color. If
required, you can set your own comparison highlight color and font
style to indicate the differences for report display. You can also set a
grayscale and font style to indicate the differences in a printed report.
For details, see Setting Font and Color for Report Comparison, page
173.
Related Topics
• Report Comparison: An Overview, page 172

SmartPlant Instrumentation User’s Guide 175

Global Revisions: An Overview

Viewing Archived Reports

This option enables you to open a report preview of any archived report. The software
automatically archives reports when saving report revisions for the currently
previewed report. The Domain Administrator defines an archiving option for each
report.

View an Archived Report

1. In the Print Preview window, do one of the following:
• On the Print Preview window toolbar, click
• On the View menu, click Report Revision Archive.
2. In the Report Revision Archive dialog box, select the revision which
corresponds to the archived report you want to view.
Tip
• If there is a long list of revisions in the data window, type the required
revision number in the Revision filter list, and select Apply.
3. Click OK to open the archived report in the Print Preview window.

Related Topics
• Report Comparison: An Overview, page 172

176 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Displaying Changed Documents

This option enables you to display a list of documents for which data modifications
have been made. To use this option, the Domain Administrator must first select the
Save Document Data option in the Report Management dialog box for each report
that you want to include in the list. The software does not include in changes reports
any modifications that you make to title block macros or external symbols such as
DCS data or non- wiring tag lists in enhanced reports.

The software does not display data changes in the following cases:

• If you add a new item such as a panel or gland in list reports, because
the software cannot determine whether the item is part of the
document.
• If you remove or assign tags or items in the Hook-ups module.
• For the Instrument Index Drawing Summary Browser. Changes that
you make in the Instrument Index Standard Browser are included in
the Browse - Instrument Index Report item, and not in the
Instrument Index under the list of browser

Display a List of Changed Documents

1. On the Tools menu, click Changed Documents.
2. In the Changed Documents dialog box, do one of the following:
• Under Document types, highlight the desired document types. For
multiple selection, hold down Ctrl or Shift while making your
selection.
• Select the Select All check box.
3. Under Filter by, select an option to specify the method of filtering. The available
options are:
• Documents changed since last revision - select to filter documents
for which data was changed since the last revision of the document. If
there is no revision, the software does not display that document.
• Documents changed between specified dates - select to filter
documents for which data was changed during the date range specified
by the From date and To date fields.
4. Click Find to retrieve the list of changed documents according to the document
types and filter options that you specified.
5. Click Changes Report if you want to display a report of the changed documents.

SmartPlant Instrumentation User’s Guide 177

Global Revisions: An Overview

Workflow
The Workflow option enables instrument engineers to control the data entry process
for instrument tags by specifying if and when process data should be entered for a
particular tag. Workflow defines an additional level of access rights for individual
instrument tags, determined by the Workflow status of the tags. In this way, an
instrument engineer, while working on instrument data for a particular tag, can lock
out process engineers from making changes to process data until all the instrument
data has been entered.

Example Scenario
The following stages describe a typical Workflow scenario:
1. An instrument engineer creates a new instrument tag and determines whether or
not the tag requires process data. In the event that the instrument tag does require
process data, the process data fields of the tag become available to the process
engineers for editing.
2. The process engineer, after first accessing the instrument tag for editing of
process data, can lock the process data fields against any changes wherever the
instrument engineers have access rights.
3. On being released by the process engineer, the instrument engineer can now enter
instrument data as required. The instrument engineer can lock the tag against any
changes wherever the process engineers have access rights.

Related Topics
• Create a Workflow Browser, page 180
• Implementing Workflow, page 181
• Process Data Statuses, page 183
• Workflow Prerequisites, page 179

178 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Workflow Prerequisites
Before you can implement Workflow in a given <unit>, the System Administrator and
Domain Administrator need to perform the following tasks:

• The System Administrator enables Workflow in your domain. For

more information, see the Administration module Online Help, System
Administration > Domain Management > Enable Workflow.
• The Domain Administrator defines two groups that will be responsible
for working in the areas of process engineering and instrument
engineering. For more information, see Creating a New Group Profile
in Online Help for the Administration module.
• The Domain Administrator does one of the following:
• Associates Windows groups with the SmartPlant Instrumentation
process engineering and instrument engineering groups. For more
information, see the Administration module Online Help, Users,
Departments, and Groups > Create a Group for Windows
Authentication Logon Method.
• Assigns users individually to the process engineering and
instrument engineering groups. For more information, see the
Administration module Online Help, Users, Departments, and
Groups > Assign Users to Groups.
• The Domain Administrator defines Workflow access rights for the
process engineering and instrument engineering groups. For more
information, see the Administration module Online Help, Domain And
Project Administration > Access Rights > Workflow Access Rights.
Note
• After initialization of a domain from a source or after a version
upgrade, it is essential to regenerate the library forms to enable the
Workflow options to be used in the Specifications Browser.
Related Topics
• Create a Workflow Browser, page 180
• Implementing Workflow, page 181
• Workflow, page 178

SmartPlant Instrumentation User’s Guide 179

Global Revisions: An Overview

Create a Workflow Browser

Important
• Workflow needs to be set up by an instrument engineer.
• Make sure that the System Administrator and the Domain
Administrator have prepared SmartPlant Instrumentation for
Workflow. For more information, see Workflow Prerequisites, page
179.
1. Open the Browser Manager.
2. Under Browser groups, double-click Workflow to expand the hierarchy.
3. Select the Instrumentation/Process Data Browser and create a new view.
4. Double-click the view to expand the hierarchy.
5. Click , and in the Style settings section, click Edit.
6. Select the check boxes in the View column to specify the fields to be displayed in
the view.
Important
• You must include the Process Data Status field among the fields
selected for displaying in the view.
7. Click Save.
8. Select the View level in the tree, and then click Actions > Open View.
The Browser View opens showing the process data statuses for all the instrument
tags in the database. For details, see Process Data Statuses, page 183

Related Topics
• Implementing Workflow, page 181
• Process Data Statuses, page 183
• Workflow Prerequisites, page 179
• Workflow, page 178

180 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Implementing Workflow
Workflow implementation begins when the instrument engineer who is going to work
on particular instrument tags determines whether those tags require process data.
Next, those tags that do require process data are assigned to a process engineer for
process data input. On completion of the data input, the tags are reassigned to the
instrument engineer for instrument data input.

Enter Initial Instrument Data

1. Log on to SmartPlant Instrumentation as a user in the Instrument group.
2. In the Instrument Index module, create the instrument tags as you require and
enter appropriate data.
3. In the Browser Manager, under Browser groups, double-click Workflow to
expand the hierarchy.
4. Refresh the screen by clicking .
Any new instrument tags should be visible, with default status: Process Data
not Required.
5. In the Process Data Status field, select the required status of each instrument tag
you will be editing as follows:
a. For instrument tags that require process data, select status: Process Data
Required.
These tags will be available for the process engineer in the Process Data
and Calculation modules.
b. For instrument tags that do not require process data, select status: Process
Data not Required.

Enter Process Data for Instrument Tags

1. Log on to SmartPlant Instrumentation as a user in the Process group.
2. In the Process Data module, for each tag that requires the addition of process data,
do the following:
a. Find and open the tag.
b. In the Process Data window, enter process data as you require.
c. On the Actions menu, click Save Process Data.
d. In the Select a New Process Data Status dialog box, select Release to
Instrument, and click OK.

SmartPlant Instrumentation User’s Guide 181

Global Revisions: An Overview

Enter Additional Instrument Data

1. Log on to SmartPlant Instrumentation as a user in the Instrument group.
2. In the Browser Groups list, Workflow, select the Instrumentation/Process
Data Browser and open the view you created for it.
3. For each tag for which you want to edit instrument data, make sure that the value
under Process Data Status is Lock out from Process.
4. In the Instrument Index module, do one of the following:
• Open each tag individually and enter the required instrument data.
• Create an appropriate Instrument Index browser view from which to
enter the data.
Related Topics
• Create a Workflow Browser, page 180
• Process Data Statuses, page 183
• Workflow, page 178

182 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Process Data Statuses

There are five statuses that relate to tags under Workflow. The following table
provides a description of each status and which groups (instrument engineers or
process engineers) are allowed to set and change the status in the Workflow >
Instrumentation / Process Data Browser and in the Process Data module:

Status Description Set / Changed by

Process Data Tags that do not require process data Set and changed by
not Required and therefore are not available to the instrument engineers.
process engineering group.
Process Data Tags available for process data entry by Set by instrument
Required the process engineering group (in the engineers. Can be
Process Data module or Browser). changed by process
engineers.
Lock out from Tags marked for editing by the process Set and changed by
Instrument engineering group and not available to process engineers.
the instrument group.
Release to Tags available to the instrument Set by process engineers.
Instrument engineering group following release Can be changed by
from the process group. instrument engineers.
Lock out from Tags not available to the process Set and changed by
Process engineering group. instrument engineers

Related Topics
• Create a Workflow Browser, page 180
• Implementing Workflow, page 181
• Workflow, page 178

SmartPlant Instrumentation User’s Guide 183

Global Revisions: An Overview

Printing and Saving Documents: An Overview

You can print or save documents containing essential data from every module.
Documents that can be printed include all reports, and some visual presentations of
data such as point-to-point wiring diagrams. Selecting to preview a document
ensures that it will be printed the way you want and enables you to specify the file
format if you want to save the document.

Related Topics
• Editing Document Headers, page 191
• Modifying Printer Settings, page 189
• Previewing Documents, page 185
• Printing Documents, page 187
• Saving Documents, page 190

184 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Previewing Documents
The option to preview a document is available whenever you select a report, a point-
to point wiring diagram for printing, or if you select the Print Preview option from a
browser view.

Note
• The Print Preview dialog box appears only after you select Always or
Ask user in the General tab of the Preferences dialog box.
The Print Preview dialog box appears only after you select Always or Ask user in
the General tab of the Preferences dialog box.

Preview a Document
1. Select the report you want to display and when prompted to preview the report,
click Yes.
2. Click to adjust the currently displayed report's magnification level.
3. In the Zoom dialog box, do one of the following:
• In the Magnification section, select a predefined magnification level:
200%, 100% (the default level), 65%, or 30%.
• Type the required magnification level in the field next to the Custom
option button.
4. Click OK to return to the Print Preview window at the selected magnification.

SmartPlant Instrumentation User’s Guide 185

Global Revisions: An Overview

5. In the case of reports consisting of several pages or multiple reports, navigate

using the following options:
Click... ...or on the View ...to do this:
menu, click
First Page Browse to the first page of a multi-page report. You can
also move through the pages of a report using the
vertical scroll box. Clicking the scroll box displays the
current page number.
Previous Page Browse to the previous page of a multi-page report
Next Page Browse to the following page of a multi-page report
Last Page Browse to the last page of a multi-page report
First Report Browse to the first report (available with multiple report
selection only).
On the View Browse to the previous report (available with multiple
menu, click report selection only).
Previous Report
Next Report Browse to the following report (available with multiple
report selection only).
Last Report Browse to the last report (available with multiple report
selection only).

Related Topics
• Modifying Printer Settings, page 189
• Printing Documents, page 187
• Saving Documents, page 190

186 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Printing Documents
Depending on the options you selected, printing is available directly when you select
a document for printing, or you can print a document from a print preview. This
procedure refers to general printing. For details of batch printing to .pdf files, see
Previewing Documents, page 185.

Note
• If your default printer is Acrobat PDFWriter, you must perform the
following operation in the Registry Editor: in the registry path
HKEY_CURRENT_USER\Software\Adobe\Acrobat PDFWriter, set
the SZ Busy key value to NULL.

Print Documents
1. Select the desired items from which you can print reports, and on the appropriate
main menu or, if available, on a shortcut menu, click the report that you want to
print.
2. If a print preview prompt appears, do one of the following:
• Click Yes to display a print preview of one or more reports.
• Click No to print the reports directly to a printer or a file.
3. To print a report from a print preview to a printer or a file, do one of the
following:

• In the Print Preview window, click to print the currently selected

report.
• In the Print Preview window, click to print all the retrieved
reports or documents in batch mode.
Note
• If you choose to directly print a report without previewing it, and the
particular report usually includes printing parameters when viewed in
the Print Preview window (for example, selection of a group
separator), a dialog box opens to enable you to select those same
parameters prior to printing.
Related Topics
• Modifying Printer Settings, page 189
• Previewing Documents, page 185
• Saving Documents, page 190

SmartPlant Instrumentation User’s Guide 187

Global Revisions: An Overview

Batch Printing Documents to PDF Files

SmartPlant Instrumentation supports batch printing of the following documents to
.pdf files:

• Enhanced reports.
• Specification sheets.
• Binder packages from the Document Binder module. For details, see
Printing from a Binder Package to a PDF File, page ???.
Related Topics
• Modifying Printer Settings, page 189
• Previewing Documents, page 185
• Printing Documents, page 187
• Saving Documents, page 190

188 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Modifying Printer Settings

This option enables you to view and modify the current printer settings, if required.
You can select a standard paper size with predefined width, height, and orientation or
customize these settings as required. Furthermore, you can save your settings as
default for future print sessions. You can customize your own paper width, height,
and orientation and include these values in the default settings. Note, that some
reports have their orientation hard-coded, therefore only the hard-coded settings will
apply.

Notes
• All your page settings apply to all reports and documents that you print
and they are true for all plant hierarchy levels (domain, <plant>,
<area>, and <unit>).
• All your page settings apply to your local machine only and do not
affect other users of SmartPlant Instrumentation.
• If you want to change the page setup for the current print session only,
do not click Default, just make your changes and click OK.
When saving your settings as default, the software stores the values in the Intools.ini
file under the [PRINTER] section. If you want the software to calculate the required
paper size from the Windows printer driver settings, open the Intools.ini file and
under the [PRINTER] section, remove the semi-colon before the following
parameters:

• LEFTMARGIN
• RIGHTMARGIN
• TOPMARGIN
• WIDTH
• HEIGHT
• ORIENTATION
• HRES
• VRES
Add a semi-colon before the PAPERSIZE parameter.

For additional information about this option, click Help in the Page Setup dialog
box.

Related Topics
• Previewing Documents, page 185

SmartPlant Instrumentation User’s Guide 189

Global Revisions: An Overview

Saving Documents
When you display a document, you can choose to save it as a file. This section
describes the various methods available for saving documents.

Save the Current Document to a File

1. With the Print Preview window open, click .
2. In the Save As dialog box, select one of the following data formats:
• Original: Saves the report data in all the fields, including the ones that
are not visible in the preview (for example, internal database ID
numbers). This option is recommended if you want to save the file in
.psr or .xls format, or if you want to re-import the data into SmartPlant
Instrumentation at a later stage.
• Data Only: Saves only the report data that is visible in the preview.
This option is recommended for easier viewing of the data, and also
enables you to manipulate the headers and select the columns you
want to display.
3. Click OK and navigate to the location where you want to save the file.
4. Select the required file format and type the name of the file, then click Save.

Related Topics
• Editing Document Headers, page 191

190 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Saving in DXF Format

If you use SmartSketch or AutoCAD, you can save any report in .dxf format for
insertion into a CAD drawing. This option is available when you select to save a
document as a file from a Print Preview window. On selecting to save the file in
.dxf format, you can specify the report insertion parameters in the target CAD
drawing, define certain display properties, and set the software to include the title
block and frame, if needed.

If a report has several pages, the software creates several .dxf files. A .dxf file can
only contain a single page of a report.

Important
• When saving a multi-page specification in .dxf format, the software
only saves the active page of the spec print preview. To save all pages
of a spec in .dxf format, you must display a print preview of each page
and save the pages one by one.
• It is not possible to save the multi-tag (SEE LIST) page of a multi-tag
spec in .dxf format.

Save a Document in DXF Format

1. With the Print Preview window open, click File:
C:\TEMP\SmartWrite\SaveAs_TB.png NOT FOUND..
2. In the Save As dialog box, select DXF File.
3. In the Save As DXF Options dialog box, select Include title block and frame
with report to save the report with the title block (which includes the logo and
generic report data) and the frame.
Tips
• Clear the check box to exclude the title block and frame from the
saved report if the CAD package has its own frame.
• If you are working in batch mode to save a number of files that are to
be opened in SmartSketch or AutoCAD, you can automate the process
as far as possible.

SmartPlant Instrumentation User’s Guide 191

Global Revisions: An Overview

4. Define the report placement parameters and other options as follows:

File Description
Insertion point The X and Y coordinates for the insertion point of the report in the
CAD file define the displacement from the lower-left corner of the
CAD file. The upper-left corner of the report is inserted at this
location. This means that if the insertion point is defined as X=0
and Y=0, the report appears outside the CAD drawing frame, under
the lower frame line.
Scale factor The scale factor determines the size of the report so that it will fit
into the CAD drawing.
Font height Font height and width coefficients for the text characters in the
coefficient / Font report. This option is needed because the software calculates the
width coefficient font size independently of the size of the report, whereas a CAD
application scales the font with the report as a whole.
Change black Type the value of the color to be used as a substitute for black. All
report color to reports are displayed in black-and-white. If viewing the report in a
CAD application with a black background, an alternative
foreground color needs to be used. The recommended value is 7.

5. Browse to the target folder and click OK.

192 SmartPlant Instrumentation User’s Guide

 Global Revisions: An Overview

Editing Document Headers

When you select to save a document as a file from the Print Preview dialog box and
you choose to save it as data only, you have the option of saving the data with or
without headers. Furthermore, if you select to include the headers with the data, you
can also edit them. This includes the possibility of exporting the headers to a separate
text file.

Edit the Headers for a Report

1. With the Print Preview window open, click .
2. In the Save As dialog box, select Data Only.
3. Select the Allow Headers check box.
4. Select the Edit Headers check box and click OK.
5. Select the required file format and file path and click Save.
6. In the Edit Column Headers dialog box, select the Incl. check box for the
columns you want to include in the output file.
7. Under the Header Text column, edit the text as required.
8. Under the Width column, change the maximum text width (number of characters
allowed) as required.
9. If you want to save the header settings in this screen to a text file:
a. Click Export Headers.
b. In the Export to File dialog box, navigate to the required location and enter a
file name.
c. Click Save.
Note
• If an external header text file exists, you can click Import Headers to
load the data into the Export to File dialog box.
Related Topics
• Saving Documents, page 190

SmartPlant Instrumentation User’s Guide 193

Claiming As-Built Items for a Project: An Overview

Claiming As-Built Items for a Project: An

Overview
In an owner operator domain, when working in a project with As-Built items
displayed, you can claim As-Built items for this project directly in SmartPlant
Instrumentation. It is possible to claim As-Built items using one of the following
modes: exclusive claim mode or non-exclusive claim mode. The System
Administrator sets the claim mode when making domain definitions in the
Administration module. After a Project Administrator creates the first project in the
domain, the claim mode becomes set permanently for the current domain until the
Project Administrator deletes all of the projects.

Claiming items is the final stage of defining the project scope. Before claiming items,
you can copy them to the Claim Buffer, which is only available in the
Administration module. Then, your Project Administrator can log on to the
Administration module and claim the copied items for the project in batch mode.
Alternatively any user with full Project Definition access rights can claim the copied
items using command line parameters.

Any SmartPlant Instrumentation user can copy any number of items to the Claim
Buffer, however, only users with full Claim Items for Project access rights can
claim As-Built items directly from the project opened in SmartPlant Instrumentation,
without copying them to the Claim Buffer first, provided that the Claim Buffer is
empty. Performing a batch claim of As-Built items directly from the project is not
possible. You can only claim a specific item that you select, with or without its child
items, according to the preferences.

When using non-exclusive claim mode, in SmartPlant Instrumentation, it is only

possible to claim items from As-Built. If you want to claim items from one project to
another, you must use the Administration module options. For details about claiming
data using the Administration module options or command line parameters, see
Scoping Data for Projects: An Overview in the Administration User's Guide, under
Domain and Project Administration, Scoping Data for Projects..

When the As-Built item used as a source for claiming has child items, you can set
preferences to include or exclude the child items when claiming the parent item. For
example, you can claim a cable with or without its associated cable sets or wires. It is
also possible to reclaim the same item to update the item properties with the As-Built
item properties. For details about the preferences for claiming see Claim and Merge
Options (Preferences), page 123.

194 SmartPlant Instrumentation User’s Guide

 Claiming As-Built Items for a Project: An Overview

In a project, claiming options are available in the Instrument Index module, Browser
module, and the Domain Explorer:

• In the Instrument Index module, you can select instruments and claim
them with the engineering data defined in other modules, for example,
with the associated hook-ups.
• In the Browser module, you can select instruments, lines, loop
numbers, or equipment data for claiming.
• In the Domain Explorer, you can select any item and copy it to the
Claim Buffer for further processing by your Project Administrator, or
claim the items according to the preferences set on the Claim and
Merge Options page of the Preferences dialog box. Note, however,
that if you want to claim fieldbus tags, you only need to claim the
associated fieldbus segments with their sub-items and the fieldbus tags
are claimed automatically.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Display As-Built and Project Data, page 199
• Working with SmartPlant Instrumentation: An Overview, page 45
• Working with the Domain Explorer: An Overview, page 207

SmartPlant Instrumentation User’s Guide 195

Preparing Project Items for Merging with As-Built: An Overview

Preparing Project Items for Merging with As-

Built: An Overview
In a project opened in an owner operator domain, in the Domain Explorer, you can
select items you want to merge with As-Built and copy them to the Merge Buffer for
further processing from the Administration module or for merging the copied items
using command line parameters. The Merge Buffer is only accessible from the
Administration module. It is not possible to merge items directly from a project. For
details about merging data using the Administration module options or command line
parameters, see Merging Project and As-Built Data: An Overview in the
Administration User's Guide, under Domain and Project Administration, Scoping
Data for Projects..

Before you copy items to the Merge Buffer, you can set preferences to include or
exclude the child items when copying the parent item. For example, you can copy a
cable with or without its associated cable sets or wires. For details about the
preferences for copying items to the Merge Buffer, see Claim and Merge Options
(Preferences), page 123.

When copying items to the Merge Buffer, you select a merge action for all or
selected items. At this stage, the software applies the merge action to the items and
also applies the preferences options that you have set. The following actions are
available per item:

Merge now — Overwrites the data in As-Built with the modified data in the current
project. The results depend on the change made in the project:

• Items that SmartPlant Instrumentation users created in the project are

also inserted in As-Built. If an item that exists in the project was
deleted in As-Built, that item is reinserted in As-Built.
• Items that SmartPlant Instrumentation users deleted in the project are
also deleted in As-Built.
• Items that SmartPlant Instrumentation users updated in the project are
also updated in As-Built. Also, if you made any changes to As-Built
data after claiming the item for the project, the software overwrites the
As-Built data with the project data on merging.
Release claim — Disregards changes and leaves the data in As-Built as it was
before claiming it for the project. When using the Release Claim action, the
following rules apply to project data:

• The Release Claim action does not apply to new items that you create
in the project.

196 SmartPlant Instrumentation User’s Guide

 Preparing Project Items for Merging with As-Built: An Overview

• The Release Claim action does not apply to new sub-items you
associated with a claimed item.
• If a claimed item does not have new sub-items you created in the
project, the software removes the claimed item from the project even if
you changed its name and description in the project.
• If a claimed item has new sub-items you created in the project, the
software always leaves this claimed item as a dummy item in the
project.
• If a claimed item has both claimed sub-items and new sub-items you
created in the project, the software only removes the claimed sub-
items from the project. The parent item appears in the project as a
dummy item.
Notes
• Your Project Administrator can merge items using one of the two
modes set by System Administrator for the current domain: with
deletion from the project or without deletion from the project.
Depending on the merge mode, on merging data, the software either
deletes the merged items from the project or leaves view-only copies
of the merged items in the project. You cannot delete these copies or
update their properties. It is possible, however, to claim these items
for another project even if you are working in exclusive claim mode.
• If you want to merge fieldbus tags, you only need to copy to the
Merge Buffer the associated fieldbus segments with their sub-items.
It is not possible to merge fieldbus tags manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Display As-Built and Project Data, page 199
• Working with SmartPlant Instrumentation: An Overview, page 45
• Working with the Domain Explorer: An Overview, page 207

SmartPlant Instrumentation User’s Guide 197

Preparing Project Items for Merging with As-Built: An Overview

Claiming and Merging Items Common Tasks

In an owner operator domain, the following tasks are used frequently when you claim
or copy to the Claim Buffer items directly from a project opened in SmartPlant
Instrumentation. Also, it is possible to prepare project data for merging with As-Built
by copying project items to the Merge Buffer. After copying items to the Merge
Buffer, your Project Administrator can either user the Administration module options
to merge the items, or merge the items from the command line. The Claim Buffer
and Merge Buffer are only accessible from the Administration module.

Display As-Built and Project Data

If you open a project in an owner operator domain, you can either choose to display
only the project items, or project items together with view-only As-Built items, which
you can claim for the project. It is only possible to claim items if you open a project
together with As-Built items displayed. For details, see Display As-Built and Project
Data, page 199.

Copy As-Built Items to the Claim Buffer

This procedure allows you to copy items from the SmartPlant Instrumentation
Domain Explorer to the Claim Buffer, which is only accessible from the
Administration module. After you copy the items, the Project Administrator can log
on to the Administration module and claim all or specific the items that you copied in
the Claim Buffer. When you select items, the software automatically applies
preferences that you set on the Preferences dialog box. These preferences determine
how the software copies to the Claim Buffer sub-items that are associated with the
items you select. For more information, see Copy As-Built Items to the Claim Buffer,
page 200.

Claim As-Built Items from the Domain Explorer

If the Claim Buffer does not contain any items, you can use this procedure to claim
items directly from the Domain Explorer. When you select items, the software
automatically applies preferences that you set on the Preferences dialog box. These
preferences determine how the software claims sub-items that are associated with the
items you select. For more information, see Claim As-Built Items from the Domain
Explorer, page 201.

Claim Instruments in the Browser or Instrument Index Module

You can claim tag numbers in the Instrument Index module, or in the Browser
module. In an owner operator domain, use this procedure to claim the As-Built tags
for the current project, with or without the engineering data associated with the tags.
For more information, see Claim Instruments in the Browser or Instrument Index
Module, page 202.

198 SmartPlant Instrumentation User’s Guide

 Preparing Project Items for Merging with As-Built: An Overview

Claim Loops, Lines, and Equipment in the Browser Module

This procedure describes how to claim As-Built loops, lines, and equipment in the
Browser module. The software claims items without any engineering data that is
associated with the items. For example, when claiming a loop, the software does not
claim the tag numbers associated with the loop. For more information, see Claim
Loops, Lines, and Equipment in the Browser Module, page 203.

Copy Items to the Merge Buffer as Merge Now

Use this procedure to copy specific items from the Domain Explorer to the Merge
Buffer and assign a Merge Now action to these items. For more information, see
Copy Items to the Merge Buffer as Merge Now, page 203.

Copy Items to the Merge Buffer as Release Claim

Use this procedure to copy specific items from the Domain Explorer to the Merge
Buffer and assign a Release Claim action to these items. For more information, see
Copy Items to the Merge Buffer as Release Claim, page 204.

Related Topics
• Claiming As-Built Items for a Project: An Overview, page 194
• Preparing Project Items for Merging with As-Built: An Overview, page
196

Display As-Built and Project Data

1. On the Open dialog box, select a domain of type Owner operator.

2. Double-click the appropriate project icon to select the project you want to
work with (As-Built or a project).
• To view As-Built data only, select As-Built from the list.
• To view project data, select any project from the list (you can choose
afterwards whether to display As-Built data with the project data –
see steps 4 and 5 for details).
3. Select the <unit> in which you want to work and click OK. By default,
SmartPlant Instrumentation opens with data visible only from the project you
selected.
4. To display As-Built and project data together, do one of the following:

• Click .
• Click File > As-Built Data.
5. To return to the display of project data only, do one of the following:
• Click .

SmartPlant Instrumentation User’s Guide 199

Preparing Project Items for Merging with As-Built: An Overview

• Click File > Project Data.

Notes
• According to the data you select to display, the items will be formatted
according to the settings made in the Administration module.
• If you select to display both project and As-Built data, you can edit the
project data only.
• When working in a project with As-Built items displayed, As-Built
items are view-only. In the Domain Explorer, you can select an As-
Built item and display its properties. As-Built items are indicated with
the icon.
Related Topics
• Claiming As-Built Items for a Project: An Overview, page 194
• Getting Started Common Tasks, page 50
• Item Status Indicators in the Domain Explorer, page 229
• Navigating in SmartPlant Instrumentation, page 51
• Working with SmartPlant Instrumentation: An Overview, page 45

Copy As-Built Items to the Claim Buffer

1. Open a project together with the As-Built data displayed. For details, see Display
As-Built and Project Data, page 199.
2. Press F7 to open the Domain Explorer.
3. Expand the explorer hierarchy to display folders of item types.
4. In the tree view pane, click an item type folder to display the items.
5. Do one of the following:
• In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Project Activities > Copy to Claim Buffer.
• In the Items pane, select and right-click one or more items, and then,
on the shortcut menu, click Project Activities > Copy to Claim
Buffer.
Tips
• When you copy items to the Claim Buffer, in addition to the main
items you select, the software can select the associated sub-items
automatically, or you have the option to include the sub-items
manually with the main item by setting preferences accordingly. For
details, see Claim and Merge Options (Preferences), page 123.

200 SmartPlant Instrumentation User’s Guide

 Preparing Project Items for Merging with As-Built: An Overview

• If you copied to the Claim Buffer a loop or instrument together with

the wiring items, the software only copies those wiring items that have
a signal propagated to the loop or instrument. If you placed a device
panel inside a cabinet or junction box, when claiming the loop, this
device panel is not copied together with the cabinet or junction box
because this device panel does not have a signal propagated to the
loop. You must select and copy such a device panel manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194

Claim As-Built Items from the Domain Explorer

Note
• Claiming items from the Domain Explorer is only possible if the
Claim Buffer in the Administration module has no items.
1. Open a project together with the As-Built data displayed. For details, see Display
As-Built and Project Data, page 199.
2. Press F7 to open the Domain Explorer.
3. Expand the explorer hierarchy to display folders of item types.
4. In the tree view pane, click an item type folder to display the items.
5. Do one of the following:
• In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Project Activities > Claim.
• In the Items pane, select and right-click one or more items, and then,
on the shortcut menu, click Project Activities > Claim.
Tips
• When claiming instruments from the Domain Explorer, you cannot
select basic engineering data manually or set the software to claim
instruments without including the associated basic engineering data. It
is possible to claim instruments without the engineering data in the
Browser or Instrument index module. For details, see Claim
Instruments in the Browser or Instrument Index Module, page 202.
• When you claim items, in addition to the main items you select, the
software can select the associated sub-items automatically, or you have
the option to include the sub-items manually with the main item by
setting preferences accordingly. For details, see Claim and Merge
Options (Preferences), page 123.

SmartPlant Instrumentation User’s Guide 201

Preparing Project Items for Merging with As-Built: An Overview

• If you claimed a loop or instrument together with the wiring items, the
software only claims those wiring items that have a signal propagated
to the loop or instrument. If you placed a device panel inside a cabinet
or junction box, when claiming the loop, this device panel is not
claimed together with the cabinet or junction box because this device
panel does not have a signal propagated to the loop. You must select
and claim such a device panel manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194

Claim Instruments in the Browser or Instrument Index

Module
1. Open a project together with the As-Built data displayed. For details, see Display
As-Built and Project Data, page 199.
2. Do one of the following:
• Open an Instrument Index Standard Browser view.
• In the Browser module, open a browser view for the Instrument Index
browser.
3. Select and right-click the As-Built tag numbers that you want to claim for the
current project.
Tip
• As-Built and project tag numbers have different color coding. The
Project Administrator selects which colors to use on the Project
Activities dialog box in the Administration module.
4. On the shortcut menu, click Claim.
5. In the Tag Claiming Options dialog box, select Basic engineering data to claim
associated data that was defined for the tags in the Instrument Index, Calculation,
Specifications, Hook-Ups, Process Data, and Dimensional Data for Piping
modules.
6. Select Wiring data to claim associated wiring data that was defined for the tags
in the Wiring module.
Tip
• It is possible to claim instruments either without the engineering data
or without the wiring data. You must select at least one check box.
Related Topics
• Claiming and Merging Items Common Tasks, page 198

202 SmartPlant Instrumentation User’s Guide

 Preparing Project Items for Merging with As-Built: An Overview

Claim Loops, Lines, and Equipment in the Browser Module

1. Open a project together with the As-Built data displayed. For details, see Display
As-Built and Project Data, page 199.
2. In the Browser module, expand the Instrument Index browser group and open a
browser view for one of the following browsers:
• Loop Browser.
• Line Browser.
• Equipment Browser.
3. Select and right-click the As-Built items that you want to claim for the current
project.
Tips
o As-Built and project items have different color coding. The Project
Administrator selects which colors to use on the Project Activities
dialog box in the Administration module.
o In the Browser module, you can also claim instrument tag numbers.
For details, see Claim Instruments in the Browser or Instrument Index
Module, page 202.
4. On the shortcut menu, click Claim.

Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194

Copy Items to the Merge Buffer as Merge Now

1. Open a project together with the As-Built data displayed. For details, see Display
As-Built and Project Data, page 199.
2. Press F7 to open the Domain Explorer.
3. Expand the explorer hierarchy to display folders of item types.
4. In the tree view pane, click an item type folder to display the items.
5. Do one of the following:
o In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Project Activities > Copy to Buffer as Merge
Now.
o In the Items pane, select and right-click one or more items, and then,
on the shortcut menu, click Project Activities > Copy to Buffer as
Merge Now.

SmartPlant Instrumentation User’s Guide 203

Preparing Project Items for Merging with As-Built: An Overview

Tips
o If the items that you select already appear in the Merge Buffer, when
copying the items, the software also changes the merge action to
Merge Now for those items.
o When you copy items to the Merge Buffer, in addition to the main
items you select, the software can select the associated sub-items
automatically, or you have the option to include the sub-items
manually with the main item by setting preferences accordingly. For
details, see Claim and Merge Options (Preferences), page 123.
o If you copied to the Merge Buffer a loop or instrument together with
the wiring items, the software only copies those wring items that have
a signal propagated to the loop or instrument. If you placed a device
panel inside a cabinet or junction box, when merging the loop, this
device panel is not copied together with the cabinet or junction box
because this device panel does not have a signal propagated to the
loop. You must select and copy such a device panel manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194
• Preparing Project Items for Merging with As-Built: An Overview, page 196

Copy Items to the Merge Buffer as Release Claim

1. Open a project together with the As-Built data displayed. For details, see Display
As-Built and Project Data, page 199.
2. Press F7 to open the Domain Explorer.
3. Expand the explorer hierarchy to display folders of item types.
4. In the tree view pane, click an item type folder to display the items.
5. Do one of the following:
• In the tree view pane, right-click a specific item, and then, on the shortcut
menu, click Project Activities > Copy to Buffer as Release Claim.
• In the Items pane, select and right-click one or more items, and then, on the
shortcut menu, click Project Activities > Copy to Buffer as Release Claim.
Tips
o If the items that you select already appear in the Merge Buffer, when
copying the items, the software also changes the merge action to
Release Claim for those items.

204 SmartPlant Instrumentation User’s Guide

 Preparing Project Items for Merging with As-Built: An Overview

o When you copy items to the Merge Buffer, in addition to the main
items you select, the software can select the associated sub-items
automatically, or you have the option to include the sub-items
manually with the main item by setting preferences accordingly. For
details, see Claim and Merge Options (Preferences), page 123.
• If you copied to the Merge Buffer a loop or instrument together with the
wiring items, the software only copies those wring items that have a signal
propagated to the loop or instrument. If you placed a device panel inside a
cabinet or junction box, when merging the loop, this device panel is not
copied together with the cabinet or junction box because this device panel
does not have a signal propagated to the loop. You must select and copy such
a device panel manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194
• Preparing Project Items for Merging with As-Built: An Overview, page 196

SmartPlant Instrumentation User’s Guide 205

SmartPlant Instrumentation Explorer: An Overview

SmartPlant Instrumentation Explorer: An

Overview
You use the SmartPlant Instrumentation Explorer to access and manage all the
items that exist in SmartPlant Instrumentation. SmartPlant Instrumentation features
the Domain Explorer and the Reference Explorer.

• Domain Explorer — this view of the SmartPlant Instrumentation

Explorer allows you to create and manage your current domain items. You
can perform almost all the actions that are possible in the SmartPlant
Instrumentation modules. For example, you can create new tag numbers, edit
their properties, create and edit wiring items, make wiring connections,
generate various data sheets, reports, and so forth. Also, you can copy items
from the Reference Explorer and this way create items based on reference
configurations on the fly. The Domain Explorer displays instrumentation
items according to hierarchical structure. You can arrange the hierarchical
structure of the data according to the item types, the physical location of the
items, or the item sequence within their parent item. For more information,
see Working with the Domain Explorer: An Overview, page 207.
• Reference Explorer — allows you to create and manage all the available
wiring reference items that are created by SmartPlant Instrumentation users
and that are provided with the software. Note that wiring reference items are
typical configurations that facilitate rapid creation of various wiring items in
your domain. For more information, see Working with the Reference
Explorer: An Overview, page 244.
Note
o When you create an item in the domain explorer, make sure you set the
naming convention for it in the Administration module. For details see
Naming Conventions: An Overview in the Administration User's
Guide, under Domain Administration.
Related Topics
• Domain Explorer Common Tasks, page 209
• Working with the Reference Explorer: An Overview, page 244

206 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Working with the Domain Explorer: An

Overview
You use the Domain Explorer to create and manage your current domain items. The
Domain Explorer displays instrumentation items according to hierarchical structure.
You can arrange the hierarchical structure of the data according to the item types, the
physical location of the items, or the item sequence within their parent item .

Note
• When you create an item in the domain explorer, make sure you set the
naming convention for it in the Administration module. For details see
Naming Conventions: An Overview in the Administration User's
Guide, under Domain and Project Administration.
The Domain Explorer enables you to perform almost all the actions that are possible
in the SmartPlant Instrumentation modules. For example, you can create new tag
numbers, edit their properties, create and edit wiring items, open the Connection
window to make wiring connections, generate various data sheets, reports, and so
forth. You can drag items from the Reference Explorer to the Domain Explorer
and in this way create numerous items based on reference configurations on the fly.
Also, you can drag items from the Domain Explorer to the Reference Explorer to
create reference items based on existing configurations.

Working with the Domain Explorer is another mode of working with SmartPlant
Instrumentation, just like working with SmartPlant Instrumentation modules.

You can open the Domain Explorer from anywhere in SmartPlant Instrumentation.
Press F7 or on the Tools menu, click Domain Explorer.

Tips
• Depending on the access rights that have been granted to you, the
Domain Explorer allows you to perform actions with SmartPlant
Instrumentation items that belong to all the existing <plants> in your
domain and not just with the items in the plant that you have currently
logged in.
• You can expand the hierarchy of any <unit> and view the item
structure. However, specification, process data, or calculation sheets
are only accessible from the <unit> you have logged on to. Process
data, specification, and calculation sheets of items belonging to
<units> that you are not logged to are not accessible even for viewing.

SmartPlant Instrumentation User’s Guide 207

Working with the Domain Explorer: An Overview

The tree view pane of the Domain Explorer shows instrumentation items organized
by folders. SmartPlant Instrumentation defines standard folders in the database. You
cannot move or delete these folders, nor can you add new folders. Each folder
contains a particular item type, and the options available on the menus depend on the
currently selected item type.

For a detailed explanation of all the folders and their organization in the Domain
Explorer, see The Organization of Items in the Domain Explorer Tree View, page
212.

Item status indicators — the software uses various icons beside a folder or item to
indicate the status of a folder or an item , for example access denied, view only, an
item that belongs to As-Built, and so forth. For the full list of the item indicators,
see Item Status Indicators in the Domain Explorer, page 229.

Notes
• You can open several instances of the Domain Explorer by pressing
F7.
• After exiting SmartPlant Instrumentation, and starting a new session,
the software retains the size and position of all the windows that were
open in the previous session.
• Some SmartPlant Instrumentation modules have their own Explorers.
These are just limited views of the Domain Explorer and they contain
items specific to their modules. For details, see SmartPlant
Instrumentation Explorer: An Overview, page 206.
Related Topics
• Association Rules in the Domain Explorer, page 225
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

208 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Domain Explorer Common Tasks

The following tasks are used frequently when you work with the Domain Explorer.

Create an Item in the Domain Explorer

This procedure shows how to create an item in the Domain Explorer. For more
information, see Create an Item in the Domain Explorer, page 230.

Edit Item Properties

This procedure explains how to edit the properties of an item that you select in the
Domain Explorer. For more information, see Edit Item Properties, page 231.

Duplicate an Item
You use this action to create a duplicate item within the same parent hierarchy. That
is, the software creates another copy of the selected item under the immediate parent
item. For example, if you need to insert an apparatus within an existing apparatus
group, expand an apparatus group and duplicate an apparatus. You can then change
the sequence numbers of the apparatuses to re-arrange them on the strip the way you
require. Furthermore, if you are duplicating a panel or another item that contains
child items, the software duplicates this item in its entirety. That is, SmartPlant
Instrumentation creates the new item with exactly the same child items as the original
panel. Note that in this case, the software also retains all the existing internal
connections if you selected Copy internal connections in the wiring preferences.
For more information, see Duplicate an Item, page 230.

Move an Item in the Domain Explorer

This feature allows you move an item from one parent item to another within the
Domain Explorer. This can be very helpful when, for example, you want to move a
terminal strip to another panel. If you are moving an item that contains child items,
the software moves the selected item together with all its child item.

Note that the same rules apply when you want to move an item in the Reference
Explorer. If you drag an item from the Reference Explorer to the Domain
Explorer or vice versa, SmartPlant Instrumentation creates a copy of that item and
retains the selected one in its original place. If you open another instance of the
Domain Explorer and drag an item from one Domain Explorer window to another,
the same rules apply as when you drag an item within the same Domain Explorer
window.

For more information, see Move an Item in the Domain Explorer, page 231.

Delete Items
This procedure shows how to delete the items that you select in the Domain
Explorer. For more information, see Delete Items, page 231.

SmartPlant Instrumentation User’s Guide 209

Working with the Domain Explorer: An Overview

Search for Items in SmartPlant Instrumentation Explorer

You use this feature to find items that you want to work with. You can search for
multiple items in the entire domain, the current highest plant hierarchy level, or the
current lowest plant hierarchy level. The term "current" refers to the plant hierarchy
level that you selected in the Open dialog box when you started SmartPlant
Instrumentation. For more information about searching for items, see Search for
Items in SmartPlant Instrumentation Explorer, page 233.

Find an Item in the Tree View of an Explorer Window

This feature enables you to find an item in the Domain Explorer tree view. This
feature is especially useful when you want to find an item in a particular folder that
contains numerous items. You can type an item name and click Find or you can let
the software look for the item as you type the item name. The feature allows you to
set the search delay that determines how long the software waits after the last time
you press a key on your keyboard.

For more information, see Find an Item in the Tree View of an Explorer Window,
page 234.

Filter the Display of Items According to a Specific Item Type

This option allows you to filter the items according to a specific item type. You can
apply an item type filter to the entire tree view of the current view of the current
Explorer window or only to a particular folder or node that contains child items.
Item type filters override your item name filters.

Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.

Filter settings take effect only for the user who defined the filter and only for the
current custom view of the active Explorer window.

Note that item type filters override your item name filters.

For more information, see Filter the Display of Items According to a Specific Item
Type, page 236.

Filter the Display of Items According to a Specific Item Name

This option allows you to filter the items according to a specific item name. An item
name filter affects the entire tree view of the current view of the active Explorer
window and not just a particular folder or hierarchy node. You can also instruct the
software to override the item type filters if needed.

210 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.

You can define an item name filter only if you do one of the following:

• Without selecting anything in the Explorer window, click on the

toolbar.
• Right-click the root node in the Explorer tree view and then on the
shortcut menu, click Filter.
Note that filter settings take effect only for the user who defined the filter and only for
the current custom view of the active Explorer window. For more information, see
Filter the Display of Items According to a Specific Item Name, page 235.

Filter Cables in an Explorer Window

Allows you to set additional filter definitions for the Cables and the Cross Cables
folders. You can filter cables according to their connections and cables that are
connected to a specific Foundation Fieldbus or Profibus segment. For more
information, see Filter Cables in an Explorer Window, page 238.

Filter Loops in an Explorer Window

Allows you to set additional filter definitions for the Loops folder. You can filter
loops according to blocks associated with loop tags. For more information, see Filter
Loops in an Explorer Window, page 240.

Add Items to My List in the Items Pane

This procedure explains how to add various items to the My List view of the Items
pane. My List allows you to create a special view of the Items pane where you can
keep items that belong to various folders in the tree view. The software retains all the
items in the My List view until you remove them from that list. Exiting SmartPlant
Instrumentation and starting a new session does not affect the contents of My List.
For more information, see Add Items to My List in the Items Pane, page 242.

Display a Browser View in the Explorer Items Pane

This option allows you to display a browser view in the Items pane for an item type
or a folder that you select in the Domain Explorer tree view. This way, instead of
displaying child items, you can display item properties of the item you selected in the
tree view pane. The software displays the browser view according to the style
settings of the selected browser. You can print out the current browser view,
however, you cannot edit the item properties. For more information, see Display a
Browser View in the Explorer Items Pane, page 242.

SmartPlant Instrumentation User’s Guide 211

Working with the Domain Explorer: An Overview

Perform Various Actions with an Instrument

This feature allows you to select a tag number and perform various actions. You can
effect I/O assignment, associate blocks, create CS tags, create device panels and
cables, connect device panels, and so forth. For more information, see Perform
Various Actions with an Instrument, page 232.

Generate a Specification or a Process Data Sheet for an Instrument

This option allows you to select a tag number and generate a specification and a
process data sheet. For more information, see Generate a Specification or a Process
Data Sheet for an Instrument, page 232.

Define and Use a Custom View

SmartPlant Instrumentation allows you to define custom views for the Domain
Explorer and the Reference Explorer. The software lets you select a folder or
multiple folders and add these folders with their child items to a custom view that you
select. Note that the custom views that you define are not available to other users of
SmartPlant Instrumentation. For more information, see Define and Use a Custom
View, page 243.

For the rules that govern the dragging of items in the Domain Explorer, see
Association Rules in the Domain Explorer, page 225.

The Organization of Items in the Domain Explorer Tree View

The tree view pane of the Domain Explorer shows instrumentation items organized
by folders. SmartPlant Instrumentation defines standard folders in the database. You
cannot move or delete these folders, nor can you add new folders. Each folder
contains a particular item type, and the options available on the menus depend on the
currently selected item type.

After expanding a plant hierarchy, the following folders are displayed:

Loops
Loops are arranged at the lowest level of the plant hierarchy. You can navigate to a
loop by expanding the plant hierarchy. Continue expanding your plant hierarchy to
display the Loops folder that contains all the existing loops in the current <unit>.
Loops, in turn, can contain loop blocks used in CAD loop drawing generation,
instruments and control system tags. Instruments can contain instrument blocks used
in CAD loop drawing generation. For more information, see Items in the Loops
Folder, page 222.

212 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Instruments
Instrument tags are arranged at the lowest level of the plant hierarchy in the
Instruments folder. You can navigate to a tag number by expanding the plant
hierarchy. Continue expanding your plant hierarchy to display the Instruments
folder that contains all the existing tag numbers in the current <unit>. Instrument
tags can be parent items of CS tags, maintenance event record, specifications, process
data sheets, and any other documents that are associated with a selected instrument
tag.

Electrical Tags
This folder holds all the tag numbers that have either been published to SmartPlant
Instrumentation from SmartPlant Electrical or that you have created for the purpose
of representing electrical signals. You can associate these tags with items under the
Electrical Equipment folder and publish the items with these associations back to
SmartPlant Electrical.

Functional Requirement Tags

This folder holds all the existing functional requirement tag numbers. You can only
view the list of existing tags and open the tag number properties for editing.
However, you cannot create new tags by right-clicking this folder.

Wiring items are organized in the following folders:

Panels by Location
Panels are arranged according to their location and category. In this folder, panels are
arranged according to their location. You can perform the following actions:

• Create a new location based on the structure you define in the

Location Manager.
• Move a panel from one location to another by dragging it to another
location.
• Right-click a location and create a new panel and then create the
required child items.
• When right-clicking a location or a wiring item within a location, you
can perform various actions that are available on the shortcut menu.
You can create various wiring structures in the Panels by Location folder. For an
example of one possible wiring structure, see Panels by Location Hierarchy Example,
page 217.

SmartPlant Instrumentation User’s Guide 213

Working with the Domain Explorer: An Overview

Panels by Category
In this folder, panels are arranged according to their category. Panels, in turn, contain
their child items, for example terminal strips, racks, wiring equipment, and so forth.
There is a lot of flexibility in creating a panel hierarchy. There is no rigid structure
like "panel – strip – terminal" that limits your wiring design. You can create
various wiring structures, as you require. See Panels by Category Hierarchy
Examples, page 215 to examine a few possible structures.

Cables
This folder holds all the existing cables. You can create various child items under
cables. For an example, see Cable Hierarchy Example, page 218.

Cross Cables
This folder holds all the cross wiring cables and wires. You can create new cross
cables and cross wires as you require.

Lines, hook-ups, process equipment, P&IDs, and so forth are organized in separate
folders at the top hierarchy level of the tree view.:

Telecom Equipment
This folder holds all the available telecom equipment cabinets classified by their
categories: PA Cabinets, PABX Cabinets, Miscellaneous, Hubs, Amplifiers, and
Intercoms. Each folder displays the existing equipment cabinets belonging to that
category. You cannot create new cabinets in the Telecom Equipment folder. To
create a new equipment cabinet, expand the following hierarchy: Panels by Category
> Telecom Panels > Equipment Cabinets. Then, right-click the Equipment
Cabinets folder, point to New and click the command that you require.

Process Equipment
This folder displays all the existing equipment that your instruments are installed on.
Equipment is also categorized according to different types, such as compressors,
burners, pumps, and so on. You can right-click this folder and create new process
equipment. Then, you can create an instrument by right-clicking an equipment item.

Lines
This folder holds all the existing lines in your <plant>. After right-clicking a line,
you can add a new instrument.

Fieldbus Segments
This folder contains all the segments, their associated tag numbers and virtual tags
that exist in your fieldbus system. All fieldbus items are arranged in a tree-like
hierarchy that can be expanded and collapsed. For details, see Fieldbus Segments in
the Domain Explorer, page 218.

214 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Hook-Ups
This folder holds all the existing hook-up types, hook-ups, and their child items. For
details, see Items in the Hook-Ups Folder, page 220.

P&IDs
This folder displays all the existing P&ID document references. You can right-click a
P&ID document reference and create a new instrument, loop, and line.

Controllers
This folder displays all the existing controllers and their child items. You cannot
create new controllers in this folder, but you can select a slot and add a terminal strip,
an I/O card, or any other wiring equipment item.

Drawing Block Types

This folder holds all the existing CAD drawing block types and their blocks, which
you use when generating CAD loop drawings. In this folder, you create your blocks
but you do not make any associations. You can only associate blocks with loops or
instruments using the Loops folder actions of the Loop Drawings module options.
For details, see Items in the Drawing Block Types Folder, page 218.

Electrical Equipment
This folder holds all the items of electrical equipment that have been retrieved from
SmartPlant Electrical. In this folder, you can view the items and associate them with
electrical signals. For details, see Items in the Electrical Equipment Folder, page
220.

Test Equipment
This folder displays all the items of test equipment that have been created in
SmartPlant Instrumentation.

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Panels by Category Hierarchy Examples

The following examples show a number of different structures that you can create in
the Panels by Category folder.

SmartPlant Instrumentation User’s Guide 215

Working with the Domain Explorer: An Overview

Example 1:

Example 2:

Example 3:

Example 4:

216 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Example 5:

Related Topics
• Domain Explorer Common Tasks, page 209

Panels by Location Hierarchy Example

The following is an example of a panel by location hierarchy structure:

Related Topics
• Domain Explorer Common Tasks, page 209

SmartPlant Instrumentation User’s Guide 217

Working with the Domain Explorer: An Overview

Cable Hierarchy Example

Fieldbus Segments in the Domain Explorer

The Fieldbus Segments folder displays all the segments, their associated instrument
tags and virtual tag.

All fieldbus items are arranged in a tree-like hierarchy that can be expanded and
collapsed:

Icon Explanation
Foundation Fieldbus segment that contains all the associated instruments and
virtual tags
Profibus DP segment that contains all the associated instruments and virtual tags
Profibus PA segment that contains all the associated instruments and virtual tags
Fieldbus instrument associated with a segment
Function block associated with a fieldbus instrument
Virtual tag associated with a fieldbus instrument

Related Topics
• Domain Explorer Common Tasks, page 209

Items in the Drawing Block Types Folder

The Drawing Block Types folder of the Domain Explorer enables you to navigate
to a CAD drawing block types and a drawing block in a graphical way resembling the
Windows Explorer. The Drawing Block Types folder contains all of the blocks
defined in the current <plant>. You organize your block in block type folders. The
blocks that you define become available for association with instruments, loops, or
hook-ups but you do make any associations in the Drawing Block Types folder.
CAD drawing blocks appear in the Domain Explorer because it is only possible to
define blocks at the highest plant hierarchy level.

218 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

You can expand or collapse the levels to view the existing items. To perform an
action, right-click the Drawing Block Types folder, a specific block type or a block,
and then click a command. The software uses various icons beside a folder or item to
indicate the status of a folder or an item , for example a view-only item, a claimed
item , an item that belongs to As-Built, and so forth. For the full list of the item
indicators, see Item Status Indicators in the Domain Explorer, page 229. For a
detailed explanation of the tree view and Items panes, see Working with the Domain
Explorer: An Overview, page 207.

In the Drawing Block Types folder, the items appear in two levels, based on the
relationship among them.

Level 1
Drawing Block Types
This is the highest level in the Drawing Block Types folder hierarchy. At this level,
the software displays all the drawing block types that exist in the current domain and
allows you to add general and instrument block types and manage block type
properties.

The following drawing block types are available:

• Border and Logo (shown as ) — Shipped general block types that

allow you to create logo and border blocks for all loop drawings or
hook-up drawings. You cannot delete these block types.
• User-defined general block type (shown as ) — A block type that
allows you to create blocks you can use in all loop drawings in
addition to the border and logo blocks. You can create as many user-
defined general block types as you require by right-clicking the
Drawing Block Types folder and clicking New > General Block
Type. Blocks belonging to user-defined general block types cannot be
assigned to hook-up drawings.
• Loop Block (shown as ) — A shipped block type that allows you
to create blocks that you can associate with the loop numbers in the
Loops folder of the Domain Explorer. The Loop Block folder is the
only folder where you can create loop blocks. You can only associate
one loop block per loop. You cannot delete the Loop Block folder.
• Instrument block type (shown as ) — A user-defined block type
that allows you to create blocks that you can associate with the
instrument tag numbers in the Loops folder of the Domain Explorer.
You can create as many instrument block types as you require by
right-clicking the Drawing Block Types folder and clicking New >
Instrument Block Type.

SmartPlant Instrumentation User’s Guide 219

Working with the Domain Explorer: An Overview

Level 2
Drawing Blocks
CAD blocks appear under block types. Blocks do not contain child items. You can
add new blocks or delete blocks that are not in use.

The following block icons are available:

• — Indicates logo, border, or user-defined general blocks

• — Indicates loop blocks
• — Indicates instrument blocks

Items in the Electrical Equipment Folder

The Electrical Equipment folder of the Domain Explorer enables you to view items
of electrical equipment that have been retrieved from SmartPlant Electrical.

There are several sub-folders available for the following categories of electrical
equipment:

• PDBs— for Power Distribution Boards and their associated circuits.

• Main Equipment— for items such as motors, heaters, and control
stations that are associated with electrical equipment.
• Control Stations— for control stations without associations with
electrical equipment.
By expanding the electrical equipment items, you can view signal (electrical tag)
associations. If a particular piece of equipment does not have an associated signal,
you can make an association by dragging an electrical tag from the Electrical Tags
folder to the desired electrical equipment item.

Related Topics
o Domain Explorer Common Tasks, page 209
o SmartPlant Instrumentation Explorer: An Overview,
page 206

Items in the Hook-Ups Folder

The Hook-Ups folder of the Domain Explorer enables you to navigate to a hook-up
type, hook-up, hook-up item, or instrument in a graphical way resembling the
Windows Explorer. You can expand or collapse the levels to view the existing items.
The Hook-Ups folder shows you at a glance the graphical representation of the
relationships that exist among the hook-up types, hook-ups, and hook-up items,
instruments, and child items associated with instruments.

220 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

The Hook-Ups folder employs an expandable/collapsible hierarchy that allows you to

navigate to relevant items and select them for use. To perform an action, right-click a
folder or an item and then click a command. Note that the software uses various
icons beside a folder or item to indicate the status of a folder or an item , for example
a view-only item , a claimed item , an item that belongs to As-Built, and so forth. For
the full list of the item indicators, see Item Status Indicators in the Domain Explorer,
page 229. For a detailed explanation of the tree view and Items panes, see Working
with the Domain Explorer: An Overview, page 207.

The software arranges the items based on the relationship among them. The display
rules follow a rigid structure of the following four levels.

Level 1
Hook-Up Types and Hook-Ups
This is the highest level in the Hook-Ups folder hierarchy. At this level, the software
displays both all the hook-ups types and hook-ups that exist in the current domain.
Hook-up types are shown as and hook-ups as .
Hook-up types contain hook-ups for instruments sharing similar features, for
example, Control, Measure, Flow, and so forth. For each hook-up type, on the
shortcut menu, you can click New to add hook-ups. At this level, you can only create
one hook-up at a time. Also, you can move hook-ups from one hook-up type to
another, assign instrument tags and hook-up items. To assign tag numbers, on the
shortcut menu, click Actions > Associate Tag Numbers with Hook-Ups. To assign
hook-up items, on the shortcut menu, click Actions > Associate Items with Hook-
Ups. Also, at this level, you can generate various hook-up reports, a Bill of Material,
and hook-up drawings.

Level 2
Hook-Ups
Hook-ups (shown as ) appear under hook-up types. At this level, you can create
hook-ups in batch mode by duplicating existing hook-ups you select in the Items
pane. You can move hook-ups from one hook-up type to another, assign instrument
tags and hook-up items. To assign tag numbers, on the shortcut menu, click Actions
> Associate Tag Numbers with Hook-Ups. To assign hook-up items, on the
shortcut menu, click Actions > Associate Items with Hook-Ups. Also, at this level,
you can generate various hook-up reports, a Bill of Material, and hook-up drawings.

Level 3
Hook-Up Items
Hook-up items (shown as ) appear under hook-ups. Hook-up items do not contain
child items. To assign hook-up items to hook-ups, use a shortcut menu command
available at the level of hook-ups or hook-up types. You cannot create or delete
hook-up items in the Domain Explorer. Hook-up item management options are only
available in the Hook-Up Item Libraries folder of the Reference Explorer.

SmartPlant Instrumentation User’s Guide 221

Working with the Domain Explorer: An Overview

Instruments
Instruments (shown as ) appear under hook-ups. Instruments can contain
document assigned to instrument specs, process data, or calculation sheets. Also,
instruments can contain control system tags. You create documents and control
system tags in the appropriate modules of SmartPlant Instrumentation. To assign
instrument tag numbers to hook-ups, use the shortcut menu command available at the
first or second level of the folder hierarchy.

Level 4
Control System Tag
Control system tags (shown as ) appear under instruments at the lowest level of the
Hook-Ups folder hierarchy. It is possible to assign control system tags to instruments
when performing I/O assignment.

Documents
Documents (shown as ) appear under instruments at the lowest level of the folder
hierarchy. You define documents when creating specs, process data sheets, or
calculation sheets. You can modify or delete document data in the module pertaining
to the document displayed. For example, if you delete an instrument specification
from the Specifications module, the software automatically removes the document
from the Hook-Ups folder. Use the shortcut menu command to open documents.
The software opens the document in the module in which the document was created.

Instrument Blocks
Instrument blocks are represented by icons and . In the Hook-Ups folder,
instrument block options are not in use because they are only used in a CAD loop
drawing generation. You manage instrument blocks in the Loops folder.

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Items in the Loops Folder

The Loops folder of the Domain Explorer enables you to navigate to a loop number,
tag number, or CAD block in a graphical way resembling the Windows Explorer.
You can expand or collapse the levels to view the existing loop numbers, tag
numbers, and CAD blocks. The Loops folder shows you at a glance the graphical
representation of the relationships that exist among the loops, instruments, and
blocks.

To perform an action, right-click the Loops folder or an item and then click a
command. Note that the software uses various icons beside a folder or item to

222 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

indicate the status of a folder or an item , for example a view-only item , a claimed
item , an item that belongs to As-Built, and so forth. For the full list of the item
indicators, see Item Status Indicators in the Domain Explorer, page 229. For a
detailed explanation of the tree view and Items panes, see Working with the Domain
Explorer: An Overview, page 207.

The software arranges the items in three levels based on the relationship among them.

Level 1
Loops
This is the highest level in the Loops folder. This hierarchy level contains all the
loop numbers existing at the current highest plant hierarchy level. Loops are
indicated with the icon.
Loops contain tag numbers, which in turn contain blocks. For each loop, on the
shortcut menu, you can click New to add instruments. Also, you can assign
documents to loops. These documents are associated with drawings that you generate
for the loop. Loops can display annotations which refer to the generation method you
assigned for that loop, for example, C indicates a CAD method, M indicates a manual
method (intended for generation without using SmartPlant Instrumentation options).

Level 2
Instruments
The second hierarchy level contains all the instrument tag numbers that are associated
with the existing loops. Instruments are shown as .
If you use a CAD application to generate loop drawings, under instrument tags, you
can add instrument blocks using the following block assignment methods:

Block-tag assignment — Allows you to assign a block to a tag number manually,

using the shortcut menu command Associate Blocks with Tag Numbers.

Block-instrument type assignment — Allows you to assign a block to the instrument

type, and, thus, assign this block to all the tag numbers that belong to this instrument
type. To perform this operation, on the Actions menu of the Loop Drawings
Module window, click Block-Instrument Type Assignment.

Loop Blocks
If you use a CAD application to generate loop drawings, at the second level of the
Loops folder hierarchy, you can assign CAD drawing blocks to the loop. Loop
blocks are indicated with the icon.
In the Domain Explorer, you create and manage loop blocks in the Drawing Block
Types > Loop Block folder.

Documents
The second hierarchy level contains all the documents that are associated with the
loop drawings you generated. Documents are indicated with the icon.

SmartPlant Instrumentation User’s Guide 223

Working with the Domain Explorer: An Overview

The software assigns a document number to a loop on loop creation. However, in the
Loops folder, the software only displays a document number after generating a
drawing for a loop. You can view and modify document numbers using options of
the Loop Drawing List dialog box, which you can open using a shortcut menu
command.

Level 3
Instrument Blocks
Instrument blocks, which are used in a CAD loop drawing generation, are the lowest
level in the Loops folder hierarchy. The displayed blocks are those blocks that you
associated with the instrument tag numbers according to the method of association.
The block icons that the software displays depend on the block assignment method:

• — Indicates blocks associated with instrument tags

manually. At the instrument level, on the shortcut menu, click
Actions > Associate Blocks with Tag Numbers.
• — Indicates blocks associated with a specific instrument
type to which the instruments belong. On the Actions menu of
the Loop Drawings Module window, click Block -
Instrument Type Assignment.
You create and manage instrument blocks in the Drawing Block Types folder of the
Domain Explorer, where the instrument blocks are indicated with the icon.

Control System Tags

Control system tags appear at the lowest level of the Loops folder hierarchy, under
instruments. You manage control system tags in the I/O Assignment window. In the
Loops folder, you can only update the control system tag properties. Control system
tags are shown as .

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

224 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Association Rules in the Domain Explorer

You can move and create associations among items by dragging them from one
parent item to another in the Domain Explorer. The following table summarizes the
rules that govern these associations.

Source Item in Target Folder or Result Pre-

the Domain Item in the conditions
Explorer Domain Explorer
Loop The Loops folder The software moves the loop
in another to the target <unit>.
&lt;unit&gt;
Loop P&ID drawing The software associates the
loop with the target P&ID
drawing.
Instrument The Instruments The software moves the
folder in another instrument to the target
&lt;unit&gt; <unit>.
Instrument Loop The software associates the
instrument with the target
loop.
Instrument Line The software associates the
instrument with the target
line.
Instrument Process equipment The software associates the
instrument with the target
process equipment.
Instrument P&ID drawing The software associates the
instrument with the target
P&ID drawing.
Functional The Loops folder The software moves the
requirement tag in another functional requirement tag to
&lt;unit&gt; the target <unit>.
Location Location The software moves the
location to the target location
in the Panels by Location
folder (in accordance with the
location level structure
defined by the Domain
Administrator).
Panel (all panel Location The software associates the
categories) panel with the target location.

SmartPlant Instrumentation User’s Guide 225

Working with the Domain Explorer: An Overview

Source Item in Target Folder or Result Pre-

the Domain Item in the conditions
Explorer Domain Explorer
Device panel Panel (apart from The software moves the
device panel and device panel to the target
plug-and-socket panel.
junction box)
Plug-and-Socket Panel (apart from The software moves the plug-
junction box device panel and and-socket junction box to the
plug-and-socket target panel.
junction box)
Rack Panel (apart from The software moves the rack
device panel and to the target panel.
plug-and-socket
junction box)
Wiring Panel (apart from The software moves the See Note 1.
equipment item device panel and wiring equipment item to the
(for example: I/O plug-and-socket target panel.
card, fieldbus junction box)
brick, and so
forth)
Wiring Rack The software moves the See Note 1.
equipment item wiring equipment item to the
(for example: I/O target rack.
card, fieldbus
brick, and so
forth)
Wiring Terminal strip The software moves the See Note 1.
equipment item wiring equipment item to the
(for example: I/O target terminal strip.
card, fieldbus
brick, and so
forth)
Wiring Slot The software moves the loop See Note 1.
equipment item to the target slot.
(for example: I/O
card, fieldbus
brick, and so
forth)
Connector Panel (apart from The software moves the See Notes 2
device panel and connector to the target panel. and 3.
plug-and-socket
junction box)

226 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Source Item in Target Folder or Result Pre-

the Domain Item in the conditions
Explorer Domain Explorer
Connector Rack The software moves the See Notes 2
connector to the target rack. and 3.
Connector Wiring equipment The software moves the See Notes 2
item connector to the target wiring and 3.
equipment item .
Connector Slot The software moves the See Notes 2
connector to the target slot. and 3.
Connector Cable The software moves the See Notes 2
connector to the target cable. and 3.
Terminal strip Panel (apart from The software moves the See Note 4.
device panel and terminal strip to the target
plug-and-socket panel.
junction box)
Terminal strip Rack The software moves the See Note 4.
terminal strip to the target
rack.
Terminal strip Wiring equipment The software moves the See Note 4.
item (e.g., I/O terminal strip to the target
card, fieldbus wiring equipment item.
brick, etc.)
Terminal strip Slot The software moves the See Note 4.
terminal strip to the target
slot.
Terminal Terminal strip The software moves the
terminal to the target terminal
strip.
Terminal Channel The software moves the
terminal to the target channel.
Channel Wiring equipment The software moves the
item (for example: channel to the target wiring
I/O card, fieldbus equipment item.
brick, and so
forth)
Channel Terminal strip The software moves the
channel to the target wiring
terminal strip.
Cable set Cable The software moves the cable
set to the target cable.

SmartPlant Instrumentation User’s Guide 227

Working with the Domain Explorer: An Overview

Source Item in Target Folder or Result Pre-

the Domain Item in the conditions
Explorer Domain Explorer
Cable set Cross cable The software moves the cable
set to the target cross cable.
Wire Cable set The software moves the wire Connected
to the target cable set. wires cannot
be moved.
Line P&ID drawing The software associates the
line with the target P&ID
drawing.
Hook-Up Hook-up type The software associates the
hook-up with the target hook-
up type.

Notes
1. I/O cards cannot be moved if they function as primary or secondary I/O cards.
2. Wiring equipment connectors cannot be moved to cables.
3. Cable connectors can only be moved to other cables. This is possible only if none
of the connector pins are associated with wires.
4. Terminal strips cannot be moved if:
• They are used in instrument type profile definition.
• They are associated with Auto-Wiring tasks.
• They are associated with CS tags.
• They are associated with general or local signals.
Special Conditions
• The software does not allow you to drag items to incompatible
hierarchies. For example, you cannot drag a rack to device
panel or a plug-and-socket junction box.
• The software does not allow you to move an item that contains
a child item that cannot be moved. For example, you cannot
move a rack if it contains an I/O card that functions as a
primary or secondary I/O card for an I/O termination.
• In an owner operator domain, you cannot move items that have
not been claimed for the current project.
Related Topics
• Domain Explorer Common Tasks, page 209

228 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Item Status Indicators in the Domain Explorer

The software uses a number of icons to indicate the status of various folders and
items in your domain. The icons appear beside the folders and items in the tree view
of the Domain Explorer.

Icon Description
An item that belongs to the current project.
An item that belongs to As-Built. When working in a project with As-Built
items displayed, As-Built items are view-only. In the Domain Explorer, you
can select an As-Built item and display its properties.
A dummy item.
An item that does not belong to the current project or As-Built. Also, an item
that belongs to As-Built and all the projects, for a example, a hook-up type.
An item that cannot be deleted, duplicated, and under which no child items can
be created. However, you can edit the item properties and move the item to
another hierarchy level.
Access denied.
View-only. The item is marked as view-only if it has not been created using the
Domain Explorer. You cannot delete such an item or manage the item
properties using the Domain Explorer options. For example, a document, such
as a specification is always marked as view-only. However, you can open the
spec print preview and make changes as you require.
An item that cannot be deleted, duplicated, moved to another hierarchy level,
and under which no child items can be created. However, you can edit the item
properties.
An As-Built item that has been claimed for a project.
Indicates that a folder or parent hierarchy item has been filtered according to an
item type.
Indicates that a folder or parent hierarchy item has been filtered according to an
item type name.

Notes
• An item without any indicator denotes an item that is not
supported by the Domain Explorer. The software allows you
to perform actions with such items only from the pertinent
SmartPlant Instrumentation modules.
• The software does not use item indicators in the Reference
Explorer.

SmartPlant Instrumentation User’s Guide 229

Working with the Domain Explorer: An Overview

Create an Item in the Domain Explorer

1. Press F7 to open the Domain Explorer.
2. In the tree view pane, expand the plant hierarchy to display the folder in which
you need to create the new item .
3. Right-click the folder in which you need to create the new item .
4. On the shortcut menu, point to New and then click the command that you require.
Note
• When you create an item in the domain explorer, make sure you set the
naming convention for it in the Administration module. For details see
Naming Conventions: An Overview in the Administration User's
Guide, under Domain Administration.
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Duplicate an Item
1. Do one of the following
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer.
2. In the tree view pane, expand the plant hierarchy.
3. Do one of the following:
• In the tree view pane, select an item.
• In the Items pane, select one or more items.
4. Right-click the selected items and then on the shortcut menu, click Duplicate.
5. Modify the properties as you require. For help with individual properties, click
the Help button on the dialog box.
Note
• When you duplicate an item in the domain explorer, the duplicate item
inherits the naming conventions from the original item. Make sure you set
the naming convention for an item you wish to duplicate. For details see
Naming Conventions: An Overview in the Administration User's Guide,
under Domain Administration.

230 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Move an Item in the Domain Explorer

1. Press F7 to open the Domain Explorer.
2. In the tree view pane, expand a hierarchy to display the item that you want to
move.
3. Drag your selection to the required destination in the Domain Explorer.

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Edit Item Properties

1. Do one of the following:
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer.
2. In the tree view pane, expand the plant hierarchy.
3. Do one of the following:
• In the tree view pane, select an item .
• In the Items pane, select one or more items.
4. Right-click the selected items and then on the shortcut menu, click Properties.
5. Modify the properties as you require. For help with individual properties, click
the Help button on the dialog box.

Related Topics
• Domain Explorer Common Tasks, page 209
• Reference Explorer Common Tasks, page 245
• SmartPlant Instrumentation Explorer: An Overview, page 206

Delete Items
1. Press F7 to open the Domain Explorer or F8 to open the Reference Explorer.
2. In the tree view pane, expand the plant hierarchy.
3. Do one of the following:
• In the tree view pane, select an item .
• In the Items pane, select one or more items.
4. Right-click the selected items and then on the shortcut menu, click Delete.

SmartPlant Instrumentation User’s Guide 231

Working with the Domain Explorer: An Overview

Perform Various Actions with an Instrument

1. Press F7 to open the Domain Explorer.
2. In the tree view pane, expand the plant hierarchy to display the Instruments
folder.
3. Expand the Instruments folder and then right-click a tag number.
4. On the shortcut menu, point to Actions and then click the command that you
require.

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Generate a Report for an Instrument

1. Press F7 to open the Domain Explorer.
2. In the tree view pane, expand the plant hierarchy to display the Instruments
folder.
3. Expand the Instruments folder and then right-click a tag number.
4. On the shortcut menu, point to Reports and then click the command that you
require.

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Generate a Specification or a Process Data Sheet for an

Instrument
1. Press F7 to open the Domain Explorer.
2. In the tree view pane, expand the plant hierarchy to display the Instruments
folder.
3. Expand the Instruments folder and then right-click a tag number.
4. On the shortcut menu, point to Actions and then click the command that you
require.

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

232 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Copy a Reference Item to the Domain Explorer

1. Press F7 and then F8 to open the Domain Explorer and the Reference Explorer.
2. In the Reference Explorer, expand a hierarchy level and select a reference item.
3. Drag your selection to a destination level in the Domain Explorer. Place both
Explorer windows side by side on your screen and then drag the required items
from one Explorer to the other.
4. In the appropriate properties dialog box, (depending on the reference item that
you are copying), modify the properties of the new item as you require.

Related Topics
• Reference Explorer Common Tasks, page 245
• SmartPlant Instrumentation Explorer: An Overview, page 206

Search for Items in SmartPlant Instrumentation Explorer

1. Do one of the following
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer.

2. On the toolbar, click to open the Search dialog box.

3. Select an item type. Note that the Item type list is a required field and without
selecting an item type, the software cannot proceed with the search.
4. Under Item name, type a name of an item that you want to find.
Tip
• You can use wildcard characters (* or %) to find items whose names
contain part of the text that you type. If you do not know the item
name, leave the asterisk * in this field.
5. Under Search in, select a plant hierarchy level on which the software searches for
items:
• Entire domain — the current domain that you selected in the
Open dialog box when you started SmartPlant Instrumentation.
• Current highest plant hierarchy level — the highest plant
hierarchy level that you selected in the Open dialog box, for
example, your current plant.
• Current lowest plant hierarchy level — the lowest plant
hierarchy level that you selected in the Open dialog box, for
example, your current unit.

SmartPlant Instrumentation User’s Guide 233

Working with the Domain Explorer: An Overview

6. In the Item properties data window, if needed, specify item properties so that the
software looks for items with those properties only. Click Add to append a new
row if you want to specify more than one property.
• Property— select an existing property from the list.
• Operator — select an operator from the list to determine how
the selected property will relate to the expression you type in
the Value field.
• Value— type an appropriate value to determine how the
selected property will be specified.
• Logic— select a logic operator (AND or OR) to determine
how the next expression will relate to the current one. Leave
this field empty if this is the last expression you are defining.
7. Click Search Now.
8. In the Results data window, select the items that you want to work with and click
Add to My List.
Notes
• After the software finds the items that you were looking for and
lists them in the Results data window, you can search for more
items without losing your current results. Select another item type
and click Search Now. The software adds the newly found items
to the previously found results.
• To start a new search and clear the Search results data window.
Related Topics
• Domain Explorer Common Tasks, page 209
• Reference Explorer Common Tasks, page 245
• SmartPlant Instrumentation Explorer: An Overview, page 206

Find an Item in the Tree View of an Explorer Window

1. Do one of the following:
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer.
2. In the tree view pane, expand the tree view hierarchy and navigate to a folder.
3. Right-click the folder that you require and then on the shortcut menu, click Find
Item .
4. On the Find Item dialog box, select Match case if you want the software to find
items whose names match the capitalization of the item name you entered.

234 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

5. Select Find whole name only if you want the software to search for occurrences
that are whole names and not part of a larger item name.
6. Do one of the following:
• Under Item , type a name and click Find.
• Select As typed and then under Item type a name. The software
looks for the item as you type. You can set the search delay to
determine how long the software will wait after the last time you
press a key on your keyboard.
7. Click Close.

Related Topics
• Domain Explorer Common Tasks, page 209
• Search for Items in SmartPlant Instrumentation Explorer, page 233
• SmartPlant Instrumentation Explorer: An Overview, page 206

Filter the Display of Items According to a Specific Item

Name
1. In an Explorer window, do one of the following:

• Without selecting anything in the Explorer window, click on

the toolbar.
• Right-click the root node in the Explorer tree view and then on the
shortcut menu, click Filter.
2. On the Filter Definition dialog box, type a filter name as you require.
3. On the Item Name tab, under Item name, type a valid name or part of a name.
You can use wildcard characters to specify partial strings: asterisk (*) or percent
(%) for multiple characters and underscore (_) for single characters.
4. Select the Override all item type filters check box if you want this item name
filter the software to override all existing item type filters. Normally, item name
filters do not take effect if an item type filter exists.
5. To filter the data of the current lowest plant group, select the Current lowest
plant hierarchy level check box.
6. To limit the display of items to only those that were created by the current user,
select the Show items created by the current user only check box.
7. Click OK.
Notes
• To clear the filter, on the Filter Definition dialog box, delete the
filter definition.

SmartPlant Instrumentation User’s Guide 235

Working with the Domain Explorer: An Overview

• Filter settings take effect only for the user who defined the filter
and only for the current custom view of the active Explorer
window.
• Item type filters override your item name filters.

Filter the Display of Items According to a Specific Item Type

1. In an Explorer window, do one of the following:
o To filter the entire tree view, select a hierarchy node whose
immediate child items are folders and not plant items. Then click
on the toolbar.
o To filter a particular folder or a hierarchy node, select a hierarchy
node or a folder containing the items that you want to filter and
then click .
Alternatively, you can right-click a folder or a hierarchy node and
then on the shortcut menu, click Filter.
2. On the Filter Definition dialog box, type a filter name as you require.
3. On the Item Type tab, from the Item type list, select an item type appropriate to
the folder or parent node that you selected in the tree view.
4. Select one of the following options:
o If, in the Explorer tree view, you selected a hierarchy node
whose immediate child items are folders and not plant items,
click the All the tree view option button.
o If you selected a particular folder or hierarchy node, click the
Selected folder or parent item option button.
5. From the Item type list, select an item type according to which you want to set
the filter.
Tip
o If, in the Explorer tree view, you select a hierarchy node whose
immediate child items are folders and not plant items, the Item type
list contains all the item types of the child items that belong to the
selected folders.
6. In the Filter definition group box, define the criteria that you use to filter the
items displayed:
Property— select a property to use for filtering the items.
Operator — select the required comparison operator to
determine how the header selected under Property will
relate to the expression you select for Value.

236 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Value — select or type a required value for the item you

selected under Property. The available values depend on
the specific property that you select.
Logic — You use this option when you specify more than
one filter condition. The option allows you to select the
required logical operator (And or Or) to determine how the
next filter expression will relate to the current expression.
When you have a mixture of logical operators for several
conditions, the software performs the expressions on the
conditions in order, for example:
(A and B) or C
(A or B) and C
7. Click Add if you want to add another item type property to the filter definition.
8. Click Verify to check the validity of the current filtering condition.
9. To filter the data of the current lowest plant group, select the Current lowest
plant hierarchy level check box.
10. To limit the display of items to only those that were created by the current user,
select the Show items created by the current user only check box.
11. Click OK.
Notes
Clicking Advanced allows you to define an additional filter for the
Cables, Cross Cables, and Loops folders. For details, see Filter Cables
in an Explorer Window, page 238 and Filter Loops in an Explorer
Window, page 240.
To reset the filter, click Reset.
To clear the filter, right-click a hierarchy node and then on the shortcut
menu, click Clear Filter.
When filtering the entire domain or setting a filter without selecting a
specific node or folder, the Clear Filter command is not available. In this
case, to clear the filter, open the Filter Definition dialog box and delete
the filter definition.
Filter settings take effect only for the user who defined the filter and only
for the current custom view of the active Explorer window.
Item type filters override your item name filters.
Related Topics
Domain Explorer Common Tasks, page 209
Filter Cables in an Explorer Window, page 238
Filter Loops in an Explorer Window, page 240

SmartPlant Instrumentation User’s Guide 237

Working with the Domain Explorer: An Overview

Filter Cables in an Explorer Window

1. In an Explorer window, select the Cables or the Cross Cables folder and do one
of the following:
Right-click the folder, and then click Filter.
On the Explorer window toolbar, click .
2. On the Filter Definition (Cables) dialog box, type a filter name.
3. Click Advanced.
4. On the Advanced Filter Definition (Cables) dialog box, do one of the following:
Select the Look for connections check box to include and select
connection criteria in the filter condition.
Clear the Look for connections check box if you do not want to
include any of the connection criteria in the filter condition. Selecting
this option disables the check boxes in this group box and in the
Connected to group box.
5. To select a connection criterion, in the Connection group box, click the
following:
No connections on either end— Filters for cables that are not
connected to anything on either wire end.
At least one wire connected on one end only— Filters for cables
that contain at least one wire that is only connected on one of its ends.
At least one wire connected on both ends— Filters for cables that
contain at least one wire that is connected on both wire ends.
6. In the Connected to group box, select one or more check boxes to define a filter
according to the type of panel that is connected to the cable. This selection
defines connection criteria for cables that have at least one wire connected to one
or both ends.
Junction boxes— Filter for all the cables that are connected to
junction boxes.
Marshaling racks— Filter for all the cables that are connected to
marshaling racks.
Cabinets— Filter for all the cables that are connected to cabinets.
Device panels— Filter for all the cables that are connected to device
panels.
DCS panels— Filter for all the cables that are connected to DCS
panels.
PLC panels— Filter for all the cables that are connected to DCS
panels.

238 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

7. In the Cable associations group box, select an appropriate Foundation Fieldbus

or Profibus segment if you want to filter for cables that are associated with a
specific fieldbus segment.
8. Select the Display telecom cables check box only if you want to filter the Cables
folder so that it displays telecom cables only.
9. Select the Cables without sets check box to filter for cables that were created
without sets and wires. This feature is useful when creating a cable block
diagram.
10. Click OK in the Advanced Filter Definition (Cables) dialog box.
11. Click OK in the Filter Definition dialog box.

Related Topics
Define a Filter for Pre-Assigned Device Cables, page 239
Domain Explorer Common Tasks, page 209
Filter Loops in an Explorer Window, page 240
Filter the Display of Items According to a Specific Item Name, page 235
Filter the Display of Items According to a Specific Item Type, page 236
SmartPlant Instrumentation Explorer: An Overview, page 206

Define a Filter for Pre-Assigned Device Cables

1. In the Domain Explorer, click .
2. On the Filter Definition (Cables) dialog box, click Advanced.
3. On the Advanced Filter Definition (Cables) dialog box, select the Display pre-
assigned device cables only check box.
4. Select the junction box that you require from the list below.

Related Topics
Domain Explorer Common Tasks, page 209
Filter Cables in an Explorer Window, page 238
Filter the Display of Items According to a Specific Item Name, page 235
Filter the Display of Items According to a Specific Item Type, page 236
SmartPlant Instrumentation Explorer: An Overview, page 206

SmartPlant Instrumentation User’s Guide 239

Working with the Domain Explorer: An Overview

Filter Loops in an Explorer Window

1. In an Explorer window, select the Loops folder and do one of the following:
Right-click the folder, and then click Filter.
On the Explorer window toolbar, click .
2. To filter according to an item name in the Loops folder, under Item name, type a
valid name or part of a name. You can use wildcard characters to specify partial
strings: asterisk (*) or percent (%) for multiple characters and underscore (_) for
single characters.
Tip
The value that you enter in this box overrides all other filter criteria
in this dialog box.
3. Type a filter name.
4. Do one of the following:
Select Selected node definition to filter the child items that belong
to a folder or the items at any hierarchy level that you selected in
the Explorer tree view.
Select Global definition to define a filter for the entire tree view
of the active Explorer. The software applies this definition to the
item type you selected. If you defined a filter definition for a
specific folder, the filter for the folder overrides the settings for the
global filter definition.
5. In the Filter definition group box, define the criteria that you use to filter the
items displayed:
Property— select a property to use for filtering the items.
Operator — select the required comparison operator to
determine how the header selected under Property will relate to
the expression you select for Value.
Value — select or type a required value for the item you selected
under Property. The available values depend on the specific
property that you select.
Logic — You use this option when you specify more than one
filter condition. The option allows you to select the required
logical operator (And or Or) to determine how the next filter
expression will relate to the current expression. When you have a
mixture of logical operators for several conditions, the software
performs the expressions on the conditions in order, for example:
(A and B) or C
(A or B) and C

240 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

6. Click Verify to check the validity of the current filtering condition.

7. Click Advanced to define a filter for loops according to loop blocks.
8. In the dialog box that opens, if needed, under Display level for blocks, click one
of the following to filter the blocks displayed in the data windows:
Highest plant hierarchy level— Displays blocks on the highest level
of the plant hierarchy defined by the Domain Administrator. The
default level is Plant.
Lowest plant hierarchy level— Displays blocks on the lowest level
of the plant hierarchy defined by the Domain Administrator. The
default level is Unit.
9. To filter the loops according to blocks, do one of the following:
Under Blocks associated with tags, select one or more blocks that are
associated with loop tags. After you select these blocks, in the current
explorer window, the software only displays loops whose blocks are
assigned to tags using the block-tag assignment method.
Under Blocks associated with instrument type, select one or more
blocks that are associated with the instrument type of the loop tags.
After you select these blocks, in the current explorer window, the
software only displays loops whose blocks are assigned to tags using
the block-instrument type assignment method.
Tip
In the Loops folder, blocks associated with tags using the manual
block assignment method are marked with the icon . Blocks
associated with tags using the automatic block assignment method are
marked with the icon .
10. Click OK in the Advanced Filter Definition (Loops) dialog box.
11. Click OK in the Filter Definition dialog box.

Related Topics
Domain Explorer Common Tasks, page 209
Filter Cables in an Explorer Window, page 238
Filter the Display of Items According to a Specific Item Name, page
235
Filter the Display of Items According to a Specific Item Type, page
236
SmartPlant Instrumentation Explorer: An Overview, page 206

SmartPlant Instrumentation User’s Guide 241

Working with the Domain Explorer: An Overview

Display a Browser View in the Explorer Items Pane

1. Do one of the following
In the tree view pane of the Domain Explorer, expand the plant
hierarchy and then select a folder or an item .
In the tree view pane of the Reference Explorer, select a folder or an
item .
2. Right-click the selected folder or item and then on the shortcut menu, click Show
Browser.
3. From the Browser view list, select a Browser view that exists in the Browser
module.
Important
If there are no Browser views on this list or if the browser view you
need is not on the list, close the Show Browser dialog box and switch
to the Browser module. In the Browser Manager, open the style
settings of the browser view that you need. Select the Enable in
explorer windows check box and then click Save. Open the Show
Browser dialog box again and select the browser view that you need.
Related Topics
Domain Explorer Common Tasks, page 209
Reference Explorer Common Tasks, page 245
SmartPlant Instrumentation Explorer: An Overview, page 206

Add Items to My List in the Items Pane

Press F7 to open the Domain Explorer and do one of the following:
In the Domain Explorer tree view, right-click an item and then on the
shortcut menu, click Add to My List.
In the Items pane, click My List and then drag an item from the tree view
to My List.
Notes
To remove an item from My List, right-click it and then click Remove
from My List.
To clear the My List view of all the items, right-click an item and then
click Remove All.

242 SmartPlant Instrumentation User’s Guide

 Working with the Domain Explorer: An Overview

Define and Use a Custom View

1. Press F7 to open the Domain Explorer or F8 to open the Reference Explorer.
2. Click above the toolbar.
3. On the Custom View Properties dialog box, click New.
4. Type a custom view name and then click OK.
5. Do one of the following:
Right-click a single folder in the tree view pane.
Right-click multiple folders in the Items pane.
6. On the shortcut menu, click Add to Custom View and then click the command
for the appropriate custom view.
Note
To remove a folder from a custom view, right-click a folder and then on
the shortcut menu, click Remove from Custom View.
Related Topics
Domain Explorer Common Tasks, page 209
SmartPlant Instrumentation Explorer: An Overview, page 206

SmartPlant Instrumentation User’s Guide 243

Working with the Reference Explorer: An Overview

Working with the Reference Explorer: An

Overview
The Reference Explorer allows you to create and manage all the available wiring
reference items that are created by SmartPlant Instrumentation users and that are
provided with the software. Note that wiring reference items are typical
configurations that facilitate rapid creation of various wiring items in your domain.

The Reference Explorer displays a graphical representation of the relationships that

exist among the predefined wiring equipment, panels, terminal strips, and terminals as
well as cables, cable sets, and wires. Also, you can manage hook-up libraries and
hook-up items.

You can use predefined configurations as reference items and copy them to the
Domain Explorer. For more information about using reference wiring items, see
Copy a Reference Item to the Domain Explorer, page 233.

You can open the Reference Explorer from anywhere in SmartPlant

Instrumentation. Press F8 or on the Tools menu, click Reference Explorer.

The tree view pane of the Reference Explorer shows reference items organized by
folders. SmartPlant Instrumentation defines standard folders in the database. You
cannot move or delete these folders, nor can you add new folders. Each folder
contains a particular item type, and the options available on the shortcut menus
depend on the currently selected item type.

Item status indicators — the software uses various icons beside a folder or item to
indicate the status of a folder or an item, for example access denied, view only, an
item that belongs to As-Built, and so forth. For the full list of the item indicators,
see Item Status Indicators in the Domain Explorer, page 229.

Notes
You can create several instances of the Reference Explorer by pressing
F8.
After exiting SmartPlant Instrumentation, and starting a new session, the
software retains the size and position of all the windows that were open in
the previous session.
Related Topics
Copy a Reference Item to the Domain Explorer, page 233
Domain Explorer Common Tasks, page 209
SmartPlant Instrumentation Explorer: An Overview, page 206

244 SmartPlant Instrumentation User’s Guide

 Working with the Reference Explorer: An Overview

Reference Explorer Common Tasks

The following tasks are used frequently when you work with the Reference
Explorer.

Create a Reference Item

This procedure shows how to create an item in the Reference Explorer. For more
information, see Create a Reference Item, page 251.

Create a Reference I/O Card

This procedure explains how to create a reference I/O card. For more information,
see Create a Reference I/O Card, page 251.

Create a Reference I/O Termination

This procedure explains how to create a reference I/O termination. For more
information, see Create a Reference I/O Termination, page 255.

Create a Reference Wiring Equipment Item

This procedure explains how to create a reference wiring equipment item. For more
information, see Create a Reference Wiring Equipment Item, page 254.

Copy a Reference Item to the Domain Explorer

This procedure explains how to copy a reference item from the Reference Explorer
to the Domain Explorer. This way you can create numerous plant items based on
typical configurations on the fly. Note that SmartPlant Instrumentation allows you to
preserve the internal connections within a copied item. This means that the software
retains the cables and cross wires that connect among the various terminal strips
within the item that you are copying. Also, if you are copying a panel or another item
that contains child items, the software duplicates this item in its entirety, including all
the existing child items.

For more information, see Copy a Reference Item to the Domain Explorer, page 233.

Edit Item Properties

This procedure explains how to edit the properties of an item that you select in the
Reference Explorer. For more information, see Edit Item Properties, page 231.

SmartPlant Instrumentation User’s Guide 245

Working with the Reference Explorer: An Overview

Duplicate an Item
You use this action to create a duplicate item within the same parent hierarchy. That
is, the software creates another copy of the selected item under the immediate parent
item. For example, if you need to insert an apparatus within an existing apparatus
group, expand an apparatus group and duplicate an apparatus. You can then change
the sequence numbers of the apparatuses to re-arrange them on the strip the way you
require. Furthermore, if you are duplicating a panel or another item that contains
child items, the software duplicates this item in its entirety. That is, SmartPlant
Instrumentation creates the new item with exactly the same child items as the original
panel. Note that in this case, the software also retains all the existing internal
connections if you selected Copy internal connections in the wiring preferences.
For more information, see Duplicate an Item, page 230.

Delete Items
This procedure shows how to delete the items that you select in the Reference
Explorer. For more information, see Delete Items, page 231.

Search for Items in SmartPlant Instrumentation Explorer

You use this feature to find items that you want to work with. You can search for
multiple items in the entire domain, the current highest plant hierarchy level, or the
current lowest plant hierarchy level. The term "current" refers to the plant hierarchy
level that you selected in the Open dialog box when you started SmartPlant
Instrumentation. For more information about searching for items, see Search for
Items in SmartPlant Instrumentation Explorer, page 233.

Find an Item in the Tree View

This feature enables you to find an item in the Reference Explorer tree view. This
feature is especially useful when you want to find an item in a particular folder that
contains numerous items. You can type an item name and click Find or you can let
the software look for the item as you type the item name. The feature allows you to
set the search delay that determines how long the software waits after the last time
you press a key on your keyboard.

For more information, see Find an Item in the Tree View of an Explorer Window,
page 234.

Filter the Display of Items According to a Specific Item Type

This option allows you to filter the items according to a specific item type. You can
apply an item type filter to the entire tree view of the current view of the current
Explorer window or only to a particular folder or node that contains child items.
Item type filters override your item name filters.

246 SmartPlant Instrumentation User’s Guide

 Working with the Reference Explorer: An Overview

Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.

Filter settings take effect only for the user who defined the filter and only for the
current custom view of the active Explorer window.

Note that item type filters override your item name filters.

For more information, see Filter the Display of Items According to a Specific Item
Type, page 236.

Filter the Display of Items According to a Specific Item Name

This option allows you to filter the items according to a specific item name. An item
name filter affects the entire tree view of the current view of the active Explorer
window and not just a particular folder or hierarchy node. You can also instruct the
software to override the item type filters if needed.

Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.

You can define an item name filter only if you do one of the following:

• Without selecting anything in the Explorer window, click

on the toolbar.
• Right-click the root node in the Explorer tree view and
then on the shortcut menu, click Filter.
Note that filter settings take effect only for the user who defined the filter and only for
the current custom view of the active Explorer window. For more information, see
Filter the Display of Items According to a Specific Item Name, page 235.

Filter Cables in an Explorer Window

Allows you to set additional filter definitions for the Cables and the Cross Cables
folders. You can filter cables according to their connections and cables that are
connected to a specific Foundation Fieldbus or Profibus segment. For more
information, see Filter Cables in an Explorer Window, page 238.

Filter Loops in an Explorer Window

Allows you to set additional filter definitions for the Loops folder. You can filter
loops according to blocks associated with loop tags. For more information, see Filter
Loops in an Explorer Window, page 240.

SmartPlant Instrumentation User’s Guide 247

Working with the Reference Explorer: An Overview

Use My List in the Items Pane

This procedure explains how to add various items to the My List view of the Items
pane. My List allows you to create a special view of the Items pane where you can
keep items that belong to various folders in the tree view. The software retains all the
items in the My List view until you remove them from that list. Exiting SmartPlant
Instrumentation and starting a new session does not affect the contents of My List.
For more information, see Add Items to My List in the Items Pane, page 242.

Display a Browser View in the Explorer Items Pane

This option allows you to display a browser view in the Items pane for an item type
or a folder that you select in the Reference Explorer tree view. This way, instead of
displaying child items, you can display item properties of the item you selected in the
tree view pane. The software displays the browser view according to the style
settings of the selected browser. You can print out the current browser view,
however, you cannot edit the item properties. For more information, see Display a
Browser View in the Explorer Items Pane, page 242.

Define and Use a Custom View

SmartPlant Instrumentation allows you to define custom views for the Domain
Explorer and the Reference Explorer. The software lets you select a folder or
multiple folders and add these folders with their child items to a custom view that you
select. Note that the custom views that you define are not available to other users of
SmartPlant Instrumentation. For more information, see Define and Use a Custom
View, page 243.

The Organization of Items in the Reference Explorer Tree

View
The tree view pane of the Reference Explorer shows reference items organized by
folders. SmartPlant Instrumentation defines standard folders in the database. You
cannot move or delete these folders, nor can you add new folders. Each folder
contains a particular item type, and the options available on the menus depend on the
currently selected item type.

Panels
In this folder, reference panels are arranged according to their category. Panels, in
turn, contain their child items, for example terminal strips, racks, wiring equipment,
and so forth. There is a lot of flexibility in creating a panel hierarchy. There is no
rigid structure like "panel – strip – terminal" that limits your wiring design. You
can create various wiring structures, as you require. For details, see Panels by
Category Hierarchy Examples, page 215 to examine a few possible structures.

248 SmartPlant Instrumentation User’s Guide

 Working with the Reference Explorer: An Overview

Cables
This folder holds all the existing reference cables. You can create various child items
under cables. For an example, see Cable Hierarchy Example, page 218.

Wiring Equipment
This folder holds all the available reference wiring equipment. The items are
organized in sub-folders according to the wiring equipment category such as barriers,
amplifiers, hubs, I/O cards, and so forth.

Hook-Up Item Libraries

This folder enables you to create and manage hook-up libraries and sub-libraries, and
organize hook-up items in sub-libraries as you require. For details, see Items in the
Hook-Up Item Libraries Folder, page 249.

Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Items in the Hook-Up Item Libraries Folder

The Hook-Up Item Libraries folder of the Reference Explorer enables you to
navigate to a hook-up item library, hook-up item sub-library, or hook-up item in a
graphical way resembling the Windows Explorer. You can expand or collapse the
levels to view the existing items. The Hook-Up Item Libraries folder shows you at
a glance the graphical representation of the relationships that exist among the hook-up
item libraries, hook-up item sub-libraries, and hook-up items.

The Reference Explorer employs an expandable/collapsible hierarchy that allows

you to navigate to relevant items and select them for use. To perform an action, right-
click the Hook-Up Item Libraries folder or an item and then click a command. Note
that the software uses various icons beside a folder or item to indicate the status of a
folder or an item , for example a view-only item , a claimed item , an item that
belongs to As-Built, and so forth. For the full list of the item indicators, see Item
Status Indicators in the Domain Explorer, page 229. For a detailed explanation of the
tree view and Items panes, see Working with the Reference Explorer: An Overview,
page 244.

In the Hook-Up Item Libraries folder, the software arranges the items in three
levels, based on the relationship among them.

Level 1
Hook-Up Item Libraries
This is the highest level in the Hook-Up Item Libraries folder hierarchy. At this
level, the software displays all the hook-up libraries that exist in the current domain.
Hook-up libraries are indicated with the icon.

SmartPlant Instrumentation User’s Guide 249

Working with the Reference Explorer: An Overview

A hook-up library always contains one default sub-library and can also contain any
number of user-defined sub-libraries. For each hook-up library, on the shortcut
menu, you can click New to add user-defined sub-libraries, or click Properties to
update properties of an existing sub-library. You must set a specific library as the
active item library, which is indicated with the icon. To do so, on the shortcut
menu, click Actions > Set as Active Item Library. You cannot delete the default
sub-library.

Level 2
Hook-Up Item Sub-Libraries
Hook-up sub-libraries (indicated with the icon) appear under hook-up libraries.
At this level, you can click New to add items to sub-libraries, or click Properties to
update properties of an existing sub-library. You cannot delete the default sub-
library.

Level 3
Hook-Up Items
Hook-up items (indicated with the icon) appear under hook-up item sub-libraries.
Hook-up items do not contain child items. The actions that you can perform at this
level depend on the sub-library to which the items belong.

In the default sub-library, you can perform the following actions:

• Add new hook-up items one by one or in batch mode. To add a single
item, right-click the default sub-library and on the shortcut menu, click
New. To add items in batch mode, on the shortcut menu, click
Actions > Batch Item Creation.
• Update properties of an existing item. If this item exists in the user-
defined sub-libraries, the software automatically updates the item
properties in the user-defined sub-libraries.
• Permanently delete a hook-up item. When deleting an item from the
default sub-library, the software also deletes this item from all of the
sub-libraries that exist in the entire item library.
• Manually associate an item with a user-defined sub-library by
dragging the item from the default sub-library to a user-defined sub-
library.
In a user-defined sub-library, you can perform the following actions:

• Add new hook-up items. When you create a new item in a user-
defined sub-library, the software automatically creates this item in the
default sub-library too.

250 SmartPlant Instrumentation User’s Guide

 Working with the Reference Explorer: An Overview

• Update properties of an existing item. When you update properties of

an item in a user-defined sub-library, the software automatically
updates the item properties in the default sub-library too. You can
only add new hook-up items that do not exist in the default sib-library.
• Associate hook-up items with sub-libraries or remove items from sub-
libraries. To do so, select and right-click a user-defined sub-library
and then, on the shortcut menu, click Actions > Associate Items with
Sub-Libraries.
• Associate pipe specs with sub-libraries. To do so, select and right-
click a user-defined sub-library and then, on the shortcut menu, click
Actions > Associate Pipe Specs with Sub-Libraries. For more
information on implementation of pipe specs in SmartPlant
Instrumentation, see Pipe Specs: An Overview, page ???
Related Topics
• The Organization of Items in the Domain Explorer Tree View, page
212
• Working with the Reference Explorer: An Overview, page 244

Create a Reference Item

1. Press F8 to open the Reference Explorer.
2. Double-click a folder to display the other existing folders or items.
Tip
• If a folder does not contain sub-folders, right-click the main folder.
3. Right-click a sub-folder and then on the shortcut menu, point to New and click a
menu command.
Note
• The software does not check for duplicate names when creating a
reference I/O card. This is so because I/O card uniqueness is based on
a parent item and there are no parent items for I/O cards in the
Reference Explorer.
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206

Create a Reference I/O Card

1. Press F8 to open the Reference Explorer and expand the Panels folder.
2. In the Reference Explorer, expand the Wiring Equipment folder.

SmartPlant Instrumentation User’s Guide 251

Working with the Reference Explorer: An Overview

3. Right-click the I/O Cards folder and then on the shortcut menu, click New >
Wiring Equipment.
4. In the New Wiring Equipment dialog box, under Name, type the name of the
new I/O card and click OK.
Tip
• As a rule, I/O cards reside in rack slots. However, reference I/O cards
do not have parent hierarchy items. As a result, the software does not
check the name uniqueness of new reference I/O cards. Therefore,
make sure that you name your new reference I/O cards appropriately.
5. On the Wiring Equipment Properties - I/O Card dialog box, on the General
tab, do one of the following to define the name of the new card:
• Select the Apply naming convention check box selected if you want
the software to name the new card automatically according to the
naming conventions that are set for this type of equipment in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
• Clear the Apply naming convention check box and under Name, type
the name of the new card. Note that if you do not clear the Apply
naming convention check box, the software will ignore the name that
you type under Name.
6. Select the Double width check box if the card occupies a double width slot.
7. In the Details group box do the following as you require:
a. Type a description.
b. Select an I/O card type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the sequence of the new card in its
parent item. This sequence also determines the order in which wiring items
appear under their parent item in the Domain Explorer tree view.
8. Click the Control System tab.
9. In the Control system details group box, under I/O type, select a I/O type to
determine the actual function of the new I/O card. For example, AI, AO, DI, DP,
Fieldbus, Profibus, and so forth. You can add more values to this list in the I/O
Type supporting table in the Instrument Index module. (See the important notes
at the end of this procedure.)
10. Under Module, type the software address that this card is assigned to.

252 SmartPlant Instrumentation User’s Guide

 Working with the Reference Explorer: An Overview

Tip
• Module, Controller/Processor, Rack, and Slot are field headers
specific to panel manufacturers. Selecting a different manufacturer
when editing the panel displays the headings used by that panel
manufacturer. For details, see Customize the Controller/Processor
List Header in I/O Card Properties, page ???.
11. From the Controller/Processor list, select an I/O card controller. If the required
controller is not available on the list, click to define a new one.
12. To view the list of all I/O terminations associated with the current I/O card, click
the I/O Terminations button.
13. Click the Category Properties tab.
14. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• I/O card is a wiring equipment category that is shipped with
SmartPlant Instrumentation. You cannot delete or rename any of the
wiring equipment categories that have been shipped with the software.
Nor can you delete or rename the properties of the shipped categories.
However, when editing I/O card properties, you can add user-defined
properties which you can rename or delete as you wish. For details,
see Customize and Use Wiring Equipment Categories, page ???.
15. Click the Associate Symbols tab to associate a symbol with the current I/O cards.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page ???.
16. Click OK to accept your settings and close the dialog box.
Important
• In a redundant system configuration, an I/O card can function as a
primary or secondary I/O card and can be associated with several I/O
terminations. Therefore, an I/O termination can serve multi-paired
redundant I/O cards. However, in these redundant I/O card
configurations, the I/O termination can be associated only with one
pair of primary and secondary I/O cards. Also, an I/O card cannot
function as both a primary and secondary I/O card for the same I/O
termination.
• If an I/O card functions as a primary I/O card, the Control System tab
of the Wiring Equipment Properties - I/O Card dialog box displays
the secondary I/O card data and the primary I/O card data properties
remain blank. If an I/O card functions as a secondary I/O card, the
Control System tab displays the primary I/O card data and the
secondary I/O card data properties remain blank.

SmartPlant Instrumentation User’s Guide 253

Working with the Reference Explorer: An Overview

Create a Reference Wiring Equipment Item

1. Press F8 to open the Reference Explorer.
2. In the Reference Explorer, expand the Wiring Equipment folder.
3. Right-click an appropriate child folder and then on the shortcut menu, click New
> Wiring Equipment.
Tip
• Since reference wiring equipment items do not have parent hierarchy
items, the software does not check the name uniqueness of new
reference wiring equipment items. Therefore, make sure that you
name your new reference items appropriately.
4. On the New Wiring Equipment dialog box, under Name, type the name of the
item and click OK.
5. On the Wiring Equipment Properties dialog box, on the General tab, do one of
the following to define the name of the new equipment:
• Select the Apply naming convention check box selected if you want
the software to name the new equipment automatically according to
the naming conventions that are set for this type of equipment in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
• Clear the Apply naming convention check box and under Name, type
the name of the new equipment. Note that if you do not clear the
Apply naming convention check box, the software will ignore the
name that you type under Name.
6. Select the Double width check box if the item occupies a double width slot.
7. In the Details group box do the following as you require:
a. Type a description.
b. Select an item type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the sequence of the new item in its
parent item. This sequence also determines the order in which wiring items
appear under their parent item in the Domain Explorer tree view.
8. Click the Category Properties tab.
Tip
• If you are creating a miscellaneous wiring equipment item , the
Category Properties tab is not available.
9. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.

254 SmartPlant Instrumentation User’s Guide

 Working with the Reference Explorer: An Overview

Tip
• Wiring equipment categories that are shipped with SmartPlant
Instrumentation have predefined properties. You cannot delete or
rename any of these categories or their properties. You can only edit
their values. However, you can add user-defined properties to any
category which you can rename or delete as you wish. For details, see
Customize and Use Wiring Equipment Categories, page ???.
10. Click the Associate Symbols tab to associate a symbol with the current item .
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page ???.
11. Click OK to accept your settings and close the dialog box.

Related Topics
• Reference Explorer Common Tasks, page 245

Create a Reference I/O Termination

1. Press F8 to open the Reference Explorer.
2. In the Reference Explorer, expand the Wiring Equipment folder.
3. Right-click the I/O Terminations folder and then on the shortcut menu, click
New > Wiring Equipment.
Tip
• Since reference I/O termination items do not have parent hierarchy
items, the software does not check the name uniqueness of new
reference I/O termination items. Therefore, make sure that you name
your new reference I/O termination items appropriately.
4. On the New Wiring Equipment dialog box, from the Category list, select I/O
Termination.
5. Under Name, type the name of the new I/O termination and click OK.
6. On the Wiring Equipment Properties - I/O Termination dialog box, on the
General tab, do one of the following to define the name of the new card:
• Select the Apply naming convention check box selected if you want
the software to name the new card automatically according to the
naming conventions that are set for this type of equipment in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
• Clear the Apply naming convention check box and under Name, type
the name of the new card. Note that if you do not clear the Apply
naming convention check box, the software will ignore the name that
you type under Name.

SmartPlant Instrumentation User’s Guide 255

Working with the Reference Explorer: An Overview

7. Select the Double width check box if the card occupies a double width slot.
8. In the Details group box do the following as you require:
a. Type a description.
b. Select an I/O termination type, model, and manufacturer. If the required value
is not available on the list, click to define a new one.
c. Enter a sequence if you need to define the sequence of the new I/O
termination in its parent item . This sequence also determines the order in
which wiring items appear under their parent item in the Domain Explorer
tree view.
9. Click the Control System tab.
10. From the I/O type list, select a I/O type to determine the actual function of the
new I/O termination. For example, AI, AO, DI, DP, Fieldbus, Profibus, and so
forth. You can add more values to this list in the I/O Type supporting table in the
Instrument Index module.
11. To set the new I/O termination in a distant cabinet or to associate the I/O
termination with an I/O card that resides in another panel, do the following:
a. select the Set within a distant cabinet check box.
b. Select a cabinet in the Primary I/O card group box.
12. To associate the current I/O termination with an I/O card that does not have a
built-in termination block, select the required options in the Primary I/O card
group box.
Tip
• The I/O card list contains only those I/O cards that have been created
under a rack and a slot. Fore more information, see Associate an I/O
card with an I/O Termination, page ???.
13. To define the current I/O termination as an I/O termination that serves two
redundant I/O cards, do the following:
a. Select the Define a redundant I/O card check box.
b. Select the required options in the Secondary I/O card group box.
14. Click the Category Properties tab.
15. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.

256 SmartPlant Instrumentation User’s Guide

 Working with the Reference Explorer: An Overview

Tip
• I/O termination is a wiring equipment category that is shipped with
SmartPlant Instrumentation. You cannot delete or rename any of the
wiring equipment categories that have been shipped with the software.
Nor can you delete or rename the properties of the shipped categories.
However, when editing I/O termination properties, you can add user-
defined properties which you can rename or delete as you wish. For
details, see Customize and Use Wiring Equipment Categories, page
???.
16. Click the Associate Symbols tab to associate a symbol with the current I/O
termination. The software will use this symbol when generating a report in the
Enhanced Report Utility. For details, see Associate a Symbol with an Item, page
???.
17. Click OK to accept your settings and close the dialog box.

Related Topics
• Reference Explorer Common Tasks, page 245

Copy a Reference Item to the Domain Explorer

1. Press F7 and then F8 to open the Domain Explorer and the Reference Explorer.
2. In the Reference Explorer, expand a hierarchy level and select a reference item.
3. Drag your selection to a destination level in the Domain Explorer. Place both
Explorer windows side by side on your screen and then drag the required items
from one Explorer to the other.
4. In the appropriate properties dialog box, (depending on the reference item that
you are copying), modify the properties of the new item as you require.

SmartPlant Instrumentation User’s Guide 257

Instrument Index Module: An Overview

Instrument Index Module: An Overview

The Instrument Index module allows you to create, modify, and maintain a
comprehensive database that contains all your instrumentation data.

The module offers tools for adding, editing, duplicating, and deleting loop and
instrument tag numbers. Instrument types and their profiles are organized in a
comprehensive fashion providing easy data entry. Other data, such as model and
manufacturer, P&ID drawing numbers, lines, locations, I/O types, equipment names
are organized in supporting tables.

The Instrument Index module also provides other functions that include item-oriented
(tag, loop, and so forth), filtered, sorted and customizable database viewing options.
You can generate reports in several formats, attaching remarks to items, creating
specific summaries, and viewing and managing history.

Before working with the Instrument Index module make sure the Domain
Administrator has defined the Loop and Tag naming conventions in the
Administration Module. For more information, see Naming Conventions: An
Overview in the Administration User's Guide, under Domain and Project
Administration, Naming Conventions, Naming Conventions: An Overview.

Related Topics
• Associating Instrument Tags with Loop Numbers: An Overview, page 310
• Editing Data in a Browser View: An Overview, page 332
• Generating Documents: An Overview, page 346
• Managing Instrument Tags: An Overview, page 284
• Managing Lines: An Overview, page 326
• Managing Loop Numbers: An Overview, page 259
• Working with External Documents: An Overview, page 352
• Working with Instrument Types: An Overview, page 276

258 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

Managing Loop Numbers: An Overview

SmartPlant Instrumentation allows you to easily create and manage loops through out
your <plant>. You can create unique numbered loops for each <unit> in your
<plant&gt. Duplicate, rename, and move loops about your <plant> without losing
critical information. Edit loop number information, change loop numbers, create new
numbers, simply and quickly without creating a duplicate loop number within a
<unit>, or losing any information. SmartPlant Instrumentation keeps track of all your
loops making the necessary adjustments automatically.

Related Topics
• Managing Loop Numbers Common Tasks, page 260

SmartPlant Instrumentation User’s Guide 259

Managing Loop Numbers: An Overview

Managing Loop Numbers Common Tasks

The following tasks are used frequently when you create and manage the loop
numbers in your plant.

Create a New Individual Loop Number

This option shows you how to create a new single loop number, in the Domain
Explorer or in the Instrument Index Module, and add it to your database. For more
information, see Create a New Individual Loop Number, page 262.

Duplicate a Loop Number

This option shows you how to create a new loop number by duplicating an existing
one. SmartPlant Instrumentation creates a new loop number based on the properties
of a source loop that you select. This feature is useful when you want to create a loop
number similar to an existing one. You duplicate a loop number and then edit its
properties as needed. Note that you can duplicate a loop number in the same <unit>
as the source loop number or in any other <unit> of the current domain. For more
information, see Duplicate a Loop Number, page 263.

Edit Loop Number Properties from the Domain Explorer

This option allows you to modify the properties of an existing loop number from the
Domain Explorer . You can also edit the target loop number when duplicating an
existing loop number. For more information, see Edit Loop Number Properties from
the Domain Explorer, page 266.

Edit Loop Properties from the Instrument Index Module

This option allows you to modify the properties of an existing loop number from the
Instrument Index Module. You can also edit the target loop number when duplicating
an existing loop number.; For more information, see Edit Loop Properties from the
Instrument Index Module, page 267.

Edit Multiple Loop Numbers

This option shows you how to select a group of loop numbers and modify the profile
of these loop numbers. This option is especially effective if you do not want to edit
the tag numbers associated with the loops you are editing. For more information, see
Edit Multiple Loop Numbers.

Create a Loop Number When Editing a Tag

This option shows you how to create a new loop number on the fly while editing a tag
number. You can then associate the current tag number with that new loop you are
creating. For more information, see Create a Loop Number When Editing a Tag.

260 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

Move Loop Numbers

This option shows you to select one loop number or a group of loop numbers and
move them to another <unit> in the current <plant>. For more information, see
Move Loop Numbers.

Delete Loop Numbers

This option shows you how to delete loop numbers that are no longer required. You
can delete a single loop number or several ones as needed. When deleting a loop
number, several batch deletion options are possible depending on your loop number
deletion preference settings. You can delete several loop numbers in batch mode
(without being prompted to confirm each deletion) or delete several loop numbers one
by one, confirming the deletion of each loop number.

Note that if you are deleting a loop number associated with wiring, SmartPlant
Instrumentation automatically disconnects all the required instruments. For more
information, see Delete Loop Numbers, page 272.

Rename A Single Loop Number

This option shows you how to rename a single loop number. For more information,
see Rename A Single Loop Number.

Rename Multiple Loop Numbers

This option shows you how to rename multiple loop numbers in the current <unit>.
You can also modify the loop number service and edit associated tag numbers if
required. For more information, see Rename Multiple Loop Numbers.

Define a Functional Requirement for a Loop

This option shows you to define a functional requirement for a selected loop number.
Functional requirement is the combination of loop function and process function data
for a specific loop. For example, for Loop FIC-100, F refers to process function and
IC to process function. C can be interpreted as measuring and control. During the
early stages of a project, the loop functional requirements are known. However, the
functional requirements for the project devices are not known yet. To make cost
estimations during the early stages of your project, you need loop functional
requirements that contain process data, such as loop number, DN, pipe specifications,
and so forth. Later on in your project, you can copy these functional requirements to
the real devices.

Note that you can define multiple functional requirements for a specific loop number.
Also, you can generate a specification for a loop that has a functional requirement.
For more information, see Define a Functional Requirement for a Loop.

Related Topics
• Managing Loop Numbers: An Overview, page 259

SmartPlant Instrumentation User’s Guide 261

Managing Loop Numbers: An Overview

Create a New Individual Loop Number

1. On the Domain Explorer, expand your current <plant> hierarchy to display the
Loops folder.
2. Right-click the Loops folder and on the shortcut menu, click New > Loop.
3. On the New Loop Number dialog box, type the name of the new loop number.
For an explanation of the segments of a loop number see Loop Number Naming
Convention, page 263.
4. Click OK and, when prompted to create a new tag number, and associate it with
the current loop, click Yes.
• Click No if you only want to create a loop number. Then, following
the current procedure from Step 7.
• Click Yes if you want to create a tag number at this stage and associate
it with the new loop.
5. If you clicked Yes, do the following:
a. The New Tag Number dialog box opens.
b. Type the tag number and click OK.
c. On the Select Instrument Type dialog box, select your instrument type and
click OK.
d. The Tag Number Properties dialog box opens where you can define the
general properties for your tag number. For details of the options available
click the Help button in the New Tag Properties dialog box.
e. When you have finished click OK to open the Loop Number Properties
dialog box.
6. On the Loop Number Properties dialog box, define the properties you want to
associate with the loop number. For details of the options available click the Help
button in the Loop Number Properties dialog box.
7. Click OK. to close the Loop Number Properties dialog box.
Notes
• You can also create a loop number from the Instrument Index module. In
the Instrument Index Module window, click on the toolbar or on the
menu bar, click Edit > Loop Numbers > New Loop Number.
• The data field in the New Loop Number dialog box displays the loop
name template which is based on the loop naming convention defined by
the Domain Administrator. In the alphanumeric and the numeric parts of
the name, you can type any character (letters, digits, spaces, and so forth).
You can customize the loop name template but only the Domain
Administrator can change the naming conventions. For more details see
Customize New Loop Numbers, page 271.

262 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

• You can define a functional requirement while creating a new loop. For
details see Define a Functional Requirement for a Loop, page 275.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Loop Number Naming Convention

When renaming existing loop numbers or creating new ones, make sure that the loop
number names comply with the naming conventions set for the current <unit> by the
Domain Administrator for the current <unit>. In the alphanumeric and the numeric
parts of the name, you can type any character (letters, digits, spaces, and so forth).

Example Loop Number: 101- FIC – 2225/E

Segment Description
100 – prefix derived from the loop naming convention defined by
the Domain Administrator
F – measured variable
IC – loop function
2225 – loop number
E – suffix

Related Topics
• Create a Loop Number When Editing a Tag, page 270
• Create a New Individual Loop Number, page 262
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Duplicate a Loop Number

1. In the Domain Explorer, expand your current <plant> hierarchy to display the
Loops folder.
2. Double-click the Loops folder to display the existing loops.
3. Right-click the loop you want to duplicate, and on the shortcut menu, click
Duplicate.
4. On the Duplicate Loop Number dialog box, type the new loop number.

SmartPlant Instrumentation User’s Guide 263

Managing Loop Numbers: An Overview

Tip
• The data field on the Duplicate Loop Number dialog box displays the
loop name template based on the loop naming convention defined by
the Domain Administrator. In the alphanumeric and the numeric parts
of the name, you can type any character (letters, digits, spaces, and so
forth).
5. If required, do the following to create the duplicated loop number in a different
<unit> in the current domain:
a. On the Duplicated Loop Number dialog box, check the Create in another
unit check box.
b. On the Select Target Unit dialog box, select the target unit.
c. Click OK to return to the Duplicated Loop Number dialog box.
6. Click OK in the Duplicated Loop Number dialog box.
7. Do the following to create new tag numbers that will be associated with the new
loop number:
a. On the Create Loop Tags dialog box, select the appropriate check boxes
beside the tag numbers that you want to create. The software duplicates the
tags associated with the source loop and associates the new tags with the new
loop number. Note if you have more than one type of tag associated with the
loop, for example; Conventional tags and Functional requirement tags, then a
Create Loop Tags dialog box will open for each tag type, one after the other.
b. Modify the names of the new tag numbers as needed. Note that you cannot
change the prefix and the separator.
c. Select Copy the instrument type from the source tag numbers to keep the
instrument type of the source tags.
d. Click Next, to move to the next tag type Create Loop Tags dialog box. Note
if you click Next after editing all the loop tag types a prompt will appear, click
Yes to return to the first Create Loop Tags dialog box, or No to close the
prompt.
e. Click OK.
f. When prompted, click Yes to edit the tag properties you have duplicated, or
No to duplicate the tag numbers with their existing parameter values.
g. On the Loop Number Properties dialog box, define the properties you want
to associate with the loop number. For details of the options available click the
Help button in the Loop Number Properties dialog box.
h. Define a functional requirement if required. For details see Define a
Functional Requirement for a Loop, page 275.
i. Click OK .

264 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

Notes
• You can change the measured variable of the new loop number or keep
it the same as the source one. New tag numbers associated with the
new loop number will be affected accordingly, that is, the measured
variable of the new tag numbers will change if the measured variable
of the new duplicated loop is changed. For example, if you are
duplicating Loop 101-F-102 and you change the measured variable of
the new loop to T, the new tag numbers associated with the new loop
number will change their instrument type in accordance with the new
measured variable: source Tag Number 101-FE-102 will change to
101-TE-102.
• You can also duplicate a loop number from the Instrument Index
module. In the Instrument Index Module window, click on the
toolbar or on the menu bar, click Edit > Loop Numbers > Duplicate
Loop Number.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Move Loop Numbers

1. Start the Instrument Index Module by doing one of the following:

• Click .
• Click Modules > Instrument Index.
2. On the Instrument Index menu bar click Edit > Loop Numbers > Move
Number.
3. On the Enter Loop Number dialog box, do one of the following:
• To move one loop number, type the required loop number.
• To move a group of loop numbers, click Find.
• In the Find Loop dialog box click Find again.
• In the Search results data window, hold down Ctrl and highlight the
required loop numbers, or select the Select all check box to move all
the displayed loop numbers.
4. Click OK.
5. On the Select Target <Unit> dialog box, select the <unit> to which you what to
move the selected loop numbers.
6. Click OK.

Related Topics
• Managing Loop Numbers Common Tasks, page 260

SmartPlant Instrumentation User’s Guide 265

Managing Loop Numbers: An Overview

Edit Loop Number Properties from the Domain Explorer

1. On the Domain Explorer, expand your current <plant> hierarchy to display the
Loops folder
2. Double-click the Loops folder to display the existing loops.
3. Right-click a loop, then click Properties.
Tip
• You can also edit the properties of a loop number from the
Instrument Index Module. For more details see Edit Loop
Properties from the Instrument Index Module, page 267
4. On the Loop Number Properties dialog box, edit the loop properties by entering
values or selecting values from the lists.
Tips
• If needed, click the button beside an appropriate list arrow to open
the pertinent supporting table where you can rename a loop number,
add, edit, or delete an item on the list.
• Select Display old loop number automatically under Preferences >
Instrument Index > Rename, for the Old loop number field to
automatically display the old loop number when renaming a loop.
• You can define a functional requirement while creating a new loop.
For details see Define a Functional Requirement for a Loop, page 275
5. Select Apply P&ID drawing to tags to apply the P&ID drawing number data to
any new tag numbers that will be subsequently associated with this loop. Then, in
the Loop Browser View window (in the Browser module), you can select a
different drawing number (if available) and propagate it to all tag numbers
associated with this loop. If you are editing an existing loop which is already
associated with a P&ID drawing number, selecting this option replaces the
existing drawing number values with the new drawing number that you enter in
the P&ID drawing field.
6. Select the Apply service to tags check box to download the loop service to any
new tag numbers that will be subsequently associated with the current loop. If
you are editing an existing loop which is already associated with tag numbers,
selecting this option replaces the existing tag service values with the new loop
service that you type in the Loop service field.
7. Select Apply equipment to tags to apply the equipment data to any new tag
numbers to be subsequently associated with this loop.

266 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

Tips
• If you clear the Apply P&ID drawing to tags check box, you will still
be able to define a P&ID drawing reference for subsequently
associated new tag numbers by selecting a required drawing number
from the P&ID list in the Tag Number Properties dialog box.
• If the loop you are editing already contains associated equipment,
selecting this option replaces the existing equipment values with the
new equipment that you type in the Loop equipment field.
8. Select the Update document number check box to update the document number
of the associated loop drawing.
Tip
• A document number naming convention can contain segments that
represent loop number properties. Therefore, if you select this check
box, changing a loop number property that is used in the document
number segment also changes the document numbers in accordance
with this change. After you select this check box, the software updates
numbers of all documents containing the current loop number. For the
current loop number, the software overrides the default or user-defined
numbers of all the documents that appear in the Loop Drawing List
dialog box of the Loop Drawings module. For details on document
number naming conventions, see the Administration module Help,
Document Number Naming Convention Examples.
9. Click OK.
10. At the prompt, do one of the following:
• Click Yes to edit the tag numbers associated with the current loop.
• Click No to close the Loop Number Properties dialog box and save
new loop number values without editing the associated tag numbers.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Edit Loop Properties from the Instrument Index Module

1. To start the Instrument Index Module do one of the following:

• Click .
• Click Modules > Instrument Index.
2. In the Instrument Index Module window, do one of the following:

• Click .
• Click Edit > Loop Numbers > Loop Number Properties.

SmartPlant Instrumentation User’s Guide 267

Managing Loop Numbers: An Overview

3. In the Enter Loop Name dialog box, do one of the following:

• Type the loop number that you want to edit and click OK.
• Click Find without entering any loop number and in the Find Loop
dialog box click Find. Select the loop number whose properties you
want to edit in the Search results data window, and click OK.
4. In the Loop Number Properties dialog box, edit the loop properties by entering
values or selecting values from the lists.
Tips
• If needed, click the button beside an appropriate list arrow to open
the pertinent supporting table where you can rename a loop number,
add, edit, or delete an item on the list.
• Select Display old loop number automatically under Preferences >
Instrument Index > Rename, for the Old loop number field to
automatically display the old loop number when renaming a loop.
• You can define a functional requirement while creating a new loop.
For details see Define a Functional Requirement for a Loop, page 275
5. Select Apply P&ID drawing to tags to apply the P&ID drawing number data to
any new tag numbers that will be subsequently associated with this loop. Then, in
the Loop Browser View window (in the Browser module), you can select a
different drawing number (if available) and propagate it to all tag numbers
associated with this loop. If you are editing an existing loop which is already
associated with a P&ID drawing number, selecting this option replaces the
existing drawing number values with the new drawing number that you enter in
the P&ID drawing field.
6. Select the Apply service to tags check box to download the loop service to any
new tag numbers that will be subsequently associated with the current loop. If
you are editing an existing loop which is already associated with tag numbers,
selecting this option replaces the existing tag service values with the new loop
service that you type in the Loop service field.
7. Select Apply equipment to tags to apply the equipment data to any new tag
numbers to be subsequently associated with this loop.
Tips
• If you clear the Apply P&ID drawing to tags check box, you will still
be able to define a P&ID drawing reference for subsequently
associated new tag numbers by selecting a required drawing number
from the P&ID list in the Tag Number Properties dialog box.
• If the loop you are editing already contains associated equipment,
selecting this option replaces the existing equipment values with the
new equipment that you type in the Loop equipment field.

268 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

8. Select the Update document number check box to update the document number
of the associated loop drawing.
Tip
• A document number naming convention can contain segments that
represent loop number properties. Therefore, if you select this check
box, changing a loop number property that is used in the document
number segment also changes the document numbers in accordance
with this change. After you select this check box, the software updates
numbers of all documents containing the current loop number. For the
current loop number, the software overrides the default or user-defined
numbers of all the documents that appear in the Loop Drawing List
dialog box of the Loop Drawings module. For details on document
number naming conventions, see the Administration module Help,
Document Number Naming Convention Examples.
9. Click OK.
10. At the prompt, do one of the following:
• Click Yes to edit the tag numbers associated with the current loop.
• Click No to close the Loop Number Properties dialog box and save
new loop number values without editing the associated tag numbers.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Edit Multiple Loop Numbers

1. Start the Instrument Index Module by doing one of the following:

• Click .
• Click Modules > Instrument Index.
2. In the Instrument Index Module window, do one of the following:

• Click .
• Click Edit > Loop Numbers > Loop Number Properties.
3. On the Enter Loop Number dialog box, click Find without typing any loop
number.
4. On the Find Loop dialog box, click Find.
5. On the Search results data window, select the loop numbers you require. You
can hold down the Ctrl key and select a group of loop numbers or check the
Select all check box.
6. Click OK.

SmartPlant Instrumentation User’s Guide 269

Managing Loop Numbers: An Overview

7. On the Loop Number Properties dialog box, edit the loop properties by entering
values or selecting values from the lists.
Tip
• If needed, click the button beside an appropriate list arrow to open
the supporting table where you can rename a loop number, add, edit,
or delete an item on the list.
8. Select Apply service to tags to apply the loop service of the current loop number
to the associated tag numbers.
9. Select Apply P&ID to tags to propagate the P&ID drawing number data to all the
tag numbers associated with the current loop number.
10. Select Apply equipment to tags to propagate the equipment data to all the tag
numbers associated with the current loop number.
11. Click Next to edit the properties of another loop.
Tip
• When you save the new loop number values, the software does not
update the properties of the tags associated with the loop numbers you
are editing. When editing multiple loop numbers, the software does not
prompt you to edit the associated tag numbers. For more details on
editing tags see Edit Instrument Tags from the Instrument Index, page
291.
12. Click OK to close the Loop Number dialog box and save new loop number
values.

Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Create a Loop Number When Editing a Tag

1. From the Domain Explorer select the tag you want to edit.
2. Right click the tag and select Properties.
3. On the Tag Number Properties dialog box, click New Loop.
4. On the New Loop Number dialog box, type the name of the new loop number
and click OK. For an explanation of the segments of a loop number see Loop
Number Naming Convention, page 263
5. Edit the properties of the new loop number as required In the Loop Number
Properties dialog box and click OK.
6. On the Tag Number Properties dialog box, click OK.

Related Topics
• Managing Loop Numbers Common Tasks, page 260

270 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

Customize New Loop Numbers

The options in this dialog box allow you to customize the loop number name
template that appears in the New Loop Number dialog box. You can also choose to
propagate the loop service description to the loop drawing reference if desired.

• Define new loop name template:

These options determine how SmartPlant Instrumentation displays new loop number
names in the New Loop Number dialog box in relation to the previously created tag
number. The options are:

• No default – The data field in the New Loop Number dialog box does
not display any default loop, letting you enter the number you need.
• Same as the last created loop – The data field in the New Loop
Number dialog box displays the last created loop. You can accept the
displayed number, modify it, or type the number you need.
• Same as the last created loop + 1 – The data field in the New Loop
Number dialog box displays the last created loop number incremented by
one. You can accept the displayed number, modify it, or type the number
you need.
• The last existing loop in the unit + 1 – The data field in the New Loop
Number dialog box displays the last existing loop number in the current
unit incremented by one. You can accept the displayed number, modify it,
or type the number you need.
• The last existing loop in the domain + 1 – The data field in the New
Loop Number dialog box displays the last existing loop number in the
current domain incremented by one. You can accept the displayed number,
modify it, or type the number you need.
• Apply loop service to drawing description
Specifies that in the Loop Drawings module, a loop service which you define for a
loop appears in the Loop Drawing List dialog box under the Description column. If
you clear the check box, the Description column remains empty.

Note
• The last three options in the Define new loop name template are
available for numeric loop names only. If your loop names are not
numeric, the data field in the New Loop Number dialog box will display
the last created loop.
Related Topics
• Create a New Individual Loop Number, page 262
• Loop Number Naming Convention, page 263
• Managing Loop Numbers Common Tasks, page 260

SmartPlant Instrumentation User’s Guide 271

Managing Loop Numbers: An Overview

Delete Loop Numbers

1. On the Instrument Index module menu bar, click Edit > Loop Numbers > Delete
Loop Number.
2. On the Enter Loop Name dialog box, do one of the following:
• Type the loop number that you want to delete.
• Click Find without typing a loop number, so that you can select
several loop numbers for deletion in the Find Loop dialog box.
3. On the Find Loop dialog box, if required, click the Find loops with one or more
fieldbus tags check box to narrow your search results to loops that contain tags
with a fieldbus system I/O type.
4. Click Find.
Tip
• You can view more loop number rows, select Show more search
results.
5. On the Search results data window, select the loop numbers that you want to
delete and click OK.
6. On the Delete Loop Number dialog box, click Delete.
Tip
• If there are any tag numbers associated with the Loop Number a
prompt box will ask you if you want to delete all associated tag
numbers. Click Yes to delete, or No to save the tag numbers
Notes
• If you are deleting several loop numbers and you have selected the Skip
deletion confirmation option in your loop deletion preferences, all the
loop numbers you have highlighted in the Search results data window
will be deleted on the fly without prompting to confirm each deletion.
• You can also delete one or more loop numbers using the Domain
Explorer without opening the Instrument Index module. In the tree view
of the Domain Explorer, click the Loops folder. Then, in the Items
pane, select the loops you want to delete. Right-click the selected loop
numbers and then click Delete. For more information about the Domain
Explorer, see SmartPlant Instrumentation Explorer: An Overview, page
???.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

272 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

Rename A Single Loop Number

1. Start the Instrument Index Module by doing one of the following:

• Click
• Click Modules > Instrument Index.
2. On the Instrument Index Module, do one of the following:

• Click
• Click Edit > Loop Numbers > Loop Number Properties.
3. On the Enter Loop Number dialog box type the name of the loop that you want
to rename and click OK or do the following:
• On the Enter Loop Number dialog box, click Find without typing
any loop number.
• On the Find Loop dialog box click Find.
• Select the loop number from the Search results dialog box and click
OK.
4. On the Loop Number Properties dialog box, click next to the Loop number
field.
5. On the Rename Loop Number dialog box, type the new loop number name.
6. Click OK.
7. On the Loop Number Properties dialog box click OK.
Tips
• If you set the preferences to open the Rename Loop Drawing File
dialog box after renaming a loop number, do the following to rename
the file name of the associated CAD drawing. In the Rename Loop
Drawing File dialog box, select a check box beside a desired file
name. Type a new name over the name displayed in the New
Drawing File column.
• If more than one file appears in the data window, the drawing type is
multi-drawing.
Notes
• You can rename the drawing file name if the loop number that you are
renaming is associated with a CAD loop drawing. To do this, set a
preference on the Rename page of the Preferences Dialog box before
performing this procedure. For more details see Set Preference for
Renaming A CAD File from A Loop Number, page 274.
• Make sure that your new loop number name complies with the naming
conventions for the current <unit>.

SmartPlant Instrumentation User’s Guide 273

Managing Loop Numbers: An Overview

• All loop numbers must have unique names in the current <unit>.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Set Preference for Renaming A CAD File from A Loop

Number
1. Click File > Preferences.
2. In the Tree View pane, double click the Instrument Index icon.
3. Click the Rename icon.
4. Select the Rename drawing file name when renaming the loop check box.
5. Click OK.

Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
• Rename A Single Loop Number, page 273

Rename Multiple Loop Numbers

1. Start the Instrument Index Module by doing one of the following:

• Click .
• Click Modules > Instrument Index.
2. On the Instrument Index Module, do one of the following:

• Click .
• Click Edit > Loop Numbers >Rename Multiple Loop Numbers.
3. On the Enter Loop Number dialog box, click Find.
4. On the Find Loop dialog box, click Find again.
5. On the Search results data window, select the loop numbers you require. You
can hold down the Ctrl key and select a group of loop numbers or check the
Select all check box.
6. Click OK.
7. On the Rename Multiple Loop Numbers dialog box, do the following:
a. Select the Select check box next to each loop number that you want to
rename, or select the Select all check box to rename all the loops in the
Rename Multiple Loop Numbers dialog box.
b. On the New Loop Number field, type the new loop number name.

274 SmartPlant Instrumentation User’s Guide

 Managing Loop Numbers: An Overview

c. Click the Loop Service field and modify the value if needed.
d. Select the Edit tag numbers check box to edit the properties of the tag
numbers associated with the selected loop numbers after you rename these
loop numbers
e. Click Rename.
8. On the Tag Number Properties dialog box, edit the properties of the tag
numbers you have chosen.
9. Click OK.
10. The Rename Multiple Loop Numbers dialog box reopens.
Tip
• If after clicking Rename some of the selected loop numbers have not
been renamed, the Result field of the Rename Multiple Loop
Numbers dialog box displays the reason why you could not rename
these loop numbers.
11. Click Close.
Note
• Make sure that your new loop number names comply with the naming
conventions of the current <unit>. All loop numbers must have unique
names in the current <unit>.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259

Define a Functional Requirement for a Loop

1. Create or edit a loop number.
2. On the Loop Number Properties dialog box, click Func. Req.
3. On the New Tag Number dialog box, under Tag number type the new tag
number name and click OK.
4. On the Select Process Function dialog box, select the process function that you
need and click OK.
5. On the Tag Number Properties dialog box, define the properties of the new tag
number as you require.
6. Click OK.

Related Topics
• Create a New Individual Loop Number, page 262
• Duplicate a Loop Number, page 263
• Edit Loop Number Properties from the Domain Explorer, page 266

SmartPlant Instrumentation User’s Guide 275

Working with Instrument Types: An Overview

Working with Instrument Types: An Overview

You use instrument type to identify and classify instruments in SmartPlant
Instrumentation. SmartPlant Instrumentation provides a number of predefined
instrument types, such as FE, PT, and so forth. You can add new instrument types
and modify the shipped instrument types as required. You can also delete an
instrument type that is not in use, but the software does not let you delete an
instrument type that you already used to create a tag number.

SmartPlant Instrumentation uses standard function identifier acronyms to identify

instrument types. However, some function identifier acronyms are not unique and are
used for more than one instrument type. For instance, FE can refer to D/P Type Flow
Element or a Mass Flow Sensor. As a result, when creating a new tag number with
such an acronym, the software opens the Select Instrument Type dialog box where
you select the appropriate instrument type.

You classify all instrument types in SmartPlant Instrumentation according to process

function. You use process function to associate an instrument with a specific type of
specification, process data, and calculation sheet. For example, if you need to
associate a tag number with a specification that contains flow information, this tag
number must have an instrument type that belongs to the Flow process function.

For each instrument type that you define, you also set a profile definition that allows
you to automate the creation of tag numbers with a number of predefined properties.

When defining an instrument type, you also define its profile. Instrument type profile
allows you to automate the creation of tag numbers with a number of predefined
properties. When you create a tag number whose instrument type includes a profile,
the software automatically creates and associates a number of items that you chose in
the instrument type profile that serves as a basis for the new tag number.

Related Topics
• Instrument Types Common Tasks, page 277

276 SmartPlant Instrumentation User’s Guide

 Working with Instrument Types: An Overview

Instrument Types Common Tasks

The following tasks are used frequently when you create and manage instruments in
your plant.

Define an Instrument Type

Use this procedure to define a new instrument type, or edit the properties of an
existing instrument type. For more information, see Define an Instrument Type, page
278.

Define a General Process Function

Use this procedure to create a sub-category for the General process function. You
can then select one of these sub-category values for any General process function in
the data window of the Instrument Types dialog box. For more information, see
Define a General Process Function, page 279.

Define an Instrument Type Profile

Use this procedure to define a profile for each instrument type that you use. An
instrument type profile is a group of default settings that allow you to create new
instruments with certain predefined properties, associations, documents, and wiring
items. For example, when creating an instrument, you can automatically create the
instrument specification, reference device panel and cable, associate the instrument
with a specific hook-up, and so forth. For more information, see Define an
Instrument Type Profile, page 279.

Define a Wiring and Controls System Instrument Type Profile

Use this procedure to set the wiring and control system default settings allowing you
to create new tag numbers with the settings that you defined for the instrument type.
For example, you can automatically define new instruments as control-system-
enabled so that new tag numbers with the current instrument type profile will be part
of a control system and be able to send and receive signals. You can also include
automatic creation of control system (CS) tags, selection of reference panels and
cables, and connector definitions. For more information, see Define a Wiring and
Controls System Instrument Type Profile, page 280.

Copy Instrument Type Profile Data

Use this procedure to copy instrument type profile data from one instrument type to
another. This procedure is useful when you want to define instrument types with
similar profile properties. This way you do not need to define all the profile data for a
new instrument type from scratch. After completing this procedure, you can access
the profile associated with the target instrument type and change the required
properties. For more information, see Copy Instrument Type Profile Data, page 281.

SmartPlant Instrumentation User’s Guide 277

Working with Instrument Types: An Overview

Set an Alias Control System Tag

Use this procedure to create an alias for automatically created CS tags. When
creating CS tags automatically, you can instruct SmartPlant Instrumentation to use CS
tag naming conventions or use the shipped predefined naming convention for CS
tags. SmartPlant Instrumentation will name new CS tags according to the rules you
set only after the Domain Administrator has set the control system tag naming
conventions for the current <unit>. If the CS tag naming conventions haven't been
set, the software uses the following predefined rule for all automatically created CS
tags:
INSTRUMENT TYPE + NUMBER + \SUFFIX
After the Domain Administrator defines the control system tag naming conventions
for the current <unit>, you can decide whether to use the tag number's instrument
type for the CS tag or set an alias for the new CS tags. If you do not set an alias for
these CS tags, SmartPlant Instrumentation names them according to the instrument
type of the tag numbers with which they are created. Note that the length of the alias
text should not exceed the length of the instrument type alias string defined by the
Domain Administrator in the Naming Conventions dialog box. For more
information, see Set an Alias Control System Tag, page 282.

Apply all Existing Profiles

Use this procedure to create the following items specified in the for selected
instruments in an Instrument Index Standard Browser view: instrument
specifications, control system tags, and device panels and cables. For more
information, see Apply all Existing Profiles, page ???.

Related Topics
• Working with Instrument Types: An Overview, page 276

Define an Instrument Type

1. On the Instrument Index module menu bar, click Tables > Instrument Types.
2. In the Instrument Types dialog box, from the Process function list, select the
process function that you require.
3. Do one of the following:
• Click New to append a new data row in the data window.
• Click a selected row to edit the values of an existing instrument type.
4. Under Instrument Type, type an instrument type acronym. You can have
duplicate acronyms if needed.

278 SmartPlant Instrumentation User’s Guide

 Working with Instrument Types: An Overview

Tip
• If you have duplicate instrument type acronyms, when creating new
tags based on such an instrument type, SmartPlant Instrumentation
opens the Select Instrument Type dialog box and lets you select the
exact instrument type that you require for the new instrument.
5. Under Description, type a brief description as desired.
6. Under CS Tag Instrument Type Alias, type an alias for a control system tag
instrument type. Do this only if you want to create control system tags that will
have an alias instrument type associated with the current instrument type. Leave
this field blank if you are not going to create CS tags based on the current
instrument type or if you want the CS tags to have the same instrument type as the
tag number.
7. If you selected the General process function, under General Process Function
Sub-Category, select a value that you predefined in the General Process
Function Sub-Category supporting table. For details, see Define a General
Process Function, page 279.

Related Topics
• Apply all Existing Profiles, page ???
• Define an Instrument Type Profile, page 279
• Generate a Process Data Sheet for an Instrument, page 349
• Instrument Types Common Tasks, page 277
• Set an Alias Control System Tag, page 282
• Working with Instrument Types: An Overview, page 276

Define a General Process Function

1. On the Instrument Index module menu bar, click Tables > General Process
Function Sub-Category.
2. Click New to append a new data row.
3. Type the new sub-category name, for example, Mechanical, Electrical, and a
description, as you require.

Related Topics
• Define an Instrument Type, page 278
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276

Define an Instrument Type Profile

1. On the Instrument Index Module window menu bar, click Tables > Instrument
Types.
2. From the Process function list, select the process function that you require.

SmartPlant Instrumentation User’s Guide 279

Working with Instrument Types: An Overview

3. In the data window, select the instrument type for which you want to define
profile options.
4. Click Profile.
5. Make your definitions as you require.
Important
• Make sure that your preferences on the Instrument Index > Profile page
of the Preferences dialog box are set to activate the options that you
require. These preferences only apply when you create new instruments.
For example, if you clear the Specifications check box, when creating a
tag number, the software ignores specification creation options defined on
the General tab of the Instrument Type Profile dialog box and creates
the tag without any specification. If you then manually generate a
specification for the created tag, the software applies the existing
instrument type profile options.
• Preferences on the Instrument Index > Profile page of the Preferences
dialog box do not apply to the settings on the Calibration tab of the
Instrument Type Profile dialog box.
Related Topics
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276

Define a Wiring and Controls System Instrument Type

Profile
1. On the Instrument Index Module menu bar, click Tables > Instrument Types.
2. On the Instrument Types dialog box, from the Process function list, select the
process function type.
3. Do one of the following:
• Create a new instrument type.
• On the data window, select an existing instrument type.
4. Click Profile.
5. On the Instrument Type Profile dialog box, on the General tab, you can edit
fields as needed.
6. On the Wiring and Control System tab, select the Include wiring check box.
7. To define new instrument tags as control-system-enabled, select the Control
system check box. This enables the corresponding tag numbers for tag
assignment.
8. To enable automated creation of coupled control system tags, select Automatic
CS tags.

280 SmartPlant Instrumentation User’s Guide

 Working with Instrument Types: An Overview

9. From the Reference device panel list, select an appropriate reference panel for
this instrument type. These are device panels that were created in Reference
Explorer.
10. If your reference device panel settings enable the Conventional connections
group box, do one of the following for each connection that you need for the
current instrument type:
• Click New, to add a connection.
• Click Properties, to edit the properties of an existing convention, and
on the Conventional Connection Properties dialog box, define the
settings that you require, and click OK.
11. If your reference device panel settings enable the Plug-and-socket connections
group box, do one of the following for each connection that you need for the
current instrument type:
• Click New, to add a connection.
• Click Properties, to edit the properties of an existing convention, and
on the Plug-and-Socket Connection Properties dialog box, define
the settings that you require, and click OK.
Notes
• SmartPlant Instrumentation creates the wiring items according to an
instrument type profile, it always connects the created cable to the right
side of the panel that it creates. Therefore, you are not allowed to select a
left-oriented terminal from the Starting terminal list on the
Conventional Connection Properties dialog box. You can check the
configuration of a terminal by right-clicking it in the Domain Explorer
and selecting Properties on the shortcut menu.
• SmartPlant Instrumentation does not allow you to define a wiring
instrument type profile that enables connections on the left side of a device
panel.
Related Topics
• Define an Instrument Type, page 278
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276

Copy Instrument Type Profile Data

1. On the Instrument Index module menu bar, select Tables > Instrument Types.
2. From the Process function list, select the process function that you require.
3. Click Profile.
4. On the Instrument Type Profile dialog box, click Copy From to open the Copy
Instrument Type Profile Data dialog box.

SmartPlant Instrumentation User’s Guide 281

Working with Instrument Types: An Overview

5. From the Process function list, select the required process function.
6. In the data window, select the instrument type whose profile data you want to
copy.
7. Click OK to reopen the Instrument Type Profile dialog box, where you can
view the new profile properties.
8. Define the instrument type profile as you require.
Tips
• If you want to copy the specification profile properties, note that both
the source and the target instrument type must belong to the same
process function. When the source and the target instrument type
belong to different process functions, the system copies the data
without the specification profile properties.
• When copying instrument type profile settings, the software ignores
the definitions on the Calibration profile tab.
Related Topics
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276

Set an Alias Control System Tag

1. Check that your Domain Administrator has set the naming conventions for control
system tags that you create in the current <unit> .
2. Define the instrument type profile for the required tag numbers and enable the
automatic creation of CS tags. For more details, see Define an Instrument Type,
page 278.
3. In the Instrument Types dialog box, highlight the required instrument type.
4. Click in the CS Tag Instrument Type Alias field for the selected instrument type
and enter the CS alias by overtyping the displayed value.
5. Click OK to accept your settings and close the Instrument Types dialog box.
Note
• The CS tag alias will be enabled only if the Domain Administrator has
selected INST. TYPE ALIAS from the Description list in the Naming
Conventions dialog box when setting the control system tag naming
conventions.
Related Topics
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276

282 SmartPlant Instrumentation User’s Guide

 Working with Instrument Types: An Overview

Apply All Existing Profiles

1. Open an Instrument Index Standard Browser view.
2. Select the desired tag numbers.
3. Do one of the following:
• Right-click, and on the shortcut menu, click Apply Profile > Apply
All Profile Options.
• Click Actions > Apply Profile > Apply All Profile Options.
4. In the Results dialog box, view the results for each set of items, and then click
Close.
Notes
• To make this feature work, you must select the appropriate check boxes
and options in the instrument type profile of the selected tag number. For
more details, see Define an Instrument Type Profile, page 279.
• This option applies all the instrument type profile options to the selected
tag numbers, regardless of the settings defined on the Instrument Index >
Profile page of the Preferences dialog box.
• This option does not affect instrument profile options for items other than
specifications, control system tags, and device panels and cables.
• If you are applying a profile that has custom table definitions, the software
creates the custom tables and overwrites the data of the previously created
custom tables for the current tag numbers.
Related Topics
• Define an Instrument Type, page 278
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276

SmartPlant Instrumentation User’s Guide 283

Managing Instrument Tags: An Overview

Managing Instrument Tags: An Overview

SmartPlant Instrumentation allows you to easily create and manage instrument tags
throughout your <plant>. You can create unique numbered tags for each <unit> in
your <plant&gt. Duplicate, rename, and move tags about your <plant> without losing
critical information. Define each instrument tag simply. Easily add or remove
instrument tags from loops, without creating a duplicate instrument tag, or losing any
information. SmartPlant Instrumentation keeps track of all your instrument tags,
automatically making the necessary adjustments as you work.

Related Topics
• Working with Tag Numbers Common Tasks, page 285

Instrument Tag Naming Convention

The data field displays the instrument tag name template which is based on the tag
naming convention defined by the Domain Administrator for the current <unit>. In
the alphanumeric and the numeric parts of the name, you can type any character
(letters, digits, spaces, and so forth). You can customize the tag name template to set
a default, but only the Domain Administrator can change the naming conventions.
For more details see Customize Tag Name, page 292

Example: 101- FE – 2225/E

Segment Description
100 Prefix derived from the tag naming convention defined by the Domain
Administrator
FE Measured variable
2225 Loop number that the tag is associated with
E Suffix

Note
• Though the naming conventions do not apply to tags classed as electrical,
you can not create an electrical tag until the naming convention for
conventional instruments has been defined.
Related Topics
• Create an Instrument in the Domain Explorer, page 287
• Create an Instrument Tag in the Instrument Index Module, page 289
• Instrument Tag Renaming Options, page 301
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

284 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Working with Tag Numbers Common Tasks

The following tasks are used frequently when you create and manage instrument tags
in your plant.

Create an Instrument in the Domain Explorer

This option shows you how to create an instrument in the Domain Explorer. When
you define new instruments, the software creates them according to the instrument
type profiles that you defined in the Instrument Type Profile dialog box for a
selected instrument type. Defining a profile allows you to set instrument type default
settings for new instrument tags and thus create them with certain predefined
properties based on the instrument type you select for the new instrument. You set
profiles for every instrument type that you use. Consequently, make sure that you set
and activate all the required instrument type profiles before you start creating new
instruments. For more information, see Create an Instrument in the Domain
Explorer, page 287.

Enter Power Supply Data for Panels and Instrument Tags

This procedure explains how to enter power supply data for instrument tags that
require power supply. Although power supply data is not essential for SmartPlant
Instrumentation functionality, it is indicated for the interface with the SmartPlant
Electrical application. SmartPlant Instrumentation allows you to enter power supply
data in all panels except for junction boxes and device panels. For more information,
see Enter Power Supply Data for Panels and Instrument Tags, page 293.

Edit Instrument Tags from the Instrument Index

This option enables you to edit single and multiple instrument tags. If you want to
edit the instrument tag associated with a particular loop, use the Loop Number
Properties option. You can edit individual tags that you enter in the Enter Tag
Number dialog box or select the required tags from the Search results data window
in the Find Tag dialog box. For more information, see Edit Instrument Tags from
the Instrument Index, page 291.

Edit an Instrument Tag from the Domain Explorer

This option enables you to edit individual instrument tags. If you want to edit the tags
associated with a particular loop, use the Loop Number Properties option. You can
edit individual instrument tags that you enter in the Enter Tag Number dialog box or
select the required tags from the Search results data window in the Find Tag dialog
box. For more information, see Edit an Instrument Tag from the Domain Explorer,
page 290.

SmartPlant Instrumentation User’s Guide 285

Managing Instrument Tags: An Overview

Enter an Instrument Tag Remark

You use this option to enter a short remark to instrument tag properties in the
Instrument Index Standard Browser view. You add your tag remarks in the Rem
column. The browser view displays in the Rem column for the tags that contain
remarks. For more information, see Enter an Instrument Tag Remark, page 294.

Duplicate an Instrument Tag in the Domain Explorer

This option enables you to create a new instrument tag by duplicating the properties
of an existing one and then editing the new tag properties as required. You can create
the new duplicated instrument tag in the same <unit> as the original tag or any other
<unit> in the current domain. For more information, see Duplicate an Instrument
Tag in the Domain Explorer, page 295.

Delete Instrument Tags

This option enables you to delete one or more instrument tags that are no longer in
use. For more information, see Delete Instrument Tags, page 297.

Delete Instrument Tags in the Browse Window

This option allows you to delete more than one instrument tag at the same time in
batch mode. For more information, see Delete Instrument Tags in the Browse
Window, page 298.

Move an Instrument Tag to Another Plant Group

This option allows you to move an instrument tag to another <unit> in the same
<plant> or to a <unit> in a different <plant> in the domain. For more information,
see Move an Instrument Tag to Another Plant Group, page 298.

Move Multiple Instrument Tags in the Browser Window

This option allows you to move one or more instrument tags in the Browser View
window. You can move a tag to another <unit> in the same <plant> or to a <unit>
in a different <plant> in the domain. For more information, see Move Multiple
Instrument Tags in the Browser Window, page 299.

Rename an Instrument Tag

This option allows you to rename an existing instrument tag. For more information,
see Rename an Instrument Tag, page 299.

Change the Tag Class of an Instrument

This procedure explains how to change the tag class of an existing instrument. For
more information, see Change the Tag Class of an Instrument, page 292.

286 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Change an Instrument Type

This option allows you to change the instrument type and process function of an
instrument tag. You make this change when editing instrument tag number, this can
be done in single or multi-mode. For more information, see Change an Instrument
Type, page 302.

Add and Edit Criticality Values

This option allows you to create and customize instrument criticality values that
appear on the Criticality list in the Associate Categories and Criticality dialog box.
Tag criticality is a user-defined process classification of instruments, for example
process safety system, environmentally vital system, quality system, and so forth.
Tag categories help you select groups of tags when performing Maintenance module
procedures. For more information, see Add and Edit Criticality Values, page 304.

Add and Edit Instrument Tag Categories

This option enables you to edit the name and the description of the available
instrument tag categories>. Using this option, you can also add new categories
which you will be able to associate with instrument tags. For more information, see
Add and Edit Instrument Tag Categories, page 305.

Generate a Process Data Sheet in a Browser Window

Use this option to generate a process data sheet for a selected instrument in an
Instrument Index Standard Browser view, where a process data sheet was not
previously defined for the instrument. For more information, see Generate a Process
Data Sheet in a Browser Window, page 306.

Related Topics
• Managing Instrument Tags: An Overview, page 284

Create an Instrument in the Domain Explorer

1. Press F7 to open the Domain Explorer.
2. Expand the plant hierarchy to display the Instruments and Loops folders.
3. Do one of the following:
• To create an instrument unassociated with a loop number, right-click
the Instruments folder and on the shortcut menu click New >
Instrument.
• To create an instrument that is associated with a specific loop number,
expand the Loops folder, right click the required loop, and click New
> Instrument.
4. On the New Tag Number dialog box, do the following:

SmartPlant Instrumentation User’s Guide 287

Managing Instrument Tags: An Overview

a. From the Tag class list, select the desired tag class according to whether you
want to create a conventional, Foundation Fieldbus, HART instrument, soft
tags, Telecom tag, and so forth.
b. Type the name of the new tag. For details on instrument tag naming
conventions see Instrument Tag Naming Convention, page 284.
5. Click OK.
6. If the Select Instrument Type dialog box opens (because there is more than one
record for a given instrument type acronym), select the required instrument type
and click OK.
Tips
• If the tag name does not correspond to an existing loop name, you are
prompted to enter a loop name based on the tag you have entered. If
the loop identifier already matches an existing loop, then the new tag
name will automatically be associated with the loop.
• If the loop convention includes the loop function parameter, the
prompt will always appear. In this case, you have to complete the loop
name. If a profile exists for the selected instrument type, any new tags
for that instrument type will be created with the selected default
settings.
7. On the Loop Name dialog box, do one of the following:
• Type the loop number that the new tag is to be associated with.
• Accept the displayed loop number.
• Click Cancel to create the tag number without a loop association.
8. Click OK.
9. On the Loop Number Properties dialog box, accept the loop number properties
or modify them as required and then click OK.
Tip
• The Loop Number Properties dialog box only opens if the tag
number is associated with a loop number.
10. On the Tag Properties dialog box enter the properties as required, and click OK.
For details on entering power supply data (not available if the selected Tag Class
is electrical), see Enter Power Supply Data for Panels and Instrument Tags, page
293
Notes
• You can also create a new instrument tag in the Instrument Index module.
For more details, see Create an Instrument Tag in the Instrument Index
Module, page 289.

288 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

• When creating a new tag, you can determine whether or not process data is
required for it, and if so, at what stage the information should be entered
by a process engineer. For more details of workflow implementation, see
Workflow, page ???.
Related Topics
• Create an Instrument Tag in the Instrument Index Module, page 289
• Flow of Activities for Managing Soft Tags, page 308
• Managing Instrument Tags: An Overview, page 284

Create an Instrument Tag in the Instrument Index Module

1. To start the Instrument Index module do one of the following:

• Click .
• Click Modules > Instrument Index.
2. Do one of the following:
• Click Edit > Tag Numbers > New Tag Number.
• Click
3. On the New Tag Number dialog box, do the following:
a. From the Tag class list, select the desired tag class according to whether you
want to create, a conventional, Foundation Fieldbus, HART instrument, soft
tags, Telecom tag, and so forth.
b. Type the name of the new instrument tag. For details on instrument tag
naming conventions, see Instrument Tag Naming Convention, page 284.
4. Click OK.
5. If the Select Instrument Type dialog box opens (because there is more than one
record for a given instrument type acronym), select the required instrument type
and click OK.
Tips
• If the instrument tag name does not correspond to an existing loop
name, you are prompted to enter a loop name based on the instrument
tag name you have entered. If the loop identifier already matches an
existing loop, then the new tag name will automatically be associated
with the loop.
• If the loop convention includes the loop function parameter, the
prompt will always appear. In this case, you have to complete the loop
number. If a profile exists for the selected instrument type, any new
tags for that instrument type will be created with the selected default
settings.

SmartPlant Instrumentation User’s Guide 289

Managing Instrument Tags: An Overview

6. On the Loop Name dialog box, do one of the following:

• Type the loop number that the new tag is to be associated with.
• Accept the displayed loop number.
• Click Cancel to create the tag name without a loop association.
7. Click OK.
8. On the Loop Number Properties dialog box, accept the loop number properties
or modify them as required and then click OK.
Tip
• The Loop Number Properties dialog box only opens if the tag
number is associated with a loop number.
9. On the Tag Properties dialog box enter the properties as required and click OK.
For details on entering power supply data (not available if the selected Tag Class
is electrical), see Enter Power Supply Data for Panels and Instrument Tags, page
293.
Notes
• You can also create a new instrument tag in the Domain Explorer without
opening the Instrument Index module. For more details, see Create an
Instrument in the Domain Explorer, page 287.
• When creating a new instrument tag, you can determine whether or not
process data is required for it, and if so, at what stage the information
should be entered by a process engineer. For more details of workflow
implementation, see Workflow, page ???.

Edit an Instrument Tag from the Domain Explorer

1. On the Domain Explorer, expand your current <plant> hierarchy to display the
Instruments folder.
2. Double-click the Instruments folder to display the existing tag numbers.
3. Right-click the required tag, and from the shortcut menu select Properties .
4. On the Tag Properties dialog box enter the properties as required. For details on
entering power supply data (not available if the selected Tag Class is electrical),
see Enter Power Supply Data for Panels and Instrument Tags, page 293.
5. Click OK.
Notes
• Editing the properties of an existing tag does not affect its existing
association with a loop. For more details, see Change an Instrument Tag
Loop Association in the Domain Explorer, page 312

290 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

• The data that appears in the Prefix, Number, and Suffix fields is derived
from the tag number itself.
• You can also edit the properties of an instrument tag from the Instrument
Index module. For more details see, Edit Instrument Tags from the
Instrument Index, page 291
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Edit Instrument Tags from the Instrument Index

1. To start the Instrument Index module do one of the following:

• Click .
• Click Modules > Instrument Index.
2. Do one of the following:
• Click .
• Click Edit > Tag Numbers > Tag Number Properties.
3. On the Enter Tag Number dialog box, do one of the following:
• To edit a single tag , type the tag number in the box.
• To edit multiple tags, click Find to open the Find Tag dialog box.
Click and select the tags to be edited.
4. Click OK.
5. On the Tag Properties dialog box enter the properties as required. For details on
entering power supply data (not available if the selected Tag Class is electrical),
see Enter Power Supply Data for Panels and Instrument Tags, page 293.
6. After modifying the data, do one of the following:
• For multiple tags, click Apply > Next to continue editing. Click OK
when you have finished editing.
• For a single tag click OK.
Notes
• Editing the properties of an existing instrument tag does not affect its
existing association with a loop. For more details, see Change a Tag Loop
Association, page ???
• The data that appears in the Prefix, Number, and Suffix fields is derived
from the instrument tag itself.
Related Topics
• Managing Instrument Tags: An Overview, page 284

SmartPlant Instrumentation User’s Guide 291

Managing Instrument Tags: An Overview

Customize Tag Name

These options allow you to customize the default tag number name template that
appears in the New Tag Number dialog box.

Define new tag name template – These options determine how SmartPlant
Instrumentation displays new tag number names in the New Tag Number dialog box
in relation to the previously created tag number. The options are:

• No default – The data field in the New Tag Number dialog box will not
display any default tag, letting you enter the number you need.
• Same as the last created tag – The data field in the New Tag Number
dialog box displays the last created tag. You can accept the displayed
number, modify it, or enter the number you need.
• Same as the last created tag + 1 – The data field in the New Tag
Number dialog box displays the last created tag plus 1 (one). You can
accept the displayed number, modify it, or enter the number you need.
This option is available for numeric tag names only. If your tag number
names are not numeric, the data field in the New Tag Number dialog box
will display the last created tag.
Ignore loop creation when creating new virtual tag – Allows you to create a
virtual tag without being prompted to create a loop associated with the new virtual
tag.

Use loop suffix in tag number name – Allows you to include the loop suffix in the
name of a newly-created tag number.

Related Topics
• Instrument Tag Naming Convention, page 284
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Change the Tag Class of an Instrument

1. In the Domain Explorer, right-click an appropriate instrument.
2. On the shortcut menu, click Properties.
3. On the Tag Number Properties dialog box, click the ellipsis button next to
the Number box.
4. On the Rename Tag Number dialog box, select the tag class that you require.

Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

292 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Enter Power Supply Data for Panels and Instrument Tags

1. Do one of the following to open the Properties dialog box of a panel or tag
number:
• In the Domain Explorer or Reference Explorer, right-click a desired
panel and then click Properties.
• In the Domain Explorer or Reference Explorer, right-click a desired
instrument and then click Properties.
2. On the General tab, select the Requires power supply check box.
3. Click the Power Supply tab.
4. Under Criticality, select the criticality, which is used in SmartPlant Electrical to
determine whether the current instrument requires UPS power or regular power.
5. Under Rated voltage, select a value that indicates the voltage at which the
instrument is designed to operate.
6. If the instrument is running on alternating current, under Power supply type click
AC and do the following:
a. Under Frequency, select the operating frequency of the instrument.
b. Under Number of phases, select the number of phases in the power supply to
the instrument.
c. Under Power factor full load, enter a value between 0 and 1 for the ratio of
active to apparent power at 100% of the rated power.
7. If the instrument runs on direct current, under Power supply type, click DC.
8. Under Rated active load, type the full load power consumption in kilowatts.
9. Type the following values in amperes:
a. Full load current.
b. Starting current.
10. In the Coincidence factors group box, do one of the following:
• Under Operating mode, select Continuous, and under X –
continuous, type a value between 0 and 1.
• Under Operating mode, select Intermittent, and under Y –
intermittent, type a value between 0 and 1.
• Under Operating mode, select Spare, and under ZZ – spare, type a
value between 0 and 1
• Under Operating mode, select Standby, and under Z – stand by,
type a value between 0 and 1.

SmartPlant Instrumentation User’s Guide 293

Managing Instrument Tags: An Overview

Note
• The fields under Power distribution board data group box display data
that is determined within SmartPlant Electrical. On the Power Supply
tab, click Help for more information.
Related Topics
• Create an Instrument in the Domain Explorer, page 287
• Create an Instrument Tag in the Instrument Index Module, page 289
• Duplicate an Instrument Tag in the Domain Explorer, page 295
• Duplicate an Instrument Tag in the Instrument Index, page 296
• Edit an Instrument Tag from the Domain Explorer, page 290

Enter an Instrument Tag Remark

1. On the main menu bar, click .
2. On the Browser Manager window, expand the Instrument Index on the
Browser Groups pane and select Instrument Index Standard Browser group.
3. Ensure that the Rem. column is selected for displaying in the browser view by
doing the following:
a. Expand the Instrument Index Standard Browser group, and click .
b. Under Style settings, click Edit.
c. Scroll down the Data Field Header column to the Rem. field header and
select the View check box.
d. Click Save.
e. Close the Browser Manager window.
4. From the Instrument Index module, open the browser view, select the instrument
tag that you require, and do one of the following:
• Double-click the Rem. field.
• On the toolbar, click .
• On the Actions menu, click Remarks.
• On the selected tag, Right-click and on the shortcut menu click Tag
Number Activities > Remarks.
5. On the Remarks dialog box, type the required text in the fields provided.
6. On the Notes box, type a short note if needed.
Tip
• The text that you type in the Notes box also appears in the Tag
Number Notes dialog box.

294 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Note
• If necessary, define a custom browser view that you want to use for
displaying the remarks. For details, see Define a Standard Browser View
for the Instrument Index, page 336
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Duplicate an Instrument Tag in the Domain Explorer

1. On the Domain Explorer, expand your current <plant> hierarchy to display the
Instruments folder of the <unit> you are working on.
2. Double-click the Instruments folder to display the existing instrument tags.
3. Right-click the instrument tag you want to duplicate, and on the shortcut menu
click Duplicate.
4. Type the new instrument tag on the Duplicated Tag Number dialog box, and
then click OK.
5. If you want to duplicate the instrument tag in another <unit> of the same domain,
do the following:
a. Select the Create in another unit check box.
b. Click OK.
c. The Select Target <Unit> dialog box opens, select the target <unit> for the
new tag, and then, click OK.
6. On the Select Instrument Type dialog box, select the instrument you want to
associate with the current tag number, and then, click OK.
7. On the Loop Name dialog box, do one of the following:
• Type the loop number that you want to associate the new instrument
tag with, click OK, and then on the Loop Properties dialog box, enter
the desired data and click OK.
• Click OK to accept the displayed loop number and then on the Loop
Properties dialog box, enter the desired data and click OK.
• Click Cancel not to associate the new instrument tag with any loop.
You can associate the new tag with a loop later. For more details, see
Change an Instrument Tag Loop Association in the Domain Explorer,
page 312.
8. On the Tag Properties dialog box enter the required data or select the appropriate
values from the lists. For details about entering power supply data (not applicable
to electrical tags), see Enter Power Supply Data for Panels and Instrument Tags,
page 293.
9. Click OK.

SmartPlant Instrumentation User’s Guide 295

Managing Instrument Tags: An Overview

Tips
• You can also duplicate an instrument tag from the Instrument Index
module. For more details, see Duplicate an Instrument Tag in the
Instrument Index, page 296.
• The software does not duplicate existing calibration settings of the
source tag. If you want to define calibration settings for the duplicated
tag, the calibration profile definitions apply. These definitions exist at
the level of the instrument type.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Duplicate an Instrument Tag in the Instrument Index

1. In the Instrument Index Module window, do one of the following:

• Click .
• Click Edit > Tag Numbers > Duplicate Tag Number.
2. On the Enter Tag Number dialog box, type the instrument tag number you want
to duplicate, and then click OK.
3. To find a tag that you want to duplicate do the following:
a. On the Enter Tag Number dialog box, click Find.
b. On the Find Tag dialog box, click Find.
c. Select the instrument tag you want to duplicate, and then click OK.
4. Type the new instrument tag on the Duplicated Tag Number dialog box, and
then click OK.
5. If you want to duplicate the instrument tag in another <unit> of the same domain,
do the following:
a. Select the Create in another unit check box.
b. Click OK.
c. On the Select Target <Unit> dialog box, select the target <unit> for the new
tag and then click OK.
6. On the Select Instrument Type dialog box, select the instrument type you want
to associate with the current tag number, and then, click OK.
7. On the Loop Name dialog box, and do one of the following:
• Type the loop number that you want to associate the new instrument
tag with, and click OK.
• On the Loop Properties dialog box, type the desired data and click
OK.

296 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

• Click OK, to accept the displayed loop number.

• Click Cancel, not to associate the new instrument tag with any loop.
You can associate the new tag with a loop later. For more details, see
Change a Tag Loop Association, page ???.
8. On the Tag Properties dialog box enter the desired data or select appropriate
values from the lists. For details on entering power supply data (not applicable
for electrical tags), see Enter Power Supply Data for Panels and Instrument Tags,
page 293.
9. Click OK.
Tips
• You can also duplicate an instrument tag from the Domain Explorer.
For more details, see Duplicate an Instrument Tag in the Domain
Explorer, page 295
• The software does not duplicate existing calibration settings of the
source tag. If you want to define calibration settings for the duplicated
tag, the calibration profile definitions apply. These definitions exist at
the level of the instrument type.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Delete Instrument Tags

1. In the Domain Explorer, click the Instruments folder of the <unit> you are
working on.
2. On the Items pane, select the items you want to delete.
3. Right-click the selected items, and click Delete.
4. When prompted, click Yes to confirm deletion.

Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Delete Instrument Tags in the Instrument Index Module

1. On the Instrument Index module menu bar, click Edit > Tag Numbers > Delete
Tag Numbers.
2. On the Enter Tag Number dialog box, type the instrument tag number you want
to delete, or click Find to select one or more instrument tags.
3. On the Find Tag dialog box ,click Find and select the instrument tags you want
to delete.

SmartPlant Instrumentation User’s Guide 297

Managing Instrument Tags: An Overview

4. Click OK.
5. When prompted, click Yes to confirm deletion.

Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Delete Instrument Tags in the Browse Window

1. On the Instrument Index module, open the Instrument Index Standard Browser
view by doing one of the following:
• Click Actions > Browse Index.
• Click
2. On the Browser View window, select the instrument tags you want to delete.
3. Do one of the following:
• Right-click the selected Instrument tags, and on the shortcut menu
click Tag Number Activities > Delete Tag number.
• On the menu bar click Actions > Delete Tag Number.
4. When prompted, click Yes to confirm deletion.

Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Move an Instrument Tag to Another Plant Group

1. On the Instrument Index module menu bar, click Edit > Tag Numbers > Move
Tag Number.
2. On the Enter Tag Number dialog box, type the instrument tag number you want
to duplicate, and then click OK.
3. To find a tag that you want to duplicate do the following:
a. On the Enter Tag Number dialog box, click Find.
b. On the Find Tag dialog box, click Find.
c. Select the instrument tag you want to duplicate, and than click OK.
4. On the Select Target dialog box, select the <unit> to which you want to move
the current tag.
5. Click OK.

298 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Note
• If you move an instrument tag to a target <unit> whose tag naming
conventions are different from the naming conventions of the <unit>
where the source tag is, the software applies the target <unit> naming
conventions to the duplicated tag number.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Move Multiple Instrument Tags in the Browser Window

1. Open the Instrument Index module, by doing one of the following:
• Click Modules > Instrument Index.
• Click
2. Open an Instrument Index Standard Browser view, by doing one of the following:
• Click Actions > Browse Index.
• Click
3. Select the instrument tags you want to move.
4. Do one of the following:
• Click Actions > Move Tag Number.
• Right-click the selected tags, and from the shortcut menu click Tag
Number Activities > Move tag Number.
5. On the Select Target <Unit> dialog box, select the <unit> you want to move the
instrument tags to.
6. Click OK.
Note
• If you move an instrument tag to a target <unit> whose tag naming
conventions are different from the naming conventions of the <unit>
where the source tag is, the software applies the target <unit> naming
conventions to the duplicated tag number.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Rename an Instrument Tag

1. From the Instrument index module, do one of the following:

SmartPlant Instrumentation User’s Guide 299

Managing Instrument Tags: An Overview

• Click Edit > Tag Numbers > Tag Number Properties.

• Click
2. On the Enter Tag Number dialog box, do one of the following:
• Type the tag number you want to rename.
• Click Find, to open the Find Tag dialog box. In the Find Tag dialog
box, click Find and select the tags you want to rename.
3. If needed, on the Tag Number Properties dialog box, change the instrument type
of the tag you want to rename.
4. If you want to update the numbers of the documents associated with the current
instrument tag (specification, process data, calculation, and dimensional data
sheets), select the Update document numbers check box.
Important
• Make sure that the document number naming conventions includes
instrument naming convention segments the current tag contains. The
software does not update document numbers for which the default
naming convention is used. Suppose you want to rename a tag number
FT-100 to FT-101 and the source tag has a spec FT-100-SP. After
renaming, the default document number of the renamed instrument
specification remains as FT-100-SP, even though this number contains
the 100 segment, which was renamed for the instrument.
5. Beside to the Number field, click .
6. On the Rename Tag Number dialog box, change the tag class, edit the tag
instrument type, number, or suffix as required.
7. Click OK.
8. If the instrument type acronym is not unique, select the required instrument type
from the Select Instrument Type dialog box and click OK to open the Tag
Number Renaming Options dialog box.
9. If you want to rename the associated control system tags, do the following:
a. Select the Rename CS tag check box.
b. In the New Control System Tag data field, modify the control system tag
name as required.
c. Click OK.
10. Click OK, to close the Tag Number Properties dialog box.
Notes
• If you have connected several CS tags to the current tag number, the
system automatically assigns the same new name to all the CS tags. You
must rename the new CS tags manually to make the names unique.

300 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

• Before clicking OK, note that all the wiring items that were associated
with the old CS tag will be renamed according to the new control system
tag name, and the associated specification will be deleted. Verify whether
the appropriate loop blocks and hook-ups are associated with the new tag
number.
• Make sure that the new name complies with the naming conventions for
the current <unit>. Naming conventions do not apply to tags classed as
electrical. For more details, see Instrument Tag Naming Convention, page
284.
• For more information about instrument tag renaming options, see
Instrument Tag Renaming Options, page 301.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Instrument Tag Renaming Options

When you rename a tag, two situations are possible for changing the process function
and the instrument type of that tag:

• The Process Function has not changed— for example: renaming 108-
PT-2212 to 108-PI-2212. Renaming a tag number this way does not
change the process which the tag describes. Therefore, all the process data
information that has been associated with the old tag will be automatically
associated with the new tag. You can also delete the old process data if
required.
• The Process Function has changed— for example: renaming 108-PT-
2212 to 108-FT-2212. If you rename a tag number this way, only general
process data properties, such as pressure, temperature, and density will be
propagated from the old tag number to the new one. Process data
properties specifically associated with the tag's process function, for
example, range, alarm trip settings, upper level, and so forth, will either
not be propagated to the renamed tag or only be propagated partially. In
this case, the old tag's additional properties and calculation results will not
propagate to the new tag either.
Related Topics
• Customize Tag Name, page 292
• Instrument Tag Naming Convention, page 284
• Managing Instrument Tags: An Overview, page 284
• Rename an Instrument Tag, page 299
• Working with Tag Numbers Common Tasks, page 285

SmartPlant Instrumentation User’s Guide 301

Managing Instrument Tags: An Overview

Changing the Measured Variable

You can change the measured variable of the new loop number or keep it the same as
the source one. New tag numbers associated with the new loop number will be
affected accordingly, that is, the measured variable of the new tag numbers will
change if the measured variable of the new duplicated loop is changed. For example,
if you are duplicating Loop 101-F-102 and you change the measured variable of the
new loop to T, the new tag numbers associated with the new loop number will take a
new instrument type in accordance with the new measured variable: source Tag
Number 101-FE-102 will change to 101-TE-102.

Change an Instrument Type

1. Open the Tag Number Properties dialog box.
2. On the Tag Number Properties dialog box, do one of the following:
• From the Instrument type list, select the instrument type that you
require.
• Click to open the Instrument Type dialog box, where you can
modify the existing instrument types or add a new instrument type to
the list.
3. On the Tag Number Properties dialog box, click Apply.
Tip
• Instead of clicking Apply, you can click Rename to rename the
current tag number as required.
4. If the selected instrument type belongs to a different process function, in the Tag
Number Renaming Options dialog box do one of the following:
• Select Keep general process data to delete only specific process data
associated with the tag whose instrument type you are changing.
• Select Delete process data to delete all the process data associated
with the tag whose instrument type you are changing.
5. If you want to rename the associated control system tags, do the following:
a. Select the Rename CS tag check box.
b. On the New Control System Tag data field, modify the control system tag
name as required.
c. Click OK, to return to the Tag Number Properties dialog box.
6. On the Tag Number Properties dialog box, click OK.

302 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Notes
• If you have connected several CS tags to the current tag number, the
system automatically assigns the same new name to all the CS tags. You
must rename the new CS tags manually to make the names unique.
• Before clicking OK, note that all the wiring items that were associated
with the old CS tag will be renamed according to the new control system
tag name, and the associated specification will be deleted. Verify whether
the appropriate loop blocks and hook-ups are associated with the new tag
number.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

SmartPlant Instrumentation User’s Guide 303

Managing Instrument Tags: An Overview

Associating Tag Category and Criticality

You can associate a selected instrument with several tag categories and one
instrument criticality. You can also associate instruments that require preventive
maintenance with either Process Safety Systems or Quality Systems. For example, if
an instrument is used for custody purposes, it can be defined as a Quality System.

Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Add and Edit Criticality Values

1. To open the Criticality Values dialog box, do one of the following:
• On the Instrument Index Module window menu bar, click Tables >
Instrument Criticality.
• On the Instrument Index Standard Browser view, right-click a tag
number and on the shortcut menu, click Tag Number Activities >
Associate Categories and Criticality. Then, in the Associate
Categories and Criticality dialog box, click beside the Criticality
list arrow.
2. In the Instrument Criticality dialog box, do one of the following:
• Click New to append a new row to list of existing options and type a
criticality name and description.
• Highlight a row and edit the Criticality and Description fields.
• Highlight a row and click Delete to delete this criticality option.
3. Click OK to save the settings and close the dialog box.
Notes
• If the criticality list is long, start typing a criticality name in the Find
criticality box. In the data window, SmartPlant Instrumentation
highlights the required name as you type.
• After you delete a row, the criticality dissociates from all tags for which it
was defined. The criticality option will no longer be available in the
Associate Categories dialog box.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

304 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Add and Edit Instrument Tag Categories

1. Open an Instrument Index Standard Browser view.
2. Click Actions > Tag Categories.
3. Click New to add a new tag category row.
4. Type the desired tag category name and description.
5. To edit an existing tag category, double-click a field and type the new value.
6. To delete an existing tag category:
a. Select a tag category in the data window.
b. Click Delete to delete the highlighted category.
c. When prompted, click Yes to confirm the deletion, or click No to keep the
selected category.
7. Click OKto save the changes you made to the tag categories.

Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

Associate Tag Category and Criticality

1. Open an Instrument Index Standard Browser view.
2. In the browser view, right-click an instrument, and on the shortcut menu, click
Tag Number Activities > Associate Categories and Criticality.
Tip
• You must select a single tag (not multiple tags) to associate tag
categories and criticality.
3. To associate the desired categories with the selected tag, do one of the following:
• Drag a category from the Unassociated Categories pane to the
Associated Categories pane.
• Select a category under the Unassociated Categories pane and click
.
Tip
• You can associate the selected tag number with as many categories as
you desire. For details of how to add new categories, see Add and Edit
Instrument Tag Categories, page 305.
4. From the Criticality list, select a value to associate the current instrument with a
criticality setting.

SmartPlant Instrumentation User’s Guide 305

Managing Instrument Tags: An Overview

5. Select the Quality System (ISO) check box to associate the currently selected tag
with an ISO quality system.

Generate a Process Data Sheet in a Browser Window

1. In the browser view, select the tag numbers that you require.
2. Do one of the following:
• Right-click, and on the shortcut menu, click Generate Process Data
Sheet.
• Click, Actions > Generate Process Data Sheet.
3. In the Results dialog box, view the process data sheet creation results, and then
click Close.

Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285

306 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Incorporating Soft Tags Within an Enhanced Loop

Drawing
The Enhanced Report Utility allows you to generate loop drawings for loops that
include soft tags. For example, a loop that contains an air-conditioning system with
temperature gauges, lines, engines, compressors, and so forth. The temperature
gauges send signals to a DCS panel and from there to a computer. A software code
that functions as a thermostat, interprets the signal and sends a command to start the
engine. The compressor, connected to the engine, compresses more gas through the
lines to lower the room temperature (closed loop).

To generate an Enhanced Report Utility drawing that includes a soft tag you need to
create a symbol representing the tag using the Symbol Editor. Then you associate the
symbol with the tag in SmartPlant instrumentation, associate the tag with a loop and
generate the appropriate drawing.

Related Topics
• Create an Instrument in the Domain Explorer, page 287
• Create an Instrument Tag in the Instrument Index Module, page 289

SmartPlant Instrumentation User’s Guide 307

Managing Instrument Tags: An Overview

Flow of Activities for Managing Soft Tags

The following flow of activities allows you to create soft tags their related instrument
type, associate soft tags with loops, generate a loop drawing in Enhanced Report
utility, and edit the drawing to display the soft tags properly.
1. In the Domain Explorer, create a new loop or select an existing one, see Create a
New Individual Loop Number.
2. In the Symbol Editor create a symbol with a macro. For details, see Create a
Custom Symbol and Add a Macro to a Symbol in the Symbol Editor help. You
will later associate this symbol with a soft tag.
3. Define a new instrument type for soft tags for example, ST. For details, see
Define Instrument Type.
4. Create a new soft tag. For details, see Create an Instrument in the Domain
Explorer.
5. Set the new soft tag instrument type to ST. For details, see Instrument Type
Common Tasks.
6. To associate the custom symbol with the soft tag do one of the following:
• Associate the custom symbol with the tag instrument type, see Set a
Default Custom Symbol for Items Associated with an Instrument
Type.
• Associate a custom symbol with the specific soft tag.
7. Set the loop generation method to Custom By Loop or Custom by Signal to
allow the software to use custom symbols when generating an Enhanced Report
Utility drawing, see Loop Drawing Generation Method.
8. Generate an Enhanced Report Utility drawing for this loop, see Generate a Report
Using the Domain Explorer.
9. In the Enhanced Report Utility environment, press F7 to open the Domain
explorer.
10. Find the loop in the Domain Explorer, see Find an Item in the Domain Explorer.
11. Drag the soft tag from the Domain explorer to the drawing.
Tips
• The selected tag can also be from a different loop.
• The software automatically saves the position of the tag after you
place it.
12. Connect the soft tag to a conventional loop tag, see Attach Redlining to Drawing
Items.
13. Click File > Save Custom Changes.

308 SmartPlant Instrumentation User’s Guide

 Managing Instrument Tags: An Overview

Set a Default Custom Symbol for Items Associated with an

Instrument Type
1. On the Instrument Index module menu bar, click Tables > Instrument Types.
2. On the Instrument Type dialog box, click Profile.
3. In the General tab, on the Enhanced Report Utility Symbol group box, in the
Symbol file name and path data field, type the appropriate symbol path (or
browse to find it), and Click OK.
Related Topics

SmartPlant Instrumentation User’s Guide 309

Associating Instrument Tags with Loop Numbers: An Overview

Associating Instrument Tags with Loop

Numbers: An Overview
This section shows you how to associate instrument tags with loops. There are
several different ways that you can associate an instrument tag with a loop. You can
select a particular loop number and make a batch instrument tag association or
dissociate any tags from the selected loop as needed. Another way is to select an
instrument tag and change its loop association if it exists. You can also create a new
loop with which you want to associate a selected instrument tag and associate it with
this loop on the fly.

Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311

310 SmartPlant Instrumentation User’s Guide

 Associating Instrument Tags with Loop Numbers: An Overview

Associating Instrument Tags with Loop Numbers

Common Tasks
The following tasks are used frequently when you create and manage the loop
numbers in your plant.

Associate Multiple Tag Numbers with a Loop

This option shows you how to select an existing loop number and associate it with the
required instrument tag. You make the association using the Associate Tag Number
dialog box which displays the selected loop numbers and all the tags that are already
associated with it. You can also associate numerous instrument tags with the selected
loop. For more information, see Associate Multiple Tag Numbers with a Loop, page
311.

Change an Instrument Tag Loop Association in the Domain Explorer

This option shows you how to move a selected instrument tag that is associated with a
specific loop number to another existing loop number. You change this association
when editing an instrument tag. For more information, see Change an Instrument
Tag Loop Association in the Domain Explorer, page 312.

Change Instrument Tag Loop Associations in the Instrument Index

Standard Browser View
This option shows you how to move multiple instrument tags that are associated with
a specific loop number to another existing loop number. You change this association
when editing an instrument tag. For more information, see Change Instrument Tag
Loop Associations in the Instrument Index Standard Browser View, page 313.

Associate an Instrument Tag with a New Loop

This option shows you how to create a new loop number on the fly while editing an
instrument tag. You can then move the current instrument tag and associate it with
the new loop you created. For more information, see Associate an Instrument Tag
with a New Loop, page 313.

Dissociate an Instrument Tag from Loops

This option shows you how to dissociate instrument tags from a selected loop. For
more information, see Dissociate an Instrument Tag from Loops, page 314.

Associate Multiple Tag Numbers with a Loop

1. Start the Instrument Index module.
2. Do one of the following:

SmartPlant Instrumentation User’s Guide 311

Associating Instrument Tags with Loop Numbers: An Overview

• Click Actions > Associate.

• Click .
3. On the Enter Loop Number dialog box, do one of the following:
• Type the name of the required loop number on the Enter Loop
Number data field, and click OK.
• Click Find, to open the Find Loop dialog box. Search for a desired
loop, select it, and then click OK.
4. On the Associate Tag Number dialog box, click Find to open the Find Tag
dialog box.
5. On the Find Tag dialog box, click Find and select the tag numbers that you want
to associate with the current loop.
6. Click OK.
7. On the Associate Tag Number dialog box, under Available tag numbers, select
a tag number and click Associate. Repeat this step for every tag number that you
want to associate with the current loop.
8. Click OK, to make the association.

Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311

Change an Instrument Tag Loop Association in the Domain

Explorer
1. On the Domain Explorer, expand your current <plant> hierarchy to display the
Instruments folder.
2. Double-click the Instruments folder to display the existing tag numbers.
3. Right-click the required tag, and from the shortcut menu select Properties.
4. On the Tag Number Properties dialog box, click Associate.
5. On the Find Loop dialog box, type the required search parameters as needed and
click Find.
6. Select the loop you require in the Search results data window and click OK.
7. On the Tag Number Properties dialog box, click OK.

Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
• Duplicate an Instrument Tag in the Domain Explorer, page 295
• Duplicate an Instrument Tag in the Instrument Index, page 296
• Edit an Instrument Tag from the Domain Explorer, page 290

312 SmartPlant Instrumentation User’s Guide

 Associating Instrument Tags with Loop Numbers: An Overview

Change Instrument Tag Loop Associations in the

Instrument Index Standard Browser View
1. To start the Instrument Index module do one of the following:

• Click .
• Click Modules > Instrument Index.
2. Do one of the following:
• Click .
• Click Edit > Tag Numbers > Tag Number Properties.
3. On the Enter Tag Number dialog box, do one of the following:
• To choose a single tag, type the tag number in the box.
• To choose multiple tags, click Find to open the Find Tag dialog box,
and then click and select the desired tags.
4. Click OK, to open the Tag Number Properties box.
5. Click Associate.
6. On the Find Loop dialog box, type the desired search parameters as needed and
click Find.
7. Select the loop you require in the Search results data window and click OK.
8. If you chose one instrument tag, on the Tag Number Properties dialog box, click
OK.
9. If you chose more than one instrument tag, on the Tag Number Properties
dialog box:
a. Click Apply to save the changes.
b. Click Next to find the next tag.
c. Click Associate to associate a tag with a loop.
d. Click OK to finish.

Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
• Duplicate an Instrument Tag in the Domain Explorer, page 295
• Duplicate an Instrument Tag in the Instrument Index, page 296
• Edit an Instrument Tag from the Domain Explorer, page 290

Associate an Instrument Tag with a New Loop

1. On the Domain Explorer, expand your current <plant> hierarchy to display the
Instruments folder.

SmartPlant Instrumentation User’s Guide 313

Associating Instrument Tags with Loop Numbers: An Overview

2. Double-click the Instruments folder to display the existing tag numbers.

3. Right-click the required tag, and from the shortcut menu select Properties.
4. On the Tag Number Properties dialog box, click New Loop.
5. On the New Loop Number dialog box, type the new loop number and click OK.
6. Edit the properties of the new loop number on the New Loop Number dialog box
and click OK.
7. On the Tag Number Properties dialog box, click Associate.
8. On the Find Loop dialog box, type the required search parameters as needed and
click Find.
9. Select the loop you have just created in the Search results data window and click
OK.
10. On the Tag Number Properties dialog box, click OK.

Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311

Dissociate an Instrument Tag from Loops

1. Start the Instrument Index module.
2. Do one of the following:
• Click Actions > Associate.
• Click .
3. On the Enter Loop Number dialog box, do one of the following:
• Type the name of the required loop number on the Enter Loop
Number data field, and click OK.
• Click Find to open the Find Loop dialog box. Search for a desired
loop, select it, and then click OK.
4. On the Associate Tag Number dialog box, under Associated Tags select the tag
number you want to dissociate from the current loop.
5. Click Dissociate. Repeat steps four and five for every tag number that you want
to associate with the current loop.
6. When you have finished, Click OK.

Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311

314 SmartPlant Instrumentation User’s Guide

 Working with Typical Loops and Tags: An Overview

Working with Typical Loops and Tags: An

Overview
A typical loop is a combination of user-defined loop properties that you can use as a
template for creating loops and tags in batch mode. These properties include a loop
measured variable, loop type, loop function and so forth. This template must contain
at least one typical tag.

A typical tag is a virtual tag that is used for the creation of instrument tag numbers in
your plant. Each typical tag m