SPI Guide

SmartPlant Instrumentation
User’s Guide
Version 2007 (8.0) January 2007 DINS-08.00.0001A

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, ISOGEN, 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. Other brands and product names are trademarks of their respective
owners.
Table of Contents
Table of Contents
Preface...............................................................................................................................33
Working with SmartPlant Instrumentation..................................................................34
User Assistance.................................................................................................................35
Online Help Text Conventions ...................................................................................37
Getting Started .................................................................................................................39

Common Tasks ...........................................................................................................39
Start SmartPlant Instrumentation ...................................................................................... 40
Navigating in SmartPlant Instrumentation........................................................................ 40
Open a Different Domain.................................................................................................. 41
Change the Logon Password............................................................................................. 42
Switch to a Different Unit................................................................................................. 42
Open a Module.................................................................................................................. 43
Setting General Preferences Common Tasks .............................................................44
Display and Customize Preferences.................................................................................. 44
Preferences Governed by the .INI File.............................................................................. 45
Searching for Tag and Loop Numbers ..........................................................................46

Searching for Tag and Loop Numbers Common Tasks .............................................47
Search for All Tag Numbers ............................................................................................. 48
Use Search Parameters to Find Tag Numbers .................................................................. 49
Search for Typical Tags .................................................................................................... 52
Search for All Loop Numbers........................................................................................... 52
Use Search Parameters to Find Loop Numbers ................................................................ 53
Search for Typical Loops.................................................................................................. 55
Supporting Tables............................................................................................................56
Overview.....................................................................................................................56
Supporting Tables Common Tasks.............................................................................57
Supporting Tables in SmartPlant Instrumentation ............................................................ 58
Supporting Tables for Telecom ........................................................................................ 65
Add a New Value to a Select List ..................................................................................... 66
Customize Manufacturer-Specific Field Headers ............................................................. 67
Manage a Custom Table ................................................................................................... 67
Interface Languages.........................................................................................................68
Interface Languages Common Tasks..........................................................................69
Replace the Interface Language with a Language from the Database .............................. 70
Replace the Interface Language with a Language from an External File ......................... 70
Create a Language File with Customized Interface Text.................................................. 71
Edit Interface Text Phrases ............................................................................................... 72
SmartPlant Instrumentation User’s Guide 3

Table of Contents
Prefixes and Suffixes in the Interface Text....................................................................... 74
Revision Management .....................................................................................................75

Global Revisions: An Overview.................................................................................76
Revision Management Common Tasks ......................................................................77
Filter Items for Global Revisions...................................................................................... 78
Add Global Revisions ....................................................................................................... 79
Define Settings for Upgrading Revisions ......................................................................... 80
Update Revisions Globally ............................................................................................... 81
Upgrade Revisions Globally ............................................................................................. 82
Revision Upgrade Example .............................................................................................. 83
Delete Global Revisions ................................................................................................... 85
Add Local Revisions......................................................................................................... 86
Edit Local Revisions ......................................................................................................... 87
Delete Local Revisions ..................................................................................................... 87
View an Archived Revision .............................................................................................. 88
Report Comparison: An Overview .............................................................................89
Setting Font and Color for Report Comparison..........................................................90
Set Font And Color for Report Comparison ..................................................................... 90
Comparing Archived Reports .....................................................................................91
Compare the Currently Previewed Report With an Archived Report............................... 91
Comparing the Current Report with an Archived Report...........................................92
Viewing Archived Reports .........................................................................................93
View an Archived Report ................................................................................................. 93
Displaying Changed Documents ................................................................................94
Display a List of Changed Documents ............................................................................. 94
Workflow: An Overview ............................................................................................95
Workflow Prerequisites ..............................................................................................96
Create a Workflow Browser ............................................................................................. 96
Implementing Workflow ............................................................................................98
Enter Initial Instrument Data ............................................................................................ 98
Enter Process Data for Instrument Tags ........................................................................... 98
Enter Additional Instrument Data ..................................................................................... 99
Process Data Statuses ...............................................................................................100
Printing and Saving Documents: An Overview........................................................101
Previewing Documents.............................................................................................102
Preview a Document ....................................................................................................... 102
Printing Documents ..................................................................................................104
Print Documents ............................................................................................................. 104
Batch Printing Documents to PDF Files...................................................................105
Setting Ghostscript Batch Print Options...................................................................106
Set the Ghostscript Batch Print Options ......................................................................... 106
Setting Acrobat Distiller Batch Print Options ..........................................................107
Set the Acrobat Distiller Batch Print Options................................................................. 107
Modifying Printer Settings .......................................................................................108
Saving Documents ....................................................................................................110
Save the Current Document to a File .............................................................................. 110
4 SmartPlant Instrumentation User’s Guide

Table of Contents
Saving in DXF Format..............................................................................................111

Save a Document in DXF Format................................................................................... 111
Editing Document Headers.......................................................................................113
Edit the Headers for a Report.......................................................................................... 113
Customizing Title Blocks for Reports: An Overview ..............................................114
Requirements for Customized Report Title Blocks..................................................115
Edit Report Title Block Properties.................................................................................. 119
PSR Files ..................................................................................................................120
Viewing PSR Files....................................................................................................121
Retrieving PSR Files.................................................................................................122
Retrieve a Previously Saved PSR File ............................................................................ 122
Saving PSR File Data ...............................................................................................123
Opening PSR Files from the PSR List......................................................................124
Open a PSR File From the PSR List ............................................................................... 124
Managing the PSR File List......................................................................................125
Manage .Psr Files............................................................................................................ 125
Retrieving PBL File Reports ....................................................................................126
Retrieve a Report From a PBL File ................................................................................ 126
Adding User-Defined Fields to PSR Files................................................................127
Add User-Defined Fields to a PSR File (Using InfoMaker)........................................... 127
Viewing PSR User-Defined Fields...........................................................................129
View PSR User-Defined Fields in a Report Header ....................................................... 129
Displaying and Customizing Preferences.................................................................130
View Or Customize SmartPlant Instrumentation Preferences ........................................ 130
Preferences Governed by the .INI File .....................................................................131
Preferences Dialog Box .................................................................................................. 132
General (Preferences)...................................................................................................... 132
Instrument Index > New Tag (Preferences).................................................................... 135
Instrument Index > New Loop (Preferences).................................................................. 135
Instrument Index > Profile (Preferences)........................................................................ 136
Instrument Index > Browse (Preferences) ...................................................................... 137
Instrument Index > Duplicate (Preferences) ................................................................... 137
Instrument Index > Delete Tag (Preferences) ................................................................. 139
Instrument Index > Rename (Preferences)...................................................................... 139
Instrument Index > Tag Properties (Preferences) ........................................................... 140
Instrument Index > Move (Preferences) ......................................................................... 140
Instrument Index > Custom (Preferences) ...................................................................... 141
Specifications > General (Preferences)........................................................................... 141
Specifications > Save as Excel (Preferences) ................................................................. 144
Specifications > Export/Import (Preferences)................................................................. 145
Specifications > Custom (Preferences) ........................................................................... 145
Wiring > General (Preferences) ...................................................................................... 146
Wiring > I/O Card (Preferences)..................................................................................... 146
Wiring > I/O Assignment (Preferences) ......................................................................... 146
Wiring > CS Tags (Preferences) ..................................................................................... 147
Wiring > Copy Items (Preferences) ................................................................................ 148
Wiring > Jumpers (Preferences) ..................................................................................... 149
Wiring > Reports (Preferences) ...................................................................................... 150
Wiring > Cross Wiring (Preferences) ............................................................................. 151

Table of Contents
Wiring > Custom (Preferences) ...................................................................................... 151

Process Data > General (Preferences)............................................................................. 152
Process Data > Custom (Preferences)............................................................................. 153
Calculation > General (Preferences) ............................................................................... 153
Calibration and Maintenance > Custom (Preferences) ................................................... 154
Loop Drawings > General (Preferences) ........................................................................ 154
Loop Drawings > CAD File Locations (Preferences)..................................................... 157
Loop Drawings > Custom (Preferences)......................................................................... 158
Browser > Reports (Preferences) .................................................................................... 158
Browser > Fonts (Preferences)........................................................................................ 158
Browser > Custom (Preferences) .................................................................................... 159
Hook-Ups > General (Preferences)................................................................................. 159
Hook-Ups > CAD File Locations (Preferences) ............................................................. 162
Hook-Ups > Reports (Preferences)................................................................................. 163
Hook-Ups > Custom (Preferences)................................................................................. 164
Document Binder > General (Preferences)..................................................................... 164
Document Binder > Specification Binder (Preferences)................................................. 164
Document Binder > General Document Binder (Preferences) ....................................... 166
Document Binder > Custom (Preferences) ..................................................................... 166
Calibration and Maintenance > General (Preferences) ................................................... 166
Calculation > Custom (Preferences) ............................................................................... 168
Enhanced Reports > General (Preferences) .................................................................... 168
Enhanced Reports > Layers (Preferences) ...................................................................... 170
Enhanced SmartLoop > View (Preferences)................................................................... 170
Panel-Strip > View (Preferences) ................................................................................... 172
Wiring Equipment Connections > View (Preferences)................................................... 173
Segment Wiring > View (Preferences) ........................................................................... 174
Communication Line > View (Preferences) ................................................................... 176
Internal Cross Wiring > View (Preferences)................................................................... 177
Fieldbus Loop > View (Preferences) .............................................................................. 177
Network Class > View (Preferences).............................................................................. 179
Strip Signals > View (Preferences)................................................................................. 180
Single Speaker > View (Preferences) ............................................................................. 181
Enhanced PA Amplifier > View (Preferences)............................................................... 182
Cable Block Diagram > View (Preferences)................................................................... 183
Enhanced Reports > Hook-Ups > View (Preferences) ................................................... 184
Symbol Editor > View (Preferences) .............................................................................. 184
Enhanced Reports > Custom (Preferences) .................................................................... 184
Enhanced Reports > Drawing (Preferences)................................................................... 184
Enhanced Reports > File Locations (Preferences).......................................................... 186
Enhanced Reports > File Locations (continued) (Preferences)....................................... 187
Enhanced Reports > Fonts (Preferences) ........................................................................ 188
Enhanced Reports > Title Block (Preferences)............................................................... 188
Enhanced Reports > Connectors (Preferences)............................................................... 190
Enhanced Reports > Pagination and Revisions (Preferences) ........................................ 191
Interfaces > DCS Vendors (Preferences) ........................................................................ 191
SmartPlant > General (Preferences)................................................................................ 192
SmartPlant > To Do List (Preferences)........................................................................... 192
Claim and Merge Options (Preferences)......................................................................... 193
Report Generator (Preferences) ...................................................................................... 196
SmartPlant Instrumentation Server (Preferences)........................................................... 196

Table of Contents
Module Icons (Preferences) ............................................................................................ 197
Claiming As-Built Items in a Project ...........................................................................199
Preparing Project Items for Merging with As-Built...................................................201

Claiming and Merging Items Common Tasks..........................................................203
Display As-Built and Project Data.................................................................................. 204
Copy As-Built Items to the Claim Buffer ....................................................................... 205
Claim As-Built Items from the Domain Explorer........................................................... 206
Claim Instruments in the Browser or Instrument Index Module .................................... 207
Claim Loops, Lines, and Equipment in the Browser Module......................................... 208
Copy Items to the Merge Buffer as Merge Now............................................................. 208
Copy Items to the Merge Buffer as Release Claim......................................................... 209
Working with the SmartPlant Instrumentation Explorer .........................................211
Working with the Domain Explorer ............................................................................212

SmartPlant Instrumentation Explorer Common Tasks .............................................214
The Organization of Items in the Domain Explorer Tree View...................................... 218
Panels by Category Hierarchy Examples........................................................................ 221
Panels by Location Hierarchy Example.......................................................................... 223
Cable Hierarchy Example ............................................................................................... 223
Fieldbus Segments in the Domain Explorer ................................................................... 224
Items in the Drawing Block Types Folder ...................................................................... 224
Items in the Hook-Ups Folder......................................................................................... 226
Items in the Loops Folder ............................................................................................... 228
Association Rules in the Domain Explorer ..............................................................230
Item Status Indicators in the Domain Explorer............................................................... 234
Create an Item in the Domain Explorer .......................................................................... 235
Duplicate an Item............................................................................................................ 235
Move an Item in the Domain Explorer ........................................................................... 236
Edit Item Properties ........................................................................................................ 236
Delete Items .................................................................................................................... 236
Perform Various Actions with an Instrument ................................................................. 237
Generate a Report for an Instrument............................................................................... 237
Generate a Specification or a Process Data Sheet for an Instrument .............................. 237
Copy a Reference Item to the Domain Explorer............................................................. 238
Search for Items in SmartPlant Instrumentation Explorer .............................................. 238
Find an Item in the Tree View of an Explorer Window ................................................. 239
Filter the Display of Items According to a Specific Item Type ...................................... 240
Filter the Display of Items According to a Specific Item Name..................................... 242
Filter Cables in an Explorer Window ............................................................................. 242
Define a Filter for Pre-Assigned Device Cables ............................................................. 244
Filter Loops in an Explorer Window .............................................................................. 244
Display a Browser View in the Explorer Items Pane...................................................... 246
Add Items to My List in the Items Pane ......................................................................... 246
Define and Use a Custom View...................................................................................... 247

Table of Contents
Domain Explorer............................................................................................................248
Working with the Reference Explorer.........................................................................252

The Organization of Items in the Reference Explorer Tree View .................................. 253
Items in the Hook-Up Item Libraries Folder .................................................................. 254
Create a Reference Item.................................................................................................. 256
Copy a Reference Item to the Domain Explorer............................................................. 256
Reference Explorer ........................................................................................................257
Browser Module .............................................................................................................260

Browser Manager Overview.....................................................................................261
Browser Manager Common Tasks ...........................................................................262
Select a Default Browser ................................................................................................ 263
Define a View Profile ..................................................................................................... 264
Add a New View............................................................................................................. 265
Duplicate a View ............................................................................................................ 265
Copy a View to Another Plant ........................................................................................ 267
Modify a View Profile .................................................................................................... 267
Delete a View.................................................................................................................. 269
Find a Browser or Browser View ................................................................................... 270
Browser Manager Hierarchy........................................................................................... 271
Browser Types ................................................................................................................ 272
Instrument Index Browser Group ................................................................................... 273
Process Data and Calculation Browser Group................................................................ 275
Instrument Specifications Browser Group...................................................................... 276
Wiring Browser Group ................................................................................................... 276
Hook-Ups Browser Group .............................................................................................. 277
Loop Drawings Browser Group...................................................................................... 278
Control System Browser Group...................................................................................... 278
Dimensional Data Browser Group.................................................................................. 279
Construction and Commissioning Browser Group ......................................................... 280
Document Binder Browser Group .................................................................................. 281
Documents Browser Group............................................................................................. 281
General Browser Group .................................................................................................. 282
Telecom Browser Group................................................................................................. 282
Style Settings: An Overview ....................................................................................284
Style Settings Common Tasks ..................................................................................284
Display the Current Style Setting ................................................................................... 286
Create a View Style ........................................................................................................ 286
Clear a View Setting ....................................................................................................... 289
Modify Style Settings ..................................................................................................... 289
Structure the Print Layout............................................................................................... 292
Clear a Print Layout Structure ........................................................................................ 293
Duplicate a View Style ................................................................................................... 294
Print the Style Setting Data............................................................................................. 295
Sort Settings: An Overview ......................................................................................296
Sort Settings Common Tasks....................................................................................296

Table of Contents
Display the Current Sorting Sequence ............................................................................ 297

Create a Sorting Sequence View..................................................................................... 298
Modify a Sorting Sequence View ................................................................................... 299
Duplicate a Sorting Sequence View ............................................................................... 300
Clear a Sorting Sequence Setting.................................................................................... 301
View Filter Settings: An Overview ..........................................................................302
View Filter Settings Common Tasks........................................................................303
Display the Current View Filter Condition..................................................................... 304
Define a View Filter........................................................................................................ 305
Modify a View Filter ...................................................................................................... 306
Duplicate a View Filter................................................................................................... 307
Clear View Filter Settings............................................................................................... 308
Adding New Browsers: An Overview......................................................................309
Adding New Browsers Common Tasks ...................................................................309
Create a New Browser for SmartPlant Instrumentation.................................................. 311
Add a Form Browser....................................................................................................... 313
Add a Powersoft Browser ............................................................................................... 313
Browser Views: An Overview..................................................................................315
Browser Views Common Tasks ...............................................................................316
Open a Browser View..................................................................................................... 318
Edit Data in a Browser View .......................................................................................... 319
Modify and Save a Field Layout..................................................................................... 319
Modify Document Numbers in a Document Browser View........................................... 320
Browser View Buffer...................................................................................................... 321
Clear Data from the Buffer ............................................................................................. 322
Sort Displayed Rows....................................................................................................... 322
Count Displayed Rows ................................................................................................... 322
Refresh Displayed Data .................................................................................................. 323
Find a Value in a Specific Column ................................................................................. 323
Select Color for Read Only Fields .................................................................................. 324
Open a Module from a Browser View ............................................................................ 325
Browser Views for Instrument Index.............................................................................. 325
Browser Groups .............................................................................................................. 326
Instrument Index Module .............................................................................................328

Overview...................................................................................................................328
Managing Loop Numbers: An Overview .................................................................329
Managing Loop Numbers Common Tasks...............................................................329
Create a New Individual Loop Number.......................................................................... 331
Loop Number Naming Convention ................................................................................ 332
Duplicate a Loop Number............................................................................................... 333
Move Loop Numbers ...................................................................................................... 335
Edit Loop Number Properties from the Domain Explorer.............................................. 336
Edit Loop Properties from the Instrument Index Module............................................... 338
Edit Multiple Loop Numbers .......................................................................................... 340
Create a New Loop Number During Tag Edit ................................................................ 341
Delete Loop Numbers ..................................................................................................... 341
Rename A Single Loop Number..................................................................................... 342
Set Preference for Renaming A CAD File from A Loop Number.................................. 343

Table of Contents
Rename Multiple Loop Numbers.................................................................................... 344

Define a Functional Requirement for a Loop ................................................................. 345
Working with Instrument Types: An Overview .......................................................346
Instrument Types Common Tasks ............................................................................347
Define an Instrument Type Profile ................................................................................. 348
Define a General Process Function................................................................................. 349
Define Instrument Type Default Settings ....................................................................... 350
Define a Wiring and Controls System Instrument Type Profile ..................................... 350
Copy Instrument Type Profile Data ................................................................................ 352
Set an Alias Control System Tag .................................................................................... 352
Apply all Existing Profiles.............................................................................................. 353
Managing Instrument Tags: An Overview ...............................................................354
Working with Tag Numbers Common Tasks...........................................................354
Create an Instrument in the Domain Explorer ................................................................ 357
Create an Instrument Tag in the Instrument Index Module ............................................ 358
Instrument Tag Naming Convention .............................................................................. 360
Enter Power Supply Data for Panels and Instrument Tags ............................................. 361
Edit an Instrument Tag from the Domain Explorer ........................................................ 363
Enter an Instrument Tag Remark .................................................................................... 363
Duplicate an Instrument Tag in the Domain Explorer .................................................... 364
Duplicate an Instrument Tag in the Instrument Index .................................................... 366
Delete Instrument Tags ................................................................................................... 367
Delete Instrument Tags in the Instrument Index Module ............................................... 367
Delete Instrument Tags in the Browse Window ............................................................. 368
Move an Instrument Tag to Another Plant Group .......................................................... 368
Move Multiple Instrument Tags in the Browser Window .............................................. 369
Rename an Instrument Tag ............................................................................................. 370
Instrument Tag Renaming Options ................................................................................. 371
Changing the Measured Variable.................................................................................... 372
Change an Instrument Type ............................................................................................ 372
Add and Edit Criticality Values ...................................................................................... 373
Add and Edit Instrument Tag Categories........................................................................ 374
Generate a Process Data Sheet in a Browser Window.................................................... 374
Incorporating Soft Tags Within an Enhanced Reports Loop Drawing.....................375
Flow of Activities for Managing Soft Tags..............................................................375
Associating Instrument Tags with Loop Numbers: An Overview ...........................377
Associating Instrument Tags with Loop Numbers Common Tasks .........................377
Associate Multiple Tag Numbers with a Loop ............................................................... 378
Associate an Instrument Tag with a New Loop.............................................................. 379
Change an Instrument Tag Loop Association in the Domain Explorer .......................... 379
Change Instrument Tag Loop Associations in the Instrument Index Standard Browser
View................................................................................................................................ 380
Incorporating Soft Tags Within an Enhanced Reports Loop Drawing.....................381
Working with Typical Loops and Tags: An Overview ............................................382
Typical Loops and Tags Common Tasks .................................................................382
Create a Typical Loop..................................................................................................... 385
Duplicate a Typical Loop................................................................................................ 387
Batch Loop Creation from Typical Loops ...................................................................... 388
Verify New Loop Numbers ............................................................................................ 390
Edit a Typical Loop ........................................................................................................ 390

Table of Contents
Delete a Typical Loop..................................................................................................... 391

Edit a Typical Tag........................................................................................................... 391
Edit a Typical Tag in a Browser View............................................................................ 392
Typical Tag Naming Conventions .................................................................................. 393
Managing Lines: An Overview ................................................................................394
Working with Lines Common Tasks........................................................................394
Create a New Line .......................................................................................................... 395
Edit Line Data ................................................................................................................. 395
Create or Edit a Line Type.............................................................................................. 396
Change Type of Line ...................................................................................................... 396
Copy Line Data ............................................................................................................... 397
Delete a Line ................................................................................................................... 398
Define or Modify Pipe Specifications............................................................................. 398
Editing Data: An Overview ......................................................................................399
Edit and View Data Common Tasks ........................................................................399
Define a Standard Browser View for the Instrument Index............................................ 403
Edit a Single Row ........................................................................................................... 404
Open a Specific Supporting Table .................................................................................. 404
Find a Record in a Browser View Column ..................................................................... 405
Sort Tag Rows in a Browser View ................................................................................. 406
Edit Instrument Tag Data in Multi-Row Mode............................................................... 406
Count Instrument Tag Rows in a Browser View ............................................................ 407
View Point-to-Point Wiring Diagrams ........................................................................... 407
View Data History in a Browser View ........................................................................... 408
Set a Date Range for Field Value Changes..................................................................... 409
Track Field Value Changes............................................................................................. 409
Open a Process Data Sheet from the Browser Window.................................................. 410
Open a Specification Sheet from the Browser Window ................................................. 410
Open a Calculation Sheet from the Browser Window .................................................... 410
Display Existing Wiring Connections............................................................................. 411
Open I/O Assignment from a Browser View.................................................................. 411
Change the Process Function and Instrument Type in Batch Mode ............................... 411
Generating Documents: An Overview......................................................................413
Generating Documents Common Tasks ...................................................................413
Generate a Specification Sheet for an Instrument........................................................... 415
Generate a Process Data Sheet for an Instrument ........................................................... 415
Generate a Drawing and Revision Report....................................................................... 416
Create a List of Available Tags ...................................................................................... 416
Generate Loop Summary Reports................................................................................... 417
Generate Custom Table Reports ..................................................................................... 418
Working with External Documents: An Overview ..................................................419
Managing External Documents Common Tasks ......................................................419
Associate an External Document with Instrument Tags ................................................. 420
Open an External Document Associated with an Instrument Tag .................................. 421
Dissociate an External Document from an Instrument Tag ............................................ 421
View Associated Documents .......................................................................................... 421
Wiring in SmartPlant Instrumentation .......................................................................423

Overview...................................................................................................................423

Table of Contents
Principles of Wiring Operations in SmartPlant Instrumentation..............................424

Splitting the Wiring Design Among Several Teams ................................................425
Creating a Wiring Scheme........................................................................................427
Name and Sequence Uniqueness of Wiring Items ...................................................428
General Definitions Common Tasks ........................................................................430
Apply Naming Conventions to Wiring Items ................................................................. 430
Remove Trailing Separators From Wiring Item Names ................................................. 431
Associate a Symbol with an Item.................................................................................... 431
Creating and Managing Cables: An Overview.........................................................433
Creating and Managing Cables Common Tasks ......................................................434
Define a Cable Configuration ......................................................................................... 438
Edit a Cable Configuration ............................................................................................. 439
Delete a Cable Configuration.......................................................................................... 441
Create a Cable ................................................................................................................. 441
Create a Connector.......................................................................................................... 443
Edit Cable Properties ...................................................................................................... 444
Add a Cable Set .............................................................................................................. 445
Add a Wire to a Cable Set............................................................................................... 446
Create a Cable Without Sets and Wires .......................................................................... 447
Apply a Reference Cable to Multiple Cables Without Sets and Wires........................... 448
Apply a Reference Cable to One Cable Without Sets and Wires ................................... 449
Edit Wire Properties........................................................................................................ 449
Apply Regional Wire Colors to Project Cables .............................................................. 451
Conventional Panels: An Overview..........................................................................452
Managing Conventional Panels Common Tasks......................................................453
Create a Junction Box ..................................................................................................... 455
Create a Marshaling Rack............................................................................................... 456
Create a Cabinet.............................................................................................................. 458
Create an Unassociated Conventional Device Panel ...................................................... 459
Create a Distributed Control System (DCS) Panel ......................................................... 461
Create a Programmable Logic Controller (PLC) Panel .................................................. 463
Create a Panel with Terminals and Connectors .............................................................. 464
Enter Power Supply Data for Panels and Instrument Tags ............................................. 465
Create a Rack .................................................................................................................. 466
Create a Slot.................................................................................................................... 467
Device Panels: An Overview....................................................................................468
Principles of Creating Device Panels .......................................................................469
Managing Device Panels Common Tasks ................................................................470
Create an Instrument with an Automatically Configured Device Panel ......................... 473
Create an Instrument with a Manually Configured Device Panel................................... 475
Create an Instrument Without a Device Panel ................................................................ 477
Create Device Panels and Cables in the Instrument Index Standard Browser View ...... 479
Create Device Panels for Selected Instruments .............................................................. 480
Associate Instruments with Device Panels ..................................................................... 482
Dissociate Device Panels from Instruments.................................................................... 482
Create a Device Cable..................................................................................................... 483
Rename Device Cables in Batch Mode........................................................................... 484
Wiring Equipment: An Overview.............................................................................485
Wiring Equipment Common Tasks ..........................................................................487

Table of Contents
Customize and Use Wiring Equipment Categories......................................................... 489

Add User-Defined Wiring Equipment Category Properties ........................................... 491
Create a Wiring Equipment Item .................................................................................... 492
Hierarchy Examples of Wiring Items .......................................................................494
Create an I/O Card .......................................................................................................... 497
Create an I/O Termination .............................................................................................. 499
Customize the Controller/Processor List Header in I/O Card Properties ....................... 501
Associate an I/O card with an I/O Termination .............................................................. 502
Apparatus: An Overview ..........................................................................................504
Apparatus Common Tasks........................................................................................505
Define an Apparatus Configuration ................................................................................ 506
Create an Apparatus Group............................................................................................. 508
Add an Apparatus to an Apparatus Group ...................................................................... 509
Edit Apparatus Terminal Properties................................................................................ 510
Terminal Strips: An Overview..................................................................................511
Managing Terminal Strips Common Tasks..............................................................512
Define a Terminal Strip Configuration ........................................................................... 513
Modify a Terminal Strip Configuration .......................................................................... 515
Terminal Strip Configuration Examples ......................................................................... 516
Create a Terminal Strip................................................................................................... 518
Move a Terminal Strip to Another Parent Item .............................................................. 519
Add a Terminal to a Terminal Strip ................................................................................ 520
Add a Group of Terminals to a Terminal Strip............................................................... 521
Edit the Properties of a Terminal .................................................................................... 522
Select a Graphic for a Terminal Connection................................................................... 523
Making Connections in SmartPlant Instrumentation................................................524
Making Connections Common Tasks.......................................................................525
Define a Connection Type .............................................................................................. 527
Connection Type Examples ............................................................................................ 529
Connect a Cable or a Cable Set to a Terminal Strip ....................................................... 530
Connect Device Cables to a Terminal Strip in Batch Mode ........................................... 532
Connect a Wire to a Terminal Strip ................................................................................ 534
Move Cables, Cable Sets, and Wires .............................................................................. 535
Disconnect Cables, Cable Sets, and Wires ..................................................................... 536
Add Jumpers to the Existing Wiring............................................................................... 537
Set Preferences for Automatic Naming of Jumpers........................................................ 538
Remove a Jumper from the Existing Wiring .................................................................. 538
Assigning Wire Designation.....................................................................................539
Updating Connection Data .......................................................................................540
View Cable Connection Destinations ............................................................................. 540
Display Adjacent Connections of a Cable ...................................................................... 541
Display the Farthest Connection of a Cable.................................................................... 541
Examples of Farthest Connections of Cables ................................................................. 542
Trace a Signal in a Point-to-Point Wiring Diagram........................................................ 543
Change the Font Size of Cable and Cable Set Names .................................................... 544
Generate a Connection Report from the Connection Window ....................................... 544
I/O Assignment: An Overview .................................................................................545
Effecting I/O Assignment Common Tasks...............................................................546
Set I/O Assignment Instrument Tag Preferences............................................................ 549
Effect I/O Assignment for an Instrument........................................................................ 549

Table of Contents
Effect I/O Assignment for a Segment ............................................................................. 551

Assign an Instrument to a Channel ................................................................................. 552
Assign a Segment to a Channel ...................................................................................... 553
Create a Channel ............................................................................................................. 554
Create a Control System Tag .......................................................................................... 555
Create a Control System Tag in the Instrument Index Standard Browser View............. 556
Rename a Control System Tag ....................................................................................... 556
Couple an Instrument with a Control System Tag .......................................................... 557
Decouple an Instrument and a Control System Tag ....................................................... 557
Delete a Control System Tag .......................................................................................... 558
Filter the Display of Data in the I/O Assignment Window............................................. 558
Cancel I/O Assignment ................................................................................................... 559
Generate an I/O Tag Assignment Report........................................................................ 560
View and Edit Channel Data........................................................................................... 560
Find I/O Channels for Assignment ................................................................................. 562
Control System Tag Propagation .................................................................................... 563
Cross Wiring.............................................................................................................564
Cross Wiring Connections Common Tasks..............................................................564
Perform Manual Cross Wiring........................................................................................ 566
Perform Semiautomatic Cross Wiring ............................................................................ 568
Set Cross Wiring Preferences ......................................................................................... 570
Perform Automatic Cross Wiring ................................................................................... 571
Create a Cross Wiring Cable........................................................................................... 573
Generate a Panel Strip Report from the Cross Wiring Window ..................................... 574
Auto-Wiring..............................................................................................................575
Defining and Executing Auto-Wiring Tasks: An Overview ....................................576
Flow of Activities for Auto-Wiring..........................................................................578
Auto-Wiring Connections Common Tasks ..............................................................579
Pre-Assign Junction Boxes to Device Panels ................................................................. 580
Auto-Wire Pre-Assigned Junction Boxes ....................................................................... 581
Auto-Wire Two Panels ................................................................................................... 583
Auto-Wire Control Systems............................................................................................ 585
Auto-Wire Control Systems Connected to Pre-Assigned Junction Boxes...................... 587
Auto-Wiring Task Statuses ............................................................................................. 590
Change an Auto-Wiring Task Status .............................................................................. 590
Signal Propagation....................................................................................................591
Possible Cases of Signal Propagation ............................................................................. 592
Tag Signal Propagation Common Tasks ..................................................................594
Re-Propagate a Tag Signal.............................................................................................. 596
Force Signal Propagation................................................................................................ 596
Propagate a Tag Signal Manually ................................................................................... 597
Automatically Propagate a Signal from a Non-Wiring Instrument ................................ 598
Create a Local Tag Signal............................................................................................... 599
Filter the Local Signal Dialog Box ................................................................................. 599
Create a General Signal .................................................................................................. 600
Link Tag Signals to a General Signal ............................................................................. 601
Multiplex Tag Signals..................................................................................................... 602
De-Multiplex Tag Signals............................................................................................... 603
Intrinsic Safety Calculations Common Tasks...........................................................604
Create an Intrinsically Safe Circuit Type........................................................................ 605

Table of Contents
Manage Intrinsic Safety Circuit Types ........................................................................... 605

Calculate Intrinsic Safety................................................................................................ 606
Define Tag Numbers for Intrinsic Safety Loop Calculation........................................... 607
Define Circuit Cables for Intrinsic Safety Loop Calculation.......................................... 608
Calculate Intrinsic Safety for a Loop .............................................................................. 609
Cable Routing: An Overview ...................................................................................610
Cable Routing Flow of Activities .............................................................................611
Cable Routing Common Tasks.................................................................................612
Set Cable Routing Options.............................................................................................. 614
Customize Cable Routing Terminology ......................................................................... 615
Manage Standard Widths................................................................................................ 616
Manage Standard Positions............................................................................................. 616
Set the Maximum Number of Cables for the Standard Positions ................................... 617
Create a Routing Section ................................................................................................ 617
Edit a Routing Section .................................................................................................... 618
Associate a Routing Section with Cables ....................................................................... 619
Edit a Cable Routing....................................................................................................... 619
Copy Routing Data to Another Cable ............................................................................. 620
Append Routing Data to a Cable .................................................................................... 621
Cable Drums .............................................................................................................623
Cable Drums Common Tasks...................................................................................624
Create and Manage a Pulling Area ................................................................................. 626
Associate Cables with a Pulling Area ............................................................................. 626
Define Cable Drum Attributes for Cable Types ............................................................. 627
Manage Cable Drums Manually ..................................................................................... 628
Assign Cables to Drums Automatically (with Optimization) ......................................... 630
Assign Cables to Drums Manually (Without Optimization)........................................... 630
Managing Panel Locations: An Overview................................................................631
Managing Panel Locations Common Tasks .............................................................631
Define a New Panel Location ......................................................................................... 632
Modify Panel Location Properties .................................................................................. 632
Change the Location of a Panel ...................................................................................... 633
Dissociate a Panel from a Location ................................................................................ 633
Delete a Panel Location .................................................................................................. 633
Location Manager ........................................................................................................... 634
Generating Wiring Reports Common Tasks.............................................................635
Generate a Connection Report from the Connection Window ....................................... 636
Generate a Panel Strip Report from the Cross Wiring Window ..................................... 636
Generate an I/O Tag Assignment Report........................................................................ 636
Generate Panel-Strip Reports as PDF Files .................................................................... 637
Display Channels and Wiring Equipment in Panel-Strip Reports .................................. 637
Cable Block Diagrams: An Overview ......................................................................638
Cable Block Diagram Common Tasks .....................................................................638
Create a Cable Block Diagram ....................................................................................... 639
Add Cables and Objects to an Existing Cable Block Diagram....................................... 641
View an Existing Cable Block Diagram ......................................................................... 642
Disconnect Cables from Items in a Cable Block Diagram ............................................. 642
Remove Items from a Cable Block Diagram .................................................................. 643
Foundation Fieldbus Design..........................................................................................644

Table of Contents
Flow of Activities for Foundation Fieldbus Design .................................................645

Preliminary Definitions for Foundation Fieldbus Common Tasks...........................649
Define Segment-Wide Parameters .................................................................................. 651
Spur Cable Lengths Example.......................................................................................... 653
Working with Function Blocks: An Overview.........................................................654
Create a User-Defined Function Block........................................................................... 655
Associate Function Blocks with Instrument Types......................................................... 656
Manage the Functions Blocks Supporting Table ............................................................ 657
Working with the Fieldbus Tag Numbers Browser: An Overview ..........................658
Managing Fieldbus Instruments Common Tasks .....................................................659
Define Foundation Fieldbus and Profibus Instrument Type Profiles.............................. 660
Create Foundation Fieldbus and Profibus Instruments ................................................... 661
Associate Function Blocks with Instruments.................................................................. 664
Fieldbus Tag Numbers.................................................................................................... 664
Managing Segments Common Tasks .......................................................................665
Create a Foundation Fieldbus Segment .......................................................................... 666
Edit the Properties of a Foundation Fieldbus Segment................................................... 667
Associate an Instrument with a Segment ........................................................................ 668
Dissociate an Instrument from a Segment ...................................................................... 668
Change Instrument / Segment Association ..................................................................... 669
Delete a Fieldbus Segment.............................................................................................. 669
Enable a Function Block for I/O Assignment................................................................. 670
Change the View in the Fieldbus Tag Numbers Browser............................................... 670
Managing Fieldbus Cables Common Tasks .............................................................671
Create a Home-Run Cable .............................................................................................. 671
Create a Spur Cable ........................................................................................................ 672
Fieldbus Plug-and-Socket Boxes: An Overview ......................................................673
Managing Fieldbus Panels (Plug-and-Socket Boxes) Common Tasks ....................674
Create a Plug-and-Socket Device Panel.......................................................................... 675
Create a Plug-and-Socket Junction Box.......................................................................... 676
Edit the Properties of a Plug-and-Socket Device Panel .................................................. 676
Edit the Properties of a Plug-and-Socket Junction Box .................................................. 677
Working with Terminators: An Overview................................................................678
Managing Terminators Common Tasks ...................................................................678
Create an External Terminator in a Plug-and-Socket Box.............................................. 680
Create an External Terminator on a Terminal Strip........................................................ 680
Create an Internal Terminator......................................................................................... 681
Move an External Terminator to Another Port in a Plug-and-Socket Box ..................... 681
Terminator (Plug-and-Socket Box) — Segment Association....................................... 682
Terminator (Terminal Strip) — Segment Association.................................................. 682
Fieldbus Bricks: An Overview .................................................................................683
Managing Fieldbus Brick Assemblies and Apparatuses Common Tasks ................684
Create a Fieldbus Brick Assembly.................................................................................. 685
Configure a Fieldbus Apparatus ..................................................................................... 687
Making Connections and Associations for Fieldbus Common Tasks ......................689
Define or Edit a Connector Type .................................................................................... 691
Define or Edit a Connector Type Pin Configuration ...................................................... 691
Delete a Connector Type ................................................................................................ 692
Create a Connector.......................................................................................................... 692

Table of Contents
Assign Connector Pins to Cable Wires ........................................................................... 693

Associate a Pin or a Terminal with a Channel ................................................................ 694
Delete a Connector.......................................................................................................... 694
Connect a Home-Run Cable to a Plug-and-Socket Box ................................................. 695
Associate a Segment with a Home-Run Cable ............................................................... 696
Managing Fieldbus I/O Cards and I/O Assignment Common Tasks .......................697
Create a Fieldbus I/O Card ............................................................................................. 698
Effect Fieldbus I/O Assignment...................................................................................... 700
Fieldbus Validation: An Overview...........................................................................701
Fieldbus Validation Common Tasks ........................................................................703
Generate a Validation Report for One Segment ............................................................. 704
Generate a Validation Report for Multiple Segments..................................................... 704
Generate a Validation Report for Multiple Segments from the Fieldbus Tag Numbers
Browser........................................................................................................................... 705
Generate a Segment Wiring Report ................................................................................ 706
Profibus Design: An Overview .....................................................................................707

Flow of Activities for Profibus Design.....................................................................708
Profibus Design Common Tasks ..............................................................................710
Create a Profibus DP Segment........................................................................................ 711
Create a Profibus PA Segment........................................................................................ 711
Associate Profibus PA Instruments with a PA Segment................................................. 712
Associate Profibus DP Instruments with a DP Segment................................................. 712
Create a DP-Compatible PLC or DCS Panel .................................................................. 713
Associate a PLC or DCS Panel with a Profibus DP Segment......................................... 713
Generate an Enhanced Profibus Layout Report.............................................................. 714
Profibus DP Segment Properties..................................................................................... 714
Working with HART Instruments: An Overview ......................................................715

Flow of Activities for HART Instrumentation .........................................................716
Define Instrument Type Profiles for HART Instruments ............................................... 717
Create a HART Instrument ............................................................................................. 718
Create a Virtual Digital Tag............................................................................................ 720
Create an I/O Card Compatible with HART Instruments............................................... 720
Effect I/O Assignment for HART Instruments ............................................................... 721
Fieldbus and Conventional Multi-Input Devices ........................................................723

Overview...................................................................................................................723
Managing Multi-Input Devices Common Tasks ......................................................724
Create a Plug-and-Socket Multi-Input Device Panel ...................................................... 726
Create a Multi-Input Device Panel with Terminal Connections..................................... 727
Create a Multi-Input Instrument with Plug-and-Socket Connections for a Fieldbus
Segment .......................................................................................................................... 728
Create a Multi-Input Instrument with Terminal Connections for a Fieldbus Segment... 730
Create a Multi-Input Instrument with Plug-and-Socket Connections for a Serial Loop
Interface .......................................................................................................................... 732
Create a Multi-Input Instrument with Terminal Connections for a Serial Loop
Interface .......................................................................................................................... 734

Table of Contents
Telecom Design...............................................................................................................736
Overview...................................................................................................................736
Flow of Activities for Telecom Design ....................................................................737
Arrangement of Telecom Items in the SmartPlant Instrumentation Explorer..........739
Supporting Tables for Telecom ...................................................................................... 741
Working with Old Equipment......................................................................................... 743
Creating and Managing Telecom Devices and Cables Common Tasks...................744
Set Telecom Device Type Profile Defaults..................................................................... 746
Create a Telecom Field Tag............................................................................................ 747
Duplicate a Telecom Field Tag....................................................................................... 748
Create a Telecom Conventional Field Device ................................................................ 749
Create a Telecom Plug-and-Socket Field Device ........................................................... 750
Create a Telecom Cable .................................................................................................. 751
Creating and Managing Telecom Panels Common Tasks........................................752
Create a Telecom Junction Box ...................................................................................... 753
Create a Splice Panel ...................................................................................................... 754
Create a Distribution Frame............................................................................................ 755
Create a Patch Panel........................................................................................................ 756
Managing Equipment Cabinets and Equipment Items Common Tasks ...................757
Create a PA Cabinet........................................................................................................ 760
Create an Amplifier......................................................................................................... 761
Add a Connector to an Amplifier.................................................................................... 762
Create a PABX Cabinet .................................................................................................. 762
Create a PABX Rack ...................................................................................................... 763
Create a Switch ............................................................................................................... 764
Add a Connector to a Switch .......................................................................................... 765
Add a Switch Port ........................................................................................................... 765
Create a Switch Channel................................................................................................. 766
Create and Associate a Telephone Number .................................................................... 766
Create an Unassociated Telephone Number ................................................................... 767
Associate a Telephone Number with a Channel ............................................................. 768
Create a Miscellaneous Cabinet...................................................................................... 768
Create a Hub Cabinet ...................................................................................................... 769
Create Hub Equipment.................................................................................................... 770
Create a Hub Connector.................................................................................................. 771
Add a Port to a Hub ........................................................................................................ 771
Create an Intercom Cabinet ............................................................................................ 772
Add Intercom Equipment................................................................................................ 773
Add an Intercom Connector............................................................................................ 774
Generating Telecom Reports Common Tasks..........................................................775
Generate a Communication Line Report ........................................................................ 776
Generate a Speaker Load Report .................................................................................... 777
Generate a Telecommunication Device List................................................................... 777
Generate a Telecom Device Type Report ....................................................................... 778
Generate a Telecom Line Number Report ...................................................................... 778
Generate a Telecom Field Equipment Report................................................................. 778
Generate a Telecom Signal Level Report ....................................................................... 779
Generate an Actual Load Report..................................................................................... 779

Table of Contents
Specifications ..................................................................................................................780
Overview...................................................................................................................780
Principles of Generating Specifications....................................................................781
Specification General Operations Common Tasks...................................................783
Generate Instrument Specs in Batch Mode..................................................................... 784
Open a Spec from the Instrument Index Standard Browser View .................................. 785
Open a Spec from the Specifications Module................................................................. 785
Create a Tag Number in the Specifications Module ....................................................... 786
Add Expanded Notes and Remarks ................................................................................ 787
Delete Specs in Batch Mode ........................................................................................... 787
Ways of Defining a Spec Document Number................................................................. 788
Specification Pages: An Overview ...........................................................................789
Managing Spec Pages Common Tasks.....................................................................790
Open a Page .................................................................................................................... 792
Open a Page from an External File ................................................................................. 793
Display Data Field Names .............................................................................................. 793
Display a List of Forms that Include the Current Page................................................... 794
Regenerate Pages ............................................................................................................ 794
Save a Page to the Database............................................................................................ 794
Save a Page as an External File ...................................................................................... 795
Delete a Page .................................................................................................................. 795
Create a Large Note Page ............................................................................................... 796
Select a Different Process Function for a Page............................................................... 798
Set the Tab Order of the Fields on a Page....................................................................... 799
Switch to the Default Tab Order ..................................................................................... 799
Retrieve Custom Pages as PSR Files .............................................................................. 800
Working with Page Graphics Common Tasks..........................................................801
Add a Line to a Page....................................................................................................... 802
Set Precise Position and Length of a Line ...................................................................... 803
Modify Line Position and Length Using Arrow Keys .................................................... 803
Modify Line Position and Length Using the Mouse....................................................... 804
Change Line Properties................................................................................................... 804
Duplicate Page Lines ...................................................................................................... 805
Add Graphics to a Page................................................................................................... 806
Set Precise Position and Size of Page Objects................................................................ 807
Modify Position and Size of Page Objects Using the Mouse ......................................... 808
Modify Position and Size of Page Objects Using Arrow Keys ...................................... 808
Customizing Pages Common Tasks .........................................................................809
Edit Field Headers .......................................................................................................... 812
Display Invisible Fields .................................................................................................. 813
Define Fields with Computed Values ............................................................................. 813
Display Revision Changes for Spec Properties............................................................... 814
Format Field Values........................................................................................................ 815
Add Data Fields to a Page............................................................................................... 816
Associate User-Defined Views ....................................................................................... 817
Duplicate Data Fields in a Page ...................................................................................... 818
Delete Data Fields........................................................................................................... 818
Add Custom Fields of Wiring Equipment Items ............................................................ 819
Add Function Block Custom Fields to a Fieldbus Spec ................................................. 819

Table of Contents
Spec Forms: An Overview........................................................................................821

Spec Forms Common Tasks .....................................................................................822
Create a Form.................................................................................................................. 824
Edit Form Properties ....................................................................................................... 825
Add Pages to an Existing Form ...................................................................................... 826
Remove a Page from a Form .......................................................................................... 827
Sort Pages Within Forms ................................................................................................ 828
Define Form Browser Fields........................................................................................... 828
Display a List of Pages Included in a Form .................................................................... 829
Delete a Form.................................................................................................................. 829
Restore Library Forms .................................................................................................... 830
Regenerate Library Forms .............................................................................................. 830
Change the Form Assignment of a Spec......................................................................... 830
Change Form Assignment for a Batch of Specs ............................................................. 831
Form Data Templates: An Overview........................................................................832
Form Data Template Common Tasks.......................................................................833
Create and Modify a Form Data Template ..................................................................... 833
Delete a Form Data Template ......................................................................................... 834
Single-Tag Specs: An Overview ..............................................................................835
Single-Tag Specs Common Tasks ............................................................................836
Generate a Single-Tag Spec............................................................................................ 837
Notes for Editing a Single-Tag Spec .............................................................................. 838
Edit Manufacturers and Models in a Spec ...................................................................... 839
Move a Single-Tag Spec to a Multi-Tag Spec................................................................ 840
Generate a Spec for a Complex Analyzer....................................................................... 841
Process Data Case Specs: An Overview...................................................................842
Process Data Case Specifications Common Tasks...................................................843
Generate a Spec for Multiple Process Data Cases .......................................................... 844
Generate a Hybrid Case Spec ......................................................................................... 845
Multi-Tag Specs: An Overview................................................................................846
Multi-Tag Specs Common Tasks .............................................................................847
Generate a Multi-Tag Spec ............................................................................................. 849
Add a Single Instrument Tag to a Multi-Tag Spec ......................................................... 850
Add Instrument Tags to a Multi-Tag Spec in Batch Mode............................................. 851
Edit See List Data in a Multi-Tag Spec .......................................................................... 851
Change the Master Tag Definition.................................................................................. 852
Search for a Specific Tag in a Multi-Tag Spec............................................................... 852
Change the Font Size of See List Column Headers ........................................................ 853
Move a Tag to Another See List ..................................................................................... 853
Move a Tag from See List to a Single-Tag Spec ............................................................ 854
Remove a Tag from a Multi-Tag Spec............................................................................ 855
Generate a Spec for an Analyzer Stream ........................................................................ 856
Multi-Tag Spec Formats: An Overview ...................................................................857
Formats Common Tasks ...........................................................................................857
Create a Format............................................................................................................... 858
Modify a Format ............................................................................................................. 860
Delete a Format............................................................................................................... 861
Regenerate Formats ........................................................................................................ 862
Change the Format for a Multi-Tag Spec ....................................................................... 862
Define Multi-Tag Spec Print Layout .............................................................................. 862

Table of Contents
Non-Instrument Specs: An Overview.......................................................................864

Non-Instrument Specs Common Tasks ....................................................................865
Prerequisites for Generating a Non-Instrument Spec ..................................................... 866
Generate a Non-Instrument Spec .................................................................................... 867
Generate a Functional Requirement Spec....................................................................... 868
Composite Specifications: An Overview..................................................................869
Composite Spec for Multiple Instruments: Generation Workflow ................................. 871
Composite Spec for Instrument with Cases: Generation Workflow............................... 873
Loop Composite Spec: Generation Workflow................................................................ 875
Remove an Instrument from a Composite Spec.............................................................. 877
Remove a Section from a Composite Page..................................................................... 877
Spec Title Blocks: An Overview ..............................................................................878
Title Block in a Multi-Tag Spec ..................................................................................... 879
Spec Title Block Common Tasks .............................................................................880
Customize a Title Block in InfoMaker ........................................................................... 881
Assign a Title Block to a Form ....................................................................................... 882
Modify a Custom Title Block ......................................................................................... 883
Update Custom Title Blocks After Version Upgrade ..................................................... 883
Copying Specification Data: An Overview ..............................................................885
Copying Specification Data Common Tasks............................................................886
Protect Fields from Overwriting When Copying Data ................................................... 887
Copy Data to a Form Data Template from a Spec .......................................................... 887
Copy Data to a Spec from a Form Data Template .......................................................... 889
Copy Data from One Spec to Another ............................................................................ 890
Spec Revisions: An Overview ..................................................................................891
Revision and Data Comparison Common Tasks ............................................................ 892
Manage Spec Revisions Locally ..................................................................................... 893
Manage Spec Revisions Globally ................................................................................... 894
View and Print Spec Revisions....................................................................................... 895
Compare Current Data with a Saved Revision ............................................................... 896
Compare Current Data with a Saved Spec...................................................................... 896
View Data History .......................................................................................................... 897
Change Storage Method of Specification Revisions....................................................... 898
Delete Spec Revisions..................................................................................................... 899
Save, Export, and Import Options: An Overview.....................................................900
Save, Export, and Import Options Common Tasks ..................................................901
Save a Spec in PSR Format ............................................................................................ 902
Save an Instrument Spec in ISF Format.......................................................................... 903
Save Instrument Specs in Batch Mode ........................................................................... 903
Save an Instrument Spec in Excel Format ...................................................................... 904
Batch Save of Instrument Specs in Excel Format........................................................... 904
Protect Fields Before Exporting Specs to External Editor.............................................. 905
Import Data to a Specification from an External File ..................................................... 906
Import Data to Instrument Specs in Batch Mode............................................................ 907
Save as Excel: An Overview ....................................................................................908
Customizing Specs for Save as Excel Common Tasks ............................................910
Guidelines for Customizing Pages for Save as Excel ..................................................... 912
Guidelines for Customizing PSR Files for Save as Excel .............................................. 914
Create an Invisible Vertical Zero Line............................................................................ 916
Replace Double Lines with Thick Single Lines.............................................................. 917

Table of Contents
Correct a Line Discontinuity........................................................................................... 917

Correct Horizontal and Vertical Divergence of Grid Lines ............................................ 918
Set Value Display Precision for Save as Excel Globally................................................ 918
Set Value Display Precision for Individual Fields.......................................................... 919
Save as Excel Troubleshooting.................................................................................920
Resolve Spec Accessing Problem in a Common Excel File ........................................... 922
Remove the Protection from a Spec Saved as Excel ...................................................... 923
Resolve a Data Saving Problem...................................................................................... 923
Resolve Grid Line Overlap Problems ............................................................................. 923
Correct Undershooting and Overshooting of Grid Lines................................................ 924
Prevent Truncation of Labels and Values ....................................................................... 925
Fix Displaced Labels....................................................................................................... 925
Fix Text Display in Excel Cells ...................................................................................... 927
Fix Function Conversion Problems ................................................................................ 927
Set Value Display Precision............................................................................................ 928
Fix Display of Vertical Fields......................................................................................... 928
Fix Display of Select Lists.............................................................................................. 929
Prepare Problematic Excel Files for Intergraph Support ................................................ 929
Specification Report List ..........................................................................................930
Printing Specifications and Reports Common Tasks ...............................................933
Print a Specification Report ............................................................................................ 934
Generate Reports by Date ............................................................................................... 935
Generate a Report for a Selected Field Name................................................................. 935
Assign User-Defined Headers for Spec Form Field Reports .......................................... 936
Print the Currently Open Specification........................................................................... 937
Print Specs into PDF Files .............................................................................................. 937
Pipe Specs: An Overview .........................................................................................939
Pipe Specs Common Tasks.......................................................................................940
Define or Modify Pipe Specs.......................................................................................... 941
Assign Pipe Specs to Instruments ................................................................................... 942
Assign Pipe Specs to Lines ............................................................................................. 943
Associate Pipe Specs with Sub-Libraries........................................................................ 944
Display Pipe Specs Assigned to a Hook-Up Item Sub-Library ...................................... 945
Dissociate a Pipe Spec from Lines.................................................................................. 946
Delete Pipe Specs............................................................................................................ 947
Document Binder Module .............................................................................................948

Overview...................................................................................................................948
Specification Binder Packages .................................................................................949
General Document Binder Packages ........................................................................950
Starting the Document Binder Module.....................................................................951
Start the Document Binder Module ................................................................................ 951
Creating Binder Packages.........................................................................................952
Create a New Binder Package......................................................................................... 952
Assigning Instrument Specifications to a Specification Binder Package.................953
Assign an Instrument Specification to a Specification Binder Package ......................... 953
Editing Binder Package Properties ...........................................................................954
Edit Binder Package Properties ...................................................................................... 954
Removing Instrument Specifications from a Specification Binder Package............955

Table of Contents
Remove a Single Instrument Specification From a Specification Binder Package ........ 955
Remove a Selection of Instrument Specifications From a Specification Binder
Package ........................................................................................................................... 956
Remove All Instrument Specifications From a Specification Binder Package............... 956
Deleting a Binder Package........................................................................................957
Delete a Binder Package ................................................................................................. 957
Managing Association of External Files with a Binder Package .............................958
Associate an External File With a Binder Package......................................................... 958
Open an External File That You Associated With a Binder Package............................. 958
Dissociate an External File From a Binder Package....................................................... 958
Notes .........................................................................................................................959
Creating Form Note Templates ................................................................................960
Create a Form Note Template......................................................................................... 960
Editing Form Note Templates ..................................................................................961
Edit a Form Note Template............................................................................................. 961
Deleting Form Note Templates ................................................................................962
Delete a Form Note Template......................................................................................... 962
Creating Form Notes.................................................................................................963
Create a Form Note......................................................................................................... 963
Assigning General Notes to Binder Packages ..........................................................965
Assign a General Note to a Binder Package ................................................................... 965
Editing Binder Package Notes ..................................................................................966
Edit a Note ...................................................................................................................... 966
Specification Binder Package Revisions ..................................................................967
Adding a Revision to a Binder Package ...................................................................969
Add a Revision to a Binder Package............................................................................... 969
Deleting a Revision from a Binder Package.............................................................971
Delete a Revision From a Binder Package...................................................................... 971
Binder Package Revision Archive: An Overview ....................................................972
Converting Binder Package Revisions to ZIP Files .................................................973
Convert Binder Package Revisions to .Zip Format Files................................................ 973
Change Summary Report..........................................................................................974
Enabling Specification Changes Notification...........................................................975
Modifying Specification Change Notifications Manually........................................976
Modify the Change Notification of a Specification ........................................................ 976
Printing from a Binder Package................................................................................977
Print Documents in a Binder Package............................................................................. 977
Printing from a Binder Package to a PDF File .........................................................979
Print From a Binder Package to a PDF File.................................................................... 979
Saving Binder Package Documents to a ZIP File.....................................................981
Save From A Binder Package To A .Zip File ................................................................. 981
Displaying Binder Package Properties .....................................................................983
Display the Properties of a Binder Package.................................................................... 983
Troubleshooting........................................................................................................984
Loop Drawings Module .................................................................................................987

Overview...................................................................................................................987
Blocks in SmartPlant Instrumentation: An Overview ..............................................988

Table of Contents
Shipped Block Files ........................................................................................................ 991

Add a Block Type ........................................................................................................... 993
Add a Block to a Block Type.......................................................................................... 993
View a Drawing Block in a CAD Application ............................................................... 994
Define Insertion Points for Blocks.................................................................................. 995
Copy Blocks to Another <Plant>.................................................................................... 996
Associate a Loop Block .................................................................................................. 997
Associate Instrument Blocks Automatically (via Instrument Type)............................... 998
Change the Block Assignment Method from Automatic to Manual............................... 999
Associate Instrument Blocks Manually ........................................................................ 1000
Update Block Assignments........................................................................................... 1001
Copy Associated Blocks to Other Instrument Tags ...................................................... 1002
Copy Automatically Assigned Blocks to Tags of Other Loops.................................... 1003
Assign an Instrument Block to a Drawing Page ........................................................... 1004
Dissociate Blocks from Instruments ............................................................................. 1005
Specify Border and Logo Blocks for Loop Drawings .................................................. 1006
Assign General Blocks to All Loop Drawings via Instrument Type ............................ 1006
Updating Loop Drawing Properties: An Overview ................................................1008
Set the Date Format in CAD Loop Drawings ............................................................... 1009
Define a Drawing as a Multi-Drawing.......................................................................... 1010
Define a Drawing as a Multi-Page Drawing................................................................. 1011
Modify Properties of a Single-Page Drawing ............................................................... 1012
Maintain CAD Loop Drawing Revisions...................................................................... 1012
Maintain Document References.................................................................................... 1014
Make CAD Drawing Approvals ................................................................................... 1015
Modify Loop Drawing Identifying Information ........................................................... 1015
Update Paths for CAD Drawings and Block Files........................................................ 1016
Update Paths for Existing CAD Drawings And Block Files ........................................ 1016
Associating an External CAD Drawing ........................................................................ 1017
View an External CAD Drawing .................................................................................. 1017
CAD Loop Drawing Generation: An Overview.....................................................1018
Loop Drawing Generation Methods: An Overview ...............................................1020
CAD Settings for SmartPlant Instrumentation.............................................................. 1021
Sample Loop Drawing (After Generation) ................................................................... 1021
Apply Loop Drawing Generation Method .................................................................... 1022
Generate CAD Loop Drawings..................................................................................... 1023
Show the Latest Generated CAD Drawing ................................................................... 1025
Display CAD Loop Drawing Generation History......................................................... 1025
Delete CAD Loop Drawing Generation History........................................................... 1027
Clear Previous Macro Result Records .......................................................................... 1027
Loop Drawing Reports ...........................................................................................1028
Generate a Report of CAD Loop Drawing Generation Errors...................................... 1028
Macros in SmartPlant Instrumentation: An Overview ...........................................1029
SmartPlant Instrumentation Macro Structure .........................................................1031
Loop Title Block Macros........................................................................................1032
Wiring Module Macros - Conventions ...................................................................1034
Generate a Macro Report .............................................................................................. 1036
Using Macros in CAD Blocks: An Overview ........................................................1037
Insert Macros in an AutoCAD Drawing Block............................................................. 1039
Customizing Macro Definitions: An Overview......................................................1040

Table of Contents
Create a New Macro Definition.................................................................................... 1041

Delete a Macro Definition ............................................................................................ 1042
Working with User-Defined Macro Functions: An Overview ...............................1043
Standard Functions ....................................................................................................... 1045
Create a User-Defined Macro Function ........................................................................ 1046
Modify a User-Defined Macro Function ...................................................................... 1047
Delete a User-Defined Macro Function ........................................................................ 1048
Using External Macro Data Sources: An Overview...............................................1049
External Macro Naming Conventions ....................................................................1050
External Macro Structure Conventions ..................................................................1051
Connecting to an External Data Source..................................................................1052
Prerequisites for Connecting to a dBase ODBC Profile.........................................1053
Connecting to an ODBC Profile .............................................................................1054
Connect to an ODBC Profile ........................................................................................ 1054
Connecting to Database Platforms Other Than ODBC ..........................................1055
Connect to Database Platforms Other Than ODBC...................................................... 1055
Assigning an External Macro Data Source.............................................................1056
Assign an External Macro Data Source to One or More Loop Numbers ..................... 1056
Hook-Ups in SmartPlant Instrumentation ................................................................1057

Hook-Up Items: An Overview................................................................................1058
Hook-Up Item Libraries and Sub-Libraries: An Overview....................................1059
Managing Hook-Up Items and Libraries Common Tasks......................................1060
Create an Item Library .................................................................................................. 1062
Create User-Defined Sub-Libraries .............................................................................. 1063
Set an Item Library As the Active Item Library ........................................................... 1064
Create a Hook-Up Item................................................................................................. 1064
Create Hook-Up Items in Batch Mode ......................................................................... 1065
Sort Hook-Up Items in a Sub-Library........................................................................... 1066
Associate Items with User-Defined Sub-Libraries ....................................................... 1066
Remove Items from a User-Defined Sub-Library......................................................... 1067
Delete Hook-Up Items .................................................................................................. 1068
Delete Hook-Up Sub-Libraries ..................................................................................... 1069
Managing Hook-Ups Common Tasks ....................................................................1070
Create a Hook-Up Type ................................................................................................ 1072
Create Hook-Ups .......................................................................................................... 1072
Associate Hook-Up Types with Instrument Types ....................................................... 1073
Associate Instrument Tag Numbers with Hook-Ups .................................................... 1074
Move Hook-Ups to Another Hook-Up Type ................................................................ 1075
Associate Hook-Ups with a Sub-Library ...................................................................... 1075
Associate Items with Hook-Ups ................................................................................... 1076
Dissociate Items from Hook-Ups.................................................................................. 1077
Dissociate Tag Numbers from Hook-Ups..................................................................... 1078
Delete Hook-Ups .......................................................................................................... 1079
Delete Hook-Up Types ................................................................................................. 1079
Hook-Up Drawing Generation: An Overview........................................................1080
Managing Hook-Up Drawings Common Tasks .....................................................1082
Apply a Drawing Generation Method to Hook-Ups..................................................... 1084
Set Default Generation Method for Hook-Up Drawings .............................................. 1084

Table of Contents
Edit Hook-Up Drawing Identifying Fields ................................................................... 1085

Make Approvals for Hook-Up Drawings...................................................................... 1086
Maintain Hook-Up Drawing Revisions ........................................................................ 1086
Add Document References in Hook-Up Drawings....................................................... 1087
Assign Border and Logo Blocks to Hook-Up Drawings .............................................. 1088
Update Paths for Hook-Up Drawings and Block Files ................................................. 1089
Generate CAD Hook-Up Drawings .............................................................................. 1090
Generate Enhanced Hook-Up Drawings....................................................................... 1092
Generate Hook-Up Drawings in Mixed Mode.............................................................. 1093
Create a New Macro Definition.................................................................................... 1094
Delete a Macro Definition ............................................................................................ 1095
Hook-Up Reports: An Overview ............................................................................1096
Hook-Up Reports Common Tasks..........................................................................1098
Generate a Bill of Material ........................................................................................... 1099
Sort Data in a Bill of Material....................................................................................... 1100
Generate a Hook-Up Item List Report.......................................................................... 1100
Generate a Hook-Up Tag List Report ........................................................................... 1101
Open Reports by Selecting Document Numbers .......................................................... 1101
Maintenance Module ...................................................................................................1102

Performing Breakdown Maintenance .....................................................................1103
Starting the Maintenance Module...........................................................................1105
Start the Maintenance Module From Any SmartPlant Instrumentation Module .......... 1105
Start the Maintenance Module From an Instrument Index Browser View ................... 1105
Filtering Maintenance Activities ............................................................................1106
Filter Maintenance Activities........................................................................................ 1106
Generating Maintenance Reports ...........................................................................1108
Generate a Maintenance Report.................................................................................... 1108
Preventive Maintenance Preliminary Activities .....................................................1109
Access Rights in the Maintenance Module ............................................................1110
Defining Preventive Maintenance Attachments .....................................................1111
Define a Preventive Maintenance Attachment.............................................................. 1111
Defining Preventive Maintenance Tasks ................................................................1112
Define a Preventive Maintenance Task ........................................................................ 1112
Defining Preventive Maintenance Activities..........................................................1113
Define a Preventive Maintenance Activity ................................................................... 1113
Scheduling Maintenance.........................................................................................1115
Schedule Maintenance .................................................................................................. 1115
Extending Existing Scheduling...............................................................................1117
Extend the Existing Scheduling of Maintenance .......................................................... 1117
Entering Preventive Maintenance Details ..............................................................1118
Enter Preventive Maintenance Details.......................................................................... 1118
Performing Preventive Maintenance ......................................................................1120
Issuing a New Work Request .................................................................................1122
Issue a New Work Request ........................................................................................... 1122
Opening a Work Request........................................................................................1123
Open an Existing Work Request................................................................................... 1123
Creating Repair Forms............................................................................................1125
Create a New Repair Form ........................................................................................... 1125

Table of Contents
Filling Out Repair Forms........................................................................................1126

Fill Out a Repair Form.................................................................................................. 1126
Maintenance Event Records: An Overview ...........................................................1127
Flow of Activities for Defining a Project Administrator........................................1128
Set a Date Format for Maintenance Event Record Names ........................................... 1129
Create a Maintenance Event Record............................................................................. 1130
Complete a Maintenance Event Record........................................................................ 1131
Calibration Module......................................................................................................1132
Calibration Flow of Activities ................................................................................1133
Starting the Calibration Module .............................................................................1134
Start the Calibration Module......................................................................................... 1134
Accessing Calibration Windows.............................................................................1134
Access a Calibration Window....................................................................................... 1134
Searching for Tag Numbers in the Calibration Module .........................................1135
Search For Tag Numbers In The Calibration Module .................................................. 1136
Copying Existing Process Data ..............................................................................1139
Copy Existing Process Data.......................................................................................... 1139
Defining Calibration Settings .................................................................................1140
Define Calibration Settings........................................................................................... 1140
Defining General Calibration Settings....................................................................1141
Define General Calibration Settings ............................................................................. 1141
Defining Alarm / Trip Settings ...............................................................................1142
Define the Alarm / Trip Settings................................................................................... 1142
Defining the Set Point.............................................................................................1143
Define the Set Point ...................................................................................................... 1143
Clearing the Calibration Ranges.............................................................................1144
Clear the Calibration Ranges ........................................................................................ 1144
Managing Action Codes .........................................................................................1144
Manage Action Codes................................................................................................... 1144
Managing Damage Codes.......................................................................................1145
Manage Damage Codes ................................................................................................ 1145
Managing Diagnostic Codes...................................................................................1146
Manage Diagnostic Codes ............................................................................................ 1146
Managing Result Codes..........................................................................................1147
Manage Result Codes ................................................................................................... 1147
Managing Test Equipment Data .............................................................................1148
Manage Test Equipment Data....................................................................................... 1148
Entering Calibration Data .......................................................................................1150
Enter Calibration Data .................................................................................................. 1150
Selecting Test Equipment .......................................................................................1152
Select Test Equipment .................................................................................................. 1152
Loop Error Calculation: An Overview ...................................................................1153
Loop Error Calculation Common Tasks.................................................................1154
Calibration Error Calculations................................................................................1155
Setting Tags for Loop Error Calculation ................................................................1156
Set Tags for Loop Error Calculation............................................................................. 1156
Calculating Loop Error ...........................................................................................1158

Table of Contents
Calculate the Loop Error............................................................................................... 1158

Maintaining Calibration History.............................................................................1160
Deleting a Calibration Result Entry........................................................................1161
Delete a Calibration Result Entry ................................................................................. 1161
Viewing and Modifying Calibration Results..........................................................1162
View Or Modify the Calibration Results ...................................................................... 1162
Calibration Reports ....................................................................................................... 1163
Generating Calibration Reports ..............................................................................1164
Generate Calibration Reports........................................................................................ 1164
Generating Calibration History Reports .................................................................1165
Generate Calibration History Reports........................................................................... 1165
Working with the Fluke Interface...........................................................................1166
Downloading Data from SmartPlant Instrumentation ............................................1167
Uploading Data from the Fluke Calibrator.............................................................1169
Process Data Module ...................................................................................................1170

Process Data Principles...........................................................................................1171
Start the Process Data Module...................................................................................... 1171
Select a New Process Data Status ................................................................................. 1172
Custom Fields ............................................................................................................... 1172
Opening an Instrument Tag in the Process Data Module ............................................. 1172
Create an Instrument Tag in the Process Data Module................................................. 1173
Open an Instrument Tag in the Process Data Module .................................................. 1173
Define Basic Process Data for an Instrument Tag ........................................................ 1174
Edit Instrument Process Data........................................................................................ 1175
Modify Instrument Base Conditions.......................................................................1176
Copy Instrument Process Data from Another Instrument............................................. 1177
Propagating Line Process Data to an Instrument Tag ............................................1178
Propagate Process Data From the Current Line to the Current Instrument .................. 1178
Propagate Process Data From Any Line to the Current Instrument.............................. 1178
Batch Propagation of Line Data to Instrument Tags ..............................................1179
Propagate Line Data to a Batch of Instrument Tags ..................................................... 1179
Setting the Line-to-Tag Filter .................................................................................1180
Select Line Properties ................................................................................................... 1180
Process Data for Differential Pressure Instruments................................................1181
Define Process Data for a Differential Pressure Instrument ......................................... 1181
Delete Instrument Process Data .................................................................................... 1181
Calculating Physical Properties ..............................................................................1182
Calculate the Properties of a Selected Material ............................................................ 1182
Add a New Line Type................................................................................................... 1183
Edite a Line Type.......................................................................................................... 1183
Change the Line Type................................................................................................... 1183
Delete a Line Type........................................................................................................ 1184
Add a New Line ............................................................................................................ 1184
Modify Line Properties ................................................................................................. 1185
Duplicate a Line............................................................................................................ 1186
View Line Process Data................................................................................................ 1186
Editing Line Process Data - Selecting Pipe Standards.................................................. 1187
Editing Line Process Data - Fluid ................................................................................. 1188

Table of Contents
Copy Line Data from One Line to Another .................................................................. 1188

Delete Line Process Data .............................................................................................. 1189
Line Fluid Velocity ....................................................................................................... 1189
Multiple Process Data Cases ..................................................................................1190
Creating Process Data Cases ..................................................................................1191
Enable Cases for the Current Tag Or Line.................................................................... 1191
Add a Case for the Current Tag Or Line....................................................................... 1191
Set a Governing Case.................................................................................................... 1192
Manage the Cases Supporting Table............................................................................. 1193
Delete a Process Data Case........................................................................................... 1194
Process Analyzers...................................................................................................1195
Flow of Activities for Complex Analyzers.............................................................1196
Managing Line Component Tables ........................................................................1197
Manage the Fluid Components Supporting Table ........................................................ 1197
Create A Line Components Table For The Current Line ............................................. 1197
Define a Complex Analyzer.......................................................................................... 1198
Link Analyzer Stream Components with Line Components ........................................ 1199
Add an Insulation Type................................................................................................. 1199
Enter and Edit a Pipe or Orifice Material ..................................................................... 1200
Defining or Modifying Pipe Specs .........................................................................1201
Create a New Pipe Spec Or Modify an Existing One ................................................... 1201
Delete Pipe Specs.......................................................................................................... 1201
Set the Default Units of Measure.................................................................................. 1202
API 2540 Standard for Liquid Density Calculation...................................................... 1202
Calculate Liquid Density According to the API 2540 Standard ................................... 1203
Convert Engineering Units of Measure Automatically................................................. 1204
Copy Default Units of Measure from Another <Unit>................................................. 1204
Import Process Data Files ............................................................................................. 1205
Import Line Process Data Files..................................................................................... 1206
Exporting Process Data Files..................................................................................1207
Export Instrument Process Data Files........................................................................... 1207
Export Line Process Data Files..................................................................................... 1207
Principles of Generating Process Data Reports ......................................................1209
Generating a Process Data Report for One Instrument or Line..............................1209
Generate a Process Data Report for the Current Instrument Or Line ........................... 1210
Generate Line Reports .................................................................................................. 1210
Generate Instrument Reports ........................................................................................ 1211
Viewing and Editing Process Data Revisions ........................................................1212
Work With External Process Data Revisions ............................................................... 1212
View Process Data History ........................................................................................... 1213
Calculation Module......................................................................................................1215
Overview.................................................................................................................1215
Start the Calculation Module ........................................................................................ 1215
Viewing and Editing a Calculation Item ................................................................1216
Open a Process Data Sheet for Calculation .................................................................. 1216
Fluid Definition ......................................................................................................1217
Define the Fluid ............................................................................................................ 1217
Performing Calculations .........................................................................................1219

Table of Contents
Preparing for Flowmeter Calculation .....................................................................1219

Prepare for Flowmeter Calculation ............................................................................... 1220
Orifice Flowmeter Calculation ...............................................................................1221
Calculate Orifice Flowmeter Parameters ...................................................................... 1221
Tube Flowmeter Calculation ..................................................................................1223
Calculate Tube Flowmeter Parameters ......................................................................... 1223
Restriction Device Calculation ...............................................................................1225
Calculate the Restriction Device Parameters ................................................................ 1225
Calculating a Relief Valve......................................................................................1227
Calculate a Relief Valve ............................................................................................... 1227
Calculating a Relief Valve in Case of Fire .............................................................1229
Size a Relief Valve in Case of Fire ............................................................................... 1229
Calculating a Control Valve ...................................................................................1230
Calculate a Control Valve............................................................................................. 1230
Calculating a Thermowell.......................................................................................1233
Calculate the Maximum Permissible Thermowell Length............................................ 1233
Performing a Batch Calculation..............................................................................1234
Perform a Batch Calculation ......................................................................................... 1234
Calculating Multiple Cases.....................................................................................1236
Calculate Multiple Cases .............................................................................................. 1236
Creating a Hybrid Case...........................................................................................1237
Create A Hybrid Case ................................................................................................... 1237
Principles of Generating Calculation Item Reports ................................................1238
Generating Calculation Item Reports .....................................................................1238
Generate a Calculation Item Report.............................................................................. 1238
Calculation Revisions .............................................................................................1240
Maintain Calculation Revisions.................................................................................... 1240
Create a New Tag in the Calculation Module............................................................... 1241
Recommended Control Valve Characteristic .........................................................1242
Calculate the Recommended Control Valve Characteristic.......................................... 1242
Entering Built-Up Back Pressure - Relief Valve....................................................1243
Take Built-Up Back Pressure Into the Calculation Account ........................................ 1243
Select a New Process Data Status ................................................................................. 1243
Custom Fields ............................................................................................................... 1244
Dimensional Data for Piping Module.........................................................................1245

Principles of the DDP Module................................................................................1246
Start the DDP Module................................................................................................... 1247
Preliminary Procedures...........................................................................................1247
Define the Process Connection Class / Rating.............................................................. 1247
Define a Process Connection End Preparation ............................................................. 1248
Additional Settings........................................................................................................ 1248
Define a Dimensional Group ........................................................................................ 1249
Define Dimensional Group Properties.......................................................................... 1250
Duplicate a Dimensional Group.................................................................................... 1251
Assigning Dimensional Data Forms.......................................................................1251
Assign a PSR File to a Dimensional Data Form........................................................... 1251
Assign a Dimensional Data Form to a Dimensional Group.......................................... 1251

Table of Contents
Associate an Instrument Type with a DDP Group........................................................ 1252

Managing Vendor Data...........................................................................................1253
Display and Access Vendor Data ................................................................................. 1253
Enter Vendor Data ........................................................................................................ 1254
Enter Vendor Data ........................................................................................................ 1255
Managing Working Data ........................................................................................1256
Display And Access Working Data .............................................................................. 1256
Edit Working Data ........................................................................................................ 1257
Enter the Piping Design Area ....................................................................................... 1258
Copy Working Data to Default Data ............................................................................ 1258
Copy Default Data to Working Data ............................................................................ 1259
Copy from Vendor Data to Working Data.................................................................... 1260
Modify Working Data Status ........................................................................................ 1261
Managing Default Dimensional Data .....................................................................1263
Enter Default Data Into the Default Library ................................................................. 1263
Edit Default Dimensional Data ..................................................................................... 1264
Customizing the Default Library Display and Layout.................................................. 1264
Generate a Dimensional Data Sheet.............................................................................. 1265
Track the Working Data Status History........................................................................ 1265
Generating DDP Reports ........................................................................................1266
Generate A Suspected Data List, Status History, Or Suspected Data History Report.. 1267
Printing Dimensional Data Sheets ..........................................................................1268
Print Dimensional Data Sheets From the Dimensional Data for Piping Module
Window......................................................................................................................... 1268
Print Dimensional Data Sheets From the Working Data Window ............................... 1268
Print Empty Sheet Forms .............................................................................................. 1269
Construction Module ...................................................................................................1270

Construction Flow of Activities..............................................................................1270
Definitions in the Construction Module .................................................................1271
Installation Index Category Definitions..................................................................1272
Edit an Installation Index Category .............................................................................. 1272
Edit an Installation Index .............................................................................................. 1273
Delete an Installation Index .......................................................................................... 1273
Viewing and Modifying Assigned Installation Indexes .........................................1274
Modify Assigned Installation Indexes .......................................................................... 1274
Construction Options .................................................................................................... 1275
Construction - Example Scenario ................................................................................. 1275
Selecting and Viewing Current Installation Indexes..................................................... 1276
View Installation Indexes on the Installation Indexes Dialog Box............................... 1277
Adding Installation Indexes....................................................................................1277
Add an Installation Index.............................................................................................. 1277
Adding an Installation Index Category...................................................................1279
Define a New Installation Index Category.................................................................... 1279
Assign Installation Indexes to Items ............................................................................. 1280
Generating Reports .................................................................................................1281
Construction Module Revisions .............................................................................1282
Add New Construction Module Revisions ................................................................... 1282
Maintaining a Revision Archive.............................................................................1283

Table of Contents
Viewing and Editing Archives................................................................................1284

View an Archived Installation Index ............................................................................ 1284
SmartPlant Instrumentation KKS .............................................................................1286

Overview.................................................................................................................1286
Requirements for Importing Line Data in KKS Mode ................................................. 1290
Propagation of KKS Names in SmartPlant Instrumentation ..................................1291
Example of KKS Naming Propagation......................................................................... 1292
Scope of KKS Issues for the Current SmartPlant Instrumentation Version...........1294
Rename an Item in KKS Mode...............................................................................1296
Index..............................................................................................................................1297

Preface
Preface
This user's guide describes concepts, procedures, and interface features of SmartPlant
Instrumentation.
Send documentation comments or suggestions to [email protected].

1

Working with SmartPlant Instrumentation
Working with SmartPlant Instrumentation

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 39

User Assistance
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 Assistance
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.
• 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.

User Assistance
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 keys Combinations of keys can be used as shortcuts. For example, Ctrl
+ F1 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.
Home, End,
Page Up, Page
Down
Arrow keys Use these keys to move between fields in data tables.
Numeric keypad If you have an extended keyboard, you can type numbers with the
numeric keypad if you press Num Lock key to turn the Num Lock
indication on.

User Assistance
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.
The appearance of the mouse pointer varies depending on its location:
Pointer symbol Description

I The I-beam appears when the
pointer is over a text field and
shows the text insertion point.
These pointers appear in the
File: C:\TEMP\SmartWrite\Wircurs.png NOT
Wiring module when selecting
FOUND. File: C:\TEMP\SmartWrite\Wire.png NOT
a cable, set or wire respectively
FOUND.
to connect to terminals.
File: C:\TEMP\SmartWrite\HRGLASS.png NOT The hourglass pointer indicates
FOUND. that the application is
processing information and
user operations are temporarily
disabled.

Getting Started
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 Operating owner, 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 40.
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 41.
Change the Logon Password

This option allows you to change the password that you use when logging on to
SmartPlant Instrumentation. For more information, see Change the Logon Password,
page 42.
Switch to a Different Unit

This option makes it possible to switch from the current <unit> to another <unit>.
For more information, see Switch to a Different Unit, page 42.
Open a Module
You can open any SmartPlant Instrumentation 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 43.

Getting Started

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 and where the domain type is Operating owner, 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.
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 40
• Working with SmartPlant Instrumentation: An Overview, page 34
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.

Getting Started
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 41
• Switch to a Different Unit, page 42
• Working with the SmartPlant Instrumentation Explorer: An Overview,
page 211

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 Operating owner),
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
page 211

Getting Started

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.
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

3. On the Open dialog box, expand the <plant> and <area> hierarchies and
navigate to the <unit> you require.

• Click the <unit> once to highlight it, and then click OK.
Related Topics

Getting Started

page 211
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
page 211

Getting Started
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 Operating owner. For more information, see Display
and Customize Preferences, page 44.
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 45.

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
more information, see Preferences Governed by the .INI File, page 45.
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 44

Getting Started

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. This only applies to
a small number of windows and dialog boxes.
The 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. The
next time you start SmartPlant Instrumentation and display the Open dialog box, the
software displays the <unit> you selected last.
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.
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>.
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.
Related Topics

Searching for Tag and Loop Numbers

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
238.
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 238
• Searching for Tag and Loop Numbers Common Tasks, page 47

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 48.
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 52.
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 49.
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 52.

Use Search Parameters to Find Loop Numbers

This help topic explains how to find loop numbers by entering search parameters.
Entering search parameters in the Find Loop dialog box enables you to narrow down
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 53.
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 55.
Related Topics
• Searching for Tag and Loop Numbers: An Overview, page 46

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


Important
• To specify search parameters in the Calibration module, you need to
perform a separate procedure. For details, see Search for Tags in the
Calibration Module, page 1135.
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 Parameter Explanation Example
Tag Number Type the whole tag number 101-FT – 2225/1
you are looking for.
Include any prefix, suffix, Or use a wildcard:
and separator characters. 101-FT%
You can use wildcards if
needed.
Process function Select a process function to Flow
narrow your search to tags Pressure
belonging to the selected
process function.. (This
parameter is available in
the Instrument Index and
Process Data modules
only.)
Instrument type Select an instrument type D/P Type Flow Element
to narrow your search to (FE), Mass Flow
tags belonging to the Transmitter (FT)
selected instrument type.
Status Select a tag status to An existing device, a new
narrow your search to tags instrument, a relocated
associated with the selected device
status.
Location Select a tag location, for Equipment room, junction
example, Field, to narrow box
your search to tags for
which you have defined
this location.


I/O type Select a I/O type to narrow AO (analog output)
your search to tags for DI (Digital input)
this I/O type.
Prefix Type the tag number prefix 101
to find all the tag 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.
Number Type the numeric segment 2315
of a tag number to find all
the tag numbers that have
this numeric segment. You
can also use wildcards if
needed.
Suffix Type the suffix segment of 1 ( the number following
the tag number to find all the slash ( / ) in tag number
the tags that contain this 101-FT – 2225/1)
suffix. Do not type the
slash ( / ) character. You
can also use wildcards if
needed.
Equipment Select equipment to narrow
your search to tags for
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 number Select a specification form
number to narrow 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
5. In the Search results data window, do one of the following:
• Select the desired tag number.
• 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


Important
• This option is available 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
5. Select the desired tag numbers in the Search results data window and click OK.
Related Topics

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.
3. Select the required loop numbers in the Search results data window and click
OK.
Related Topics


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)


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.
display more loop rows. Clear this check box to return to normal
view.
5. Click OK.
Related Topics


You perform the search in the Instrument Index module.
Using the Typical Loop Management dialog box:
• Click Edit > Typical Loop Management.

Using the Batch Loop Creation dialog box:
1. Click Edit > Typical Loop Management.
2. Click Find.
3. In the Find Typical Loop dialog box, do not enter any search parameters and
click Find.
In the Find Tag dialog box:
1. From the Tag class list, select Typical.
2. Click Find and select a tag number.
3. In the Typical Tag Number Properties dialog box, click Associate.
4. In the Find Loop dialog box, click Find to list all the available typical loops in
the Search results data window.
Related Topics

Supporting Tables
Supporting Tables
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 58.
For details about the various activities that you can perform with the supporting
tables, see Supporting Tables Common Tasks, page 57.
Related Topics
• Supporting Tables Common Tasks, page 57

Supporting Tables
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 66.
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 67.
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 67.
Related Topics
• Supporting Tables in SmartPlant Instrumentation, page 58
• Supporting Tables: An Overview, page 56

Supporting Tables
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.
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.

Supporting Tables

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.

Supporting Tables

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
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.

Supporting Tables

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
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.

Supporting Tables

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
Wire Types Allows you to manage the contents of the Type list on the Wire
Wire Colors Allows you to manage the contents of the Color list on the Wire

Supporting Tables

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.

Supporting Tables

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 <plant>.
The pulling area in the <plant> 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 <plant>
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
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 57.
• For the explanation of instrument types and their functionalities, see
Working with Instrument Types: An Overview, page 346.
• For the supporting tables used in Telecom, see Supporting Tables for
Telecom, page 65.
Related Topics

Supporting Tables
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
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.

Supporting Tables
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
Related Topics

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
• Define Foundation Fieldbus and Profibus Instrument Type Profiles,
page 660
• Working with Instrument Types: An Overview, page 346

Supporting Tables

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.
5. Repeat steps 3 and 4 as many times as you require.
6. Click OK.
Related Topics
• Conventional Panels: An Overview, page 452
• Customize the Controller/Processor List Header in I/O Card
Properties, page 501
• Managing Conventional Panels Common Tasks, page 453

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

Interface Languages
Interface Languages
You can replace the SmartPlant Instrumentation interface language. The System
Administrator must first add languages to the database. You can purchase each
language as a separate add-in. 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
• German
• Custom
After the appropriate interface language is added, you can do the following:
• Replace the existing interface language with the imported language.

• Edit interface text phrases.
• Define new phrases to replace existing ones.

Interface Languages
Interface Languages Common Tasks

The following tasks are used frequently when working with interface languages:
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 70.
Replace the Interface Language with a Language from an External File

Use this procedure 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, a change that improves the performance. For
more information, see Replace the Interface Language with a Language from an
External File, page 70.
Create a Language File with Customized Interface Text

An external language file enables you to replace the text in the current interface with
your customized text. To create customized phrases, you use a special interface
language called Custom. After switching to the custom language, all the phrases in
this column replace the original phrases of the interface language without overwriting
them. Empty fields in this column do not affect the original phrases. This way you
can always revert to the original phrases of the interface language. For more
information, see Create a Language File with Customized Interface Text, page 71.
Edit Interface Text Phrases

This procedure allows you to change the interface text by editing its phrases. At this
stage, you change the phrases of the interface language, as described in the overview.
Note that the interface text changes take effect only after exiting and re-entering the
application. For more information, see Edit Interface Text Phrases, page 72.
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 74.
Related Topics
• Interface Languages: An Overview, page 68

Interface Languages
Replace the Interface Language with a Language from the

Database
1. Start SmartPlant Instrumentation or the Administration module.
2. Click Tools > Select Language.
3. In the Select Language dialog box, do one of the following:
• From the Language data window, select the language with which you
want to replace the current interface language.
• Click Default to revert the language to the default language (English).
• 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.
5. Click OK to close the dialog box and change the interface language.
Related Topics
• Interface Languages Common Tasks, page 69
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.
3. Select Optimize speed.
4. Select Use file to retrieve the interface text from a previously saved file (saved in
.psr format), and 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.

Interface Languages
5. 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.
Related Topics

Important
• The System Administrator must first add the required language to the
database.
• The interface text changes take effect only after exiting and re-entering
the application.
2. Click Tools > Edit Translation Text.
• Click Open to navigate to the language file that contains the interface
text.
• Click Retrieve to retrieve the interface text from the database.
4. In the Custom Phrase column, type the phrases you want.
Tips
• The column header Custom Phrase changes to German Phrase if
you imported the German language, and to French Phrase if you
imported the French language.
• In the Custom Phrase column, each phrase that you type replaces the
corresponding phrase in the interface text. If you leave a field blank,
the corresponding field in the interface text remains unchanged. Make
sure that you add the same prefixes, suffixes and punctuation marks
that appear in the corresponding original phrases of that interface
language for example, ~, &. For details, see Prefixes and
Suffixes in the Interface Text, page 74.

Interface Languages
5. To view the changes, switch to the appropriate language. For details, see Replace
the Interface Language with a Language from the Database, page 70.
Tip
• After the changes are saved, you are prompted to restart SmartPlant
Instrumentation for the changes to take effect.
6. Click Save File to save the edited interface text to a language file (a file with a
.psr extension).
7. Type the path and filename of the language file or navigate to an existing
language file.
8. Click OK in the displayed message and restart SmartPlant Instrumentation or the
Administration module for the changes to take effect.
9. Click OK to save the changes and return to the Edit Translation Text dialog
box.
10. Click Close.
Related Topics

Important
database. You can purchase a language that you require as a separate
add-in.
• If you edit the phrases of an interface language that you have
previously imported, you will not be able to revert to the imported
interface language.
• When editing, make sure that you fill all the fields in the appropriate
column. If you have a field blank, the phrase from the previous
interface language remains after you switch the currently displayed
language to the language that you are editing now. This can result in
your interface text containing phrases or terms in more than one
language.
text.

Interface Languages
4. Edit the text by clicking the text in the appropriate field.

Tip
• You can modify the column sequence, for example, you can compare
phrases more easily by moving two columns closer together. Drag a
column header and drop it in the desired location. Then, 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.
5. To view the changes, replace the active language with the language that you have
edited. For details, see Replace the Interface Language with a Language from the
Database, page 70.
Tip
.psr extension).
language file.
box.
10. Click Close.
Related Topics

Interface Languages

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 MS Word). It is text]
usually used in conjunction
with ~n.
~t Adds a tab entry. [interface &Action~tCtrl+A
text]~t[interface
text]
Related Topics

Revision Management
Revision Management
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 Report Utility 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. For more information about using revisions in an
integrated environment, see Revising Documents in an Integrated Environment: An
Overview, page .
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.

Revision Management
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.
Related Topics
• Revision Management Common Tasks, page 77
• Revision Management: An Overview, page 75

Revision Management
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 79.
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 80.
Update Revisions Globally

You can update the existing revision values globally for the items used in the
Ups, Wiring, and Dimensional Data. For more information, see Update Revisions
Globally, page 81.
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 82.
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 85.
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 78.

Revision Management
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 86.
Edit Local Revisions

Use this procedure to edit existing local revisions. For more information, see Edit
Local Revisions, page 87.
Delete Local Revisions

Use this procedure to delete existing local revisions. For more information, see
Delete Local Revisions, page 87.
Related Topics
• Global Revisions: An Overview, page 76

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.

Revision Management
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. Click Refresh to update the data window as needed.
7. Click Apply.
Related Topics

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

Revision Management

6. In the data window, filter the items as needed. For details, see Filter Items for
Global Revisions, page 78.
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.
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.
Related Topics

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,…

Revision Management
• A— for number sequence A, B, C,…

6. Click the appropriate module tab to apply the defined settings. For details, see
Tips
Related Topics
• Revision Upgrade Example, page 83

2. On the Settings tab, from the Activity list, select Update revision.

Revision Management
Tips
7. In the data window, do one of the following to select the items whose revisions
you want to update:
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

1. Define the settings for upgrading revisions globally. For details, see Define
Settings for Upgrading Revisions, page 80.
2. Select the desired module tab and filter the items as needed. For details, see
Filter Items for Global Revisions, page 78.
4. In the data window, do one of the following to select the items for which you
want to upgrade revisions:

Revision Management
window.
mode.
6. If you want to upgrade revisions for other modules, repeat the appropriate steps
for each module.
Related Topics
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.)

Revision Management
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
• Upgrade Revisions Globally, page 82

Revision Management

Global Revisions.
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 .
Tips
5. In the data window, do one of the following to select the required items:
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

Revision Management
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).
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.
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. To
learn more about custom title blocks, see Customizing Title Blocks for
Reports: An Overview, page 114.
Related Topics
• View an Archived Revision, page 88

Revision Management

1. In the Revisions dialog box, select the revision that you want to edit.
2. Make the desired changes according to the revision table:
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
3. Make changes for other revisions as desired.

4. Click OK to apply your changes.
Related Topics

1. On the Revisions dialog box, select the revision that you want to delete.
2. Click Delete.
Related Topics

Revision Management
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
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.
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 92.
• Compare two archived reports. For details, see Comparing Archived
Reports, page 91.
Related Topics
• Setting Font and Color for Report Comparison, page 90
• Viewing Archived Reports, page 93

Revision Management
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 89

Revision Management
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
90
Related Topics
• Comparing the Current Report with an Archived Report, page 92

Revision Management
Comparing the Current Report with an Archived

Report
The option enables you to compare the currently previewed report with an archived
report.

Report
• 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.
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
90
• .
Related Topics

Revision Management
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

• 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
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

Revision Management
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.

Revision Management
Workflow: An Overview
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 96
• Implementing Workflow, page 98
• Process Data Statuses, page 100
• Workflow Prerequisites, page 96

Revision Management
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
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. For
details, see Regenerate Library Forms, page 830.
Related Topics
• Workflow: An Overview, page 95
Create a Workflow Browser

1.

Revision Management
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
96.
2. Open the Browser Manager.
3. Under Browser groups, double-click Workflow to expand the hierarchy.
4. Select the Instrumentation/Process Data Browser and create a new view.
5. Double-click the view to expand the hierarchy.
6. Click , and in the Style settings section, click Edit.
7. 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.
8. Click Save.
9. 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 100
Related Topics
• Browser Views Common Tasks, page 316
• Browser Views: An Overview, page 315

Revision Management
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.

Revision Management
Enter Additional Instrument Data

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

Revision Management
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 and Set and changed by
not Required therefore are not available to the process instrument engineers
engineering group.
Process Data Tags available for process data entry by Set by instrument
Required the process engineering group (in the engineers Can be changed
Process Data module or Browser). 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

Revision Management
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 113
• Modifying Printer Settings, page 108
• Previewing Documents, page 102
• Printing Documents, page 104
• Saving Documents, page 110
• Saving in DXF Format, page 111

Revision Management
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.
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 scroller. 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).

Revision Management
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
• Modify Document Numbers in a Document Browser View, page 320

Revision Management
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 102.
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

Revision Management
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 979.
Notes
• When printing .pdf files in batch mode for the above document types,
you must install GNU Ghostscript or Adobe Acrobat Distiller. You
then open the Preferences dialog box and under the General tab,
select the appropriate application from the PDF generator list.
• In general, SmartPlant Instrumentation supports batch printing to .pdf
files only for the above document types. It Is possible to print to .pdf
files in batch mode for other types of documents; however, the
software cannot create unique file names for each document and is
liable to overwrite the previously generated file, resulting in generation
of the last report only in the batch. In this case, to prevent this from
occurring, you must configure your printer settings to prompt for a file
name for each document (for details, see the user's guide for your
specific printer).
Related Topics
• Setting Acrobat Distiller Batch Print Options, page 107
• Setting Ghostscript Batch Print Options, page 106

Revision Management
Setting Ghostscript Batch Print Options

When you print reports in batch mode using GNU Ghostscript, the software does not
create unique names for multiple output files (except for enhanced reports). For this
reason, you need to configure the driver settings so that the software prompts you to
enter a name for each report file.
Set the Ghostscript Batch Print Options

1. On the Windows taskbar, click Start > Settings > Printers.
2. Right-click Generic PostScript Printer, and on the shortcut menu, click
Properties.
3. Click the Ports tab.
4. Click Configure Port.
5. In the dialog box that opens, from the Output list, select Prompt for filename.

Revision Management
Setting Acrobat Distiller Batch Print Options

When you print reports in batch mode using Acrobat Distiller, the software does not
reason, you need to configure the print settings so that the software prompts you to
Set the Acrobat Distiller Batch Print Options

1. Start Acrobat Distiller.
2. On the File menu, click Printing Preferences.
3. On the Adobe PDF Settings tab, select the check boxes Prompt for the PDF
filename and Ask to replace existing PDF file.

Revision Management
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

Revision Management


Revision Management
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

Revision Management
Saving in DXF Format

You can save any report in .dxf format for insertion into a CAD drawing (with
AutoCAD or MicroStation). 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 whether to include the title block and frame, whether to build
a script file for AutoCAD, and define certain other parameters for AutoCAD.
Save a Document in DXF Format

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. (Clear the check box to exclude the title block
and frame from the saved report if the CAD package has its own frame.)
4. If you are working in batch mode to save a number of files that are to be opened
in AutoCAD, you can automate the process as far as possible. Define the
parameters in the AutoCAD Options and User-defined options sections of the
dialog box as follows:
5.
File Description
Insertion point The X- and Y- coordinates for the insertion point of the report in
the AutoCAD file define the displacement from the lower-left
corner of the AutoCAD file. The upper-left corner of the report is
inserted at this location.
Scale factor The scale factor determines the size of the report so that it will fit
into the AutoCAD 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
AutoCAD scales the font with the report as a whole.
Change black Type the value of the AutoCAD color to be used as a substitute
report color to for black. All reports are displayed in black-and-white. If
viewing the report in AutoCAD with a black background, an
alternative foreground color needs to be used. The recommended
value is 7.
6. Browse to the target folder and click OK.

Revision Management
Related Topics

Revision Management
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

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

Revision Management
Customizing Title Blocks for Reports: An Overview

Title blocks for reports are templates that SmartPlant Instrumentation uses for the
design of its reports. While the standard default title blocks supplied with the
software are adequate for many reports, you can also create your own custom title
blocks that provide you with the required design and layout of your reports. You can,
for example, customize report titles and headers, as well as the frame size of the title
block.
You first create a title block or duplicate it from an existing one using InfoMaker and
save it as a .psr file. You then open the .psr file in SmartPlant Instrumentation and
add it to the title block inventory. After that, you need to associate the title block
with the required reports and finally, generate a report through the relevant module
using the created title block.
Note
• It is usually more convenient to edit an existing title block and save it
under a different name rather than to create a new one.
Related Topics
• Requirements for Customized Report Title Blocks, page 115
• Spec Title Blocks: An Overview, page 878

Revision Management
Requirements for Customized Report Title Blocks

You can customize a title block for reports in InfoMaker. In either application, the
custom title block has to meet several standard requirements. The title block has to be
compatible with the report it is associated with. Therefore, make sure that the
customization process accurately fits the SmartPlant Instrumentation customizing
conventions as specified in the following topic.
The following list outlines mandatory and optional InfoMaker requirements:
• Report type — When creating a new report set the report type to be
External (mandatory).
• Report style — Set the report style to be Tabular (mandatory).
• Field prompt— When prompted to set the required fields for a title
block, type any text in the appropriate field. There is no significance to
inserting any particular field name as long as something is typed
(mandatory).
• Group — The title block customization has to be performed in the
Detail group (mandatory).
• Layer — Make sure that you create the title block in the Band layer
(the default - mandatory).
• Design— The frame of the title block consists of four lines. Make
sure that each line has its own unique name typed in small caps as
follows:
Upper side L_width
Lower side ln_down
Left side ln_left
Right side ln_right
Important
• When adding other design-related items, such as internal lines, text
boxes, and so forth, to the title block, make sure that the names of the
new items contain the tb segment. For example, if you want to add a
new line, name the line as <Line>_tb_<1>. This is required to
distinguish between items that belong to the title block and items that
belong to the rest of the report outside the title block.
• Field type — select any field type other than Column (mandatory).
• Revisions— Make sure that you have a number 1 revision field. For
instance, a title block with solely a revision no. 2, would not apply.

Revision Management
• Report measurement units— The units of measure of the

customized title block must be compatible with the units of measure of
the report it is associated with. All the reports were created in inches
except for the following, which use PowerBuilder units:
• All the calculation reports
• The Segment map report
• Fields— SmartPlant Instrumentation created an inventory of macros
available for the custom title block fields. From this inventory you can
select the fields that serve your purposes most. Each field and macro
has its unique name (this is the name to insert in the name field when
creating the item in InfoMaker) as shown in the tables below.
Notes
• Macros retrieve the data and enter it to the fields. For these macros to
function properly, you must insert the macro name accurately
according to the macro tables below.
• You can implement custom title blocks that for macros custom_1
through custom_5 display field values without labels, for example,
'DCS-1' instead of 'Panel DCS-1'. To enable this option, make sure
that the [Custom] section of the intools.ini file includes the line
'RemoveFixedTextFromTB=1'.
Table includes Text type fields only:
Field Name Field Description

custom_1 Report name
custom_2 – custom_5 Item names or other data used in reports or drawings
eproj_name Project name (Operating owner domain)
project_t Project header (Operating owner domain)
proj_name Domain name
proj_num Project number (Operating owner domain)
city_name City name
owner_name <Plant> owner.
location_name Location name
plant_hierarchy Plant hierarchy defined by the Domain Administrator.
The default plant hierarchy is Plant\Area\Unit. The
Domain Administrator has rights to change the number of
plant hierarchy levels and customize the level names.

Revision Management

hierarchy_item_name_x The name of a specific item in the plant hierarchy, where
the segment X defines the plant hierarchy level number.
For example, suppose that your plant hierarchy is
Plant\Area\Unit, and on the Unit level, you have an item
name Crude. To display Crude in the title block, you need
to substitute the segment X with the number 3.
plant_name The name of the item on the highest plant hierarchy level
(the default highest level is Plant).
plant_addr1 Address 1 of the highest plant hierarchy level item
plant_country Country of the highest plant hierarchy level item
plant_state State of the highest plant hierarchy level item
plant_zip ZIP code of the highest plant hierarchy level item
area_name The name of the item on the intermediate level of the plant
hierarchy (the default intermediate level is Area). If the
plant hierarchy has more than three levels, the macro
area_name retrieves the name of the lowest intermediate
level, that is one level above the lowest level of the plant
hierarchy.
unit_name The name of the item on the lowest level of the plant
hierarchy (the default lowest level is Unit).
hierarchy_udf_y_x A custom field value associated with a specific plant
hierarchy item. The segment 'y' retrieves the number of
the custom field (the Domain Administrator can define up
to twenty custom field values for each plant hierarchy
item). The segment 'x' retrieves the number of the level to
which the plant hierarchy item belongs.
hierarchy_udf_y_x_t Custom fields associated with a plant hierarchy item are
regular text fields and behave as any other custom fields
that are available in SmartPlant Instrumentation for
specific items.
hierarchy_udf_y_x_t The header of a custom field associated with a specific
plant hierarchy item. The segments 'y' and 'x' correspond
to the segments in the macro hierarchy_udf_y_x. The
segment 't' indicates the header.
tb_dwg_name_t Document number
lastrev Last revision
rev_no_1 – rev_no_9 Revision number 1 (mandatory field)
rev_udf_cXX_1 – Revision custom fields (for more details, see below)
rev_udf_cXX_9

Revision Management

create_by_1 – Created by
create_by_9
date_1 – date_9 Date
chk_by_1 – chk_by _9 Checked by
appr_by_1 – appr_by _9 Approved by
desc_1 – desc_9 Revision description
The following table includes Computed type fields only:
Field name Field Expression

description
C_page_num Current sheet Page()
C_page_count Total sheets PageCount()
comp_1 Logo name bitmap ( ProfileString ( "intools.ini", "Project",
"LogoPath", " " + "projlogo.bmp" )
• Revision custom fields— you can define your own fields and related
macros in addition to those in the inventory of macros (designated for
fields) that are supplies with SmartPlant Instrumentation. You can add
up to 20 revision custom fields per title block. Inserting the right name
in the field name prompt is necessary for the proper function of the
field in the title block. The naming convention for the revision custom
fields is as specified in the following table:
rev_udf_c01_t Header
rev_udf_c01_1 Data field
rev_udf_c01_2 Second data field under the same header
rev_udf_c02_t Header 2 (another UDF)
rev_udf_c02_1 The data in the field (2)
• Document custom fields— Using these fields you can have a record
of the documents that were related to a certain report. These are fields
that you define under the following limitation: each custom field must
have only two fields, one for the header and one for the data. This is
the naming convention for these fields:
dwg_udf_c01_t Header
dwg_udf_c01 Data field
dwg_udf_c02_t Header 2 (another custom field)
dwg_udf_c02 Data field (2)

Revision Management
Related Topics
• Customizing Title Blocks for Reports: An Overview, page 114
Edit Report Title Block Properties

You can edit report title block properties under two editing levels. The first is
internal and includes changing the revision custom field headers, document headers
and the title block name. The second level is external to SmartPlant Instrumentation
and includes changes in the design, replacing macros, fields, adding and removing
fields.
1. In the main SmartPlant Instrumentation window, on the Tools menu, click Title
Blocks.
2. In the Title Block dialog box, select the desired title block and click Properties.
3. In the Title Block Properties dialog box, do the following:
a. Under Revision custom field headers, in the Header column, type the name
for each custom field.
b. In the Title block name field, type the name that you have selected for the
title block.
c. Under Document custom field headers, in the Header column, type the
name for each custom field.
Tips
• If you want to modify the number of revisions of custom title blocks,
you need to add more revision rows and create appropriate macros in
InfoMaker. The Revision rows box displays the number of revision
rows that you have customized for your title block.
• For the second level of editing you can use an external editing
application (for example, InfoMaker). When editing title blocks, you
must follow the title block requirements.
Related Topics

Revision Management
PSR Files
SmartPlant Instrumentation provides you with a Power Soft Report (.psr) file viewer
that enables you to retrieve, view, and manage files saved in the .psr format. You can
create a .psr file when you want to save a report or a specification using the Save As
command. You can also view and edit .psr files in InfoMaker.
Related Topics
• Adding User-Defined Fields to PSR Files, page 127
• Managing the PSR File List, page 125
• Retrieving PBL File Reports, page 126
• Saving PSR File Data, page 123
• Viewing PSR Files, page 121
• Viewing PSR User-Defined Fields, page 129

Revision Management
Viewing PSR Files

This feature enables you to retrieve files saved in the .psr format and view their
contents. This way you can view specifications, reports, and forms which were saved
as .psr files.
You can:
• Retrieve a .psr report that is saved in a file. For details see Retrieving
PSR Files, page 122.
• Open a report from the PSR List window. For details see Opening
PSR Files from the PSR List, page 124.

Revision Management
Retrieving PSR Files

If you saved a report as a .psr file, you can navigate to that file and open it.
Retrieve a Previously Saved PSR File

1. Within any module, on the File menu, click Import PSR.
• Click .
• On the Actions menu, click PSR Viewer.
3. In the Select Report File dialog box, navigate to the desired .psr file and click
OK to display the content of the selected .psr file in the PSR File Viewer
window.
Related Topics
• Opening PSR Files from the PSR List, page 124

Revision Management
Saving PSR File Data

You can save data (for example, a .psr file or data from the database) to an external
file in any format supported by the PowerSoft format, for example: .psr, .wmf, .html,
.sql.
For general details of how to save data from a Print Preview window, see Saving
Documents, page 110
Related Topics

Revision Management
Opening PSR Files from the PSR List

This option enables you to select an existing .psr file from the list and view its content
in the PSR File Viewer window. The .psr file list is useful where you have a
permanent set of standard .psr files that you want to view frequently.
Open a PSR File From the PSR List

• Click .
• On the Actions menu, click List.
3. In the PSR List window, select the .psr file you want to view in the PSR File
Viewer window.
4. Click .
Related Topics
• Retrieving PSR Files, page 122

Revision Management
Managing the PSR File List

You can manage the list of .psr files displayed in the PSR List window.
Manage .Psr Files

1. In the PSR File Viewer window, click .
2. In the PSR List window, in the Description data field, type in a description to
characterize the selected .psr file.
3. Perform one of the following actions as required:
Click… …to do t he following:
Insert Append a new line where you can type in the path statement for an existing
.psr file.
File Retrieve a .psr file from a folder and add it to the list.
Delete Remove a .psr file from the list.
Path Set a new default path for all the files in the list. This option is useful if you
have moved all the .psr files in the list to the same folder and you need to
show the new location so that the files can be found. In this case, you do
not need to change each file path separately. At least one .psr file must
already be present in the required path.
Select Display the data for the highlighted file in the PSR File Viewer window.
Caution
• If you click Path and choose a new folder location for the .psr files,
the original paths that were displayed for the files will be overwritten.
You should therefore only use this option where you are certain that all
the files in the list are located in the same folder.
4. On completion of the required action, click Save.
Related Topics

Revision Management
Retrieving PBL File Reports

The .psr format allows you to save a multi-page report and nested reports (reports
which contain sub-reports or embedded objects). The .psr file format also enables
you to design your own reports in InfoMaker and use names of columns from your
database. You can then view the reports with the actual data by the PBL Viewer
option.
Important
• Prior to retrieving the reports from the appropriate .pbl file you need to
define the .pbl file location. To define the pbl file location, in the
intools.ini file [Custom] section, LibraryList parameter, you type the
pbl file path and one of the pbl files in the path.
Retrieve a Report From a PBL File

1. With the PSR File Viewer window open, click .
2. In the standard Select Source File dialog box, navigate to the required .pbl file
and click OK.
Important
• Make sure you select an appropriate pbl file, as the .pbl format is also
used for purposes other than storing reports.
3. In the DataWindow List pop-up window, scroll to the required data window and
select it.
4. Click to retrieve the appropriate column data from the database and display it
in the PSR File Viewer window.
Related Topics

Revision Management
Adding User-Defined Fields to PSR Files

When working with reports, you sometimes need to use extra fields in addition to
those currently available to you. A number of user-defined fields (named Udf C01,
Udf C02, and so forth.) are appended by default to every .psr file that you import.
The first step in making the user-defined fields appear in a report is opening the
report using a report generator, such as InfoMaker or MicroStation, and adding the
appropriate user-defined fields to that report.
After saving a report as a .psr file, you can retrieve your user-defined field values and
include them in the header of the desired report.
Add User-Defined Fields to a PSR File (Using InfoMaker)

1. Start InfoMaker.
2. Build a query for generating a report.
3. For each user-defined field that you want to add, do the following:
a. With the main report window open, click Insert > Control > Computed
Field.
b. Click the mouse pointer at the position where you want to place the computed
field on the report.
c. On the Modify Expression dialog box, under the Expression section, type an
expression according to the following syntax:
ProfileString("<SmartPlant Instrumentation home
folder>\intools.ini", "External
Report","<s_udf_name>","<s_udf_value>")
For example:
ProfileString("C:\Program
Files\SmartPlant\Instrumentation\intools.ini", "External
Report","udf_C01","Not found")
Tip
• The `s_udf_value' parameter is used to specify a default string to
display where no value exists for the specified user-defined field.
d. At the right of the report, using the Position, Font, and Format tabs, make
the desired definitions for the user-defined field (for example, alignment,
positioning, color, style).
4. If you intend to display more than one .psr file in the SmartPlant Instrumentation
PSR List window, display the SQL data source, and under the where section, type
the following expression:

Revision Management
psr_storage.psr_stor_desc='<PSR description>.>
Caution
• Without adding this expression to InfoMaker, SmartPlant
Instrumentation always retrieves from the database the first row of
user-defined fields in the PSR List window, regardless of the report
you select. Make sure that the '< PSR description>' has the same value
as the value in the Description column of the PSR List window.
5. Save the current report as a .psr file.
6. Open SmartPlant Instrumentation.
7. With any main module window open, click File > Import PSR.
8. In the PSR File Viewer window, click to open the PSR List window.
9. Scroll to the right side of the window to view the user-defined columns and in the
columns Udf C01 to Udf C10, type the desired values.
10. Click Save to save your user-defined data to the database.
Related Topics

Revision Management
Viewing PSR User-Defined Fields

This option enables you to retrieve your user-defined field values from the existing
.psr files, and include these values in the header of the desired report within the
SmartPlant Instrumentation environment.
View PSR User-Defined Fields in a Report Header

Caution
• If more than one .psr file is displayed in the PSR List window, you
must open the desired report in InfoMaker, and under the where
section, type the following expression:
psr_storage.psr_stor_desc='<PSR description>
Without adding this expression to InfoMaker, SmartPlant Instrumentation always

retrieves from the database the first row of user-defined fields in the PSR List
window, regardless of the report you select. Make sure that the '< PSR
description>' has the same value as the value in the Description column of the
PSR List window. When done, save the changes to the report and close
InfoMaker.
1. From SmartPlant Instrumentation, do one of the following:
• Retrieve the desired .psr file. For details, see Retrieving PSR Files,
page 122, and on the PSR File View window toolbar, click .
• Open the desired .psr file from the PSR List window. For details, see
Opening PSR Files from the PSR List, page 124.
2. In the data window of the PSR List window, select a .psr file with user-defined
fields.
3. Do one of the following to open the PSR File Viewer window:
• Double-click the selected .psr file.
• On the toolbar, click .
• On the Actions menu, click Select.
4. On the PSR File Viewer window toolbar, click .
Tip
• For the selected file, the software copies the values in columns Udf
C01 to Udf C10 to the [External Report] section of the Intools.ini file
so that the appropriate user-defined field values appear in the report.
Related Topics

Revision Management
Displaying and Customizing Preferences

project, if the domain type is Operating owner.
Notes
• Certain interface options are governed by the intools.ini file. For more
information, see Preferences Governed by the .INI File, page 45.
View Or Customize SmartPlant Instrumentation Preferences

1. On the File menu, click Preferences.
preferences.
Tip
their preferences. Therefore, you may find that you can only view
certain options but not change their values.

Revision Management

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. This only
applies to a small number of windows and dialog boxes.
The ID of the <Unit> Selected Last

When you select a specific <unit> in the Open dialog box, the software records the
<unit> ID in the intools.ini file. The next time you start SmartPlant Instrumentation
and display the Open dialog box, the software displays the <unit> you selected last.
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.
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]
DrawingPerLevel = YThis setting is needed if, for example, you are publishing
documents to TEF from different <units>.
Suppression of Loop Equipment Propagation to Tag Numbers by

Default
associate with the loop. To do so, open the intools.ini file, and under the [Index]

Revision Management
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
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.
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
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.

Revision Management
• Set print preview options.

• Overwrite the default logo.
Note that the Domain Administrator can restrict your ability to set various
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.
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.

Revision Management
• 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:
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
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.

Revision Management
PDF generator — Enables you to select the PDF file generator that you installed
for generating IDEAL reports. Available options are: Acrobat Distiller and Generic
PostScript Printer. Selecting a PDF generator also allows SmartPlant
Instrumentation users to save specification sheets and specification binder packages
as .pdf files.
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.
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.
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 tag number name — Allows you to include the loop suffix in
the name of a newly created tag number.
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.

Revision Management
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
• 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
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 set the instrument type profile properties in the
Instrument Type Profile dialog box. 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 settings without affecting the
global selections made in the Instrument Type Profile dialog box.
Activate instrument type profile options — Activate instrument type profile

options in the Instrument Type Profile dialog box.

Revision Management
Clear the check boxes to deactivate instrument type profile options in the Instrument
Type Profile dialog box.
• Wiring— Wiring and I/O profile options.

• Instrument specifications— Instrument specification profile options
• Hook-ups— Hook-up profile options
• 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, or Steam.
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

Revision Management
typical tag number defined for the selected typical loop. You cannot
create typical tags based on the instrument type profile of the source
tag.
• 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.
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. For details, see Activating Instrument Type Profile Default
Options, page 136.
• 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 block associations of 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.
Instrument specifications — Includes all the instrument specifications associated

with the source tags. You can include the process data information in the source
specifications only if you select the Process Data check box as well.
Notes
• Instrument specifications are duplicated only if you select the Process
data check box too.

Revision Management
• 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 number with the custom fields of the source tag.
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 tag sequence — 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.
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.

Revision Management
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.
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
The options are:
Propagate options
Propagate P&ID drawing when assigning tags to lines — After selecting this
option, in 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, in 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>.
Naming conventions
Complete target tag or loop names using 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

Revision Management
<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. For details of
acceptable parameters and values, contact Intergraph Support.
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.
• Multi-tag options, such as the master tag display, the SEE LIST label
customization, tag assignment to process data cases, 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.
Use default print layout — This option affects the layout of the printout for multi-
tag specifications (Individual tag list page). When selected, the default grid layout
will be used, with one header per column. When cleared, a multi-line layout will be
used for the specification format, if defined. A multi-line layout can be customized to
display several headers per column, and the font and column sizes can be modified.
(Where no other format is defined, the default will be used whether or not this check
box is selected.)
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.

Revision Management
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, however, that 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.
Process data changes notification — 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.
Multi-tag specification options
Show master tag — Select this check box to show the master tag number (in
parentheses) next to the multi-tag list in the Tag Number column of a multi-tag
specification.
Only governing case for multi-tag specs — Select this check box 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.

Revision Management
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 — Select 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.
Clear to display 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.

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

Revision Management
• 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:
• 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 without 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.
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.

Revision Management
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 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 folder, the software keeps the files
in the temporary folder path that you specify under the general preferences. Note that
the .psr files that the software generates when opening a print preview do not get
saved in this folder but in the temporary folder.
Overwrite PSR file — 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)

Custom features for the Instrument Specifications module


Revision Management
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.
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.
Name uniqueness
Enforce name uniqueness — Select this check box to enforce the name uniqueness
for wiring items. For more information, see Name and Sequence Uniqueness of
Wiring Items, page 428
Wiring > I/O Card (Preferences)

These preferences allow you to determine the rack slot values available in the Slot list
in the I/O Card Definition dialog box: all slots (vacant and occupied) or just vacant
slots.
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click I/O Card.
Assign rack slot

• All slots (vacant and occupied) — Makes vacant and occupied slots
available in the Position list of I/O Card Definition dialog box.
• Vacant positions only — Make only vacant slots available in the
Position list of the I/O Card Definition dialog box.
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

Revision Management
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.
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.
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.
click beside Wiring and then click CS Tags.
CS tag name uniqueness level — 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
The following options allow you to set the required uniqueness level for a Distributed
Control System (DCS):
• Plant— Set uniqueness at the plant level.

Revision Management
• Panel— Set uniqueness at the panel level.

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

• Panel— Set uniqueness at the panel level.
• Terminal strip— Set uniqueness at the terminal strip level.
• Not unique— Allow use of the same Control System tag name at any
level.
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.
click beside Wiring and then click Copy Items.
Include 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

Revision Management
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.
• 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.
click beside Wiring and then click Jumpers.

Revision Management
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.
• 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.
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.)

Revision Management
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.
Wiring > Cross Wiring (Preferences)

These options enable you to change the definitions for the matching signals whose
strips you cross-wire automatically.
click beside Wiring and then click Cross Wiring.
Automatic cross-wiring — These options determine how the software
• 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)


Revision Management
Custom features for the Wiring module

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.

Open process data sheet — These options determine what happens when you click
• 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.

Revision Management
• 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:
• 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)

Custom features for the Process Data module

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.

Open calculation sheet — These options determine what happens when you click
• 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.

Revision Management
• 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.
• 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
Custom features for the Calibration module

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

Revision Management
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.
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 2000 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:

Revision Management
• 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.
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 Loop 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, page 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, page
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.

Revision Management
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). For details of supported date
formats, see Set the Date Format in CAD Loop Drawings, page 1009.
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.
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
Important
SmartPlant Instrumentation. Since the default path C:\Program
Files\SmartPlant\Instrumentation\CAD\CADFunc is longer than
required, 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 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

Revision Management
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)

Custom features for the Loop Drawings module

Browser > Reports (Preferences)

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

Print all pages — Select this check box to be able to print all the pages of the
reports you select. Clear this check box to specify at the time of printing which pages
of selected reports you want to print.
Show the first column of the report on all pages — Select this check box to view
the first column of the report on all pages. Clear this check box to view the first
column on the first page only. This option is only available when you select Print all
pages.
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.

Revision Management
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)

Custom features for the Browser module

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 the Hook-Up Drawing Generation Settings dialog box.
Drawing block name

Revision Management
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
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 Management
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.

Tag association — Select 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
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.
Hook-up units of measure — Determine 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 names
Allows you to display the names in the Units of measure list.
Display 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.

Revision Management
• 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.
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\programCAD function folder — Click Browse to

navigate to the folder containing the CAD function files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\CADFunc
Caution
SmartPlant Instrumentation. Since the default path C:\Program
Files\SmartPlant\Instrumentation\CAD\CADFunc is longer than
required, 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
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.

Revision Management
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.
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.

Revision Management
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)

Custom features for the Hook-Ups module

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

• 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.
Document Binder > Specification Binder (Preferences)

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

Revision Management
Select instrument 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 instrument specifications, delete associated specification binder
revisions — When you remove an instrument 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
instrument specification.
View instrument 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.
Change 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.
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.

Revision Management
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)

Custom features for the Document Binder module

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 Operating owner. 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.
To access these preferences, on the Preferences dialog box, in the tree view pane,
click Calibration and Maintenance > General.
Loop error calculation

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

Revision Management
• 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.
Tag settings
Enable clearing of tag settings to allow clearing of the tag calculation values.
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— Allows you to create a maintenance

event records as shown in the following example: 101 -FT -100 02-03-
07.
• Event date, then tag number— Allows you to create a maintenance
event records as shown in the following example: 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— Allows you to create a maintenance event records
as shown in the following example: 02-03-07.
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..

Revision Management
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). For details of supported date formats, see Set a Date
Format for Maintenance Event Record Names, page 1129.
Calculation > Custom (Preferences)

Custom features for the Calculation module

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.
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.

Revision Management
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.
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 — Select to generate the drawing
with field devices drawn at the right edge of the drawing sheet. Clear to generate the

Revision Management
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 Reports 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.
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.

Revision Management
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

Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
Terminal discontinuity — 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.

Revision Management
For a visual comparison of these representations, see Connector Representation

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

Panel-Strip > View (Preferences)

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




Revision Management
Left-most 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.

Examples.

Wiring Equipment Connections > View (Preferences)

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

Revision Management



Examples.

Segment Wiring > View (Preferences)

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

Revision Management
Display options


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

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

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

Examples.

Revision Management

Communication Line > View (Preferences)

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


Examples.

Revision Management

Internal Cross Wiring > View (Preferences)

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

Examples.

Fieldbus Loop > View (Preferences)

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

Revision Management
Display options



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.

Revision Management

Examples.
Cross wiring — Set the desired connector representation for cross - wiring

Network Class > View (Preferences)

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


Revision Management

Examples.
Cross wiring — Set the desired connector representation for cross - wiring

Strip Signals > View (Preferences)

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


Revision Management



Examples.

Single Speaker > View (Preferences)

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

Revision Management
Display options

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

Examples.

Enhanced PA Amplifier > View (Preferences)

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

Revision Management
Display options


Examples.

Cable Block Diagram > View (Preferences)

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

Revision Management
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.
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.
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)

Custom features for enhanced reports

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.

Revision Management
Generation method
Select the default generation method to use when you do not specify a generation
method in the Loop Explorer 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.
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.

Revision Management
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.
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< /p>
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
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.
Viewer output folder — Use this option to define the folder where the software
saves the output files when your default printer is specified as a viewer (Acrobat
PDFWriter, Acrobat Distiller, or Generic PostScript Printer). When you generate
new enhanced reports and print to a file in batch mode (without previewing the
reports before printing), the software saves the files in this path using the item names

Revision Management
in the native viewer format. Click Browse to select a path and enter that path to the
field. For example:
C:\SmartPlant\Instrumentation\RAD\My Batch Drawings\
If you do not specify any path, the software saves the files to the location specified on
the General preferences page under Temporary folder path.
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.
Symbol 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

Revision Management
on the report. Type the path and file name in the box or click Browse to navigate to
the file.
Symbol 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.

Revision Management
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
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.

Revision Management
Units — Select the units to specify for the working area margins: inches,
millimeters, or twips.
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.

Revision Management
Width — Specifies the connector width in the selected units.
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:

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.

Revision Management
SmartPlant > General (Preferences)

The option on this page enables you to specify the analyzer accuracy for use in an
integrated environment.
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

Default folder for XML files — This option applies when you publish data in File
mode using the interface to SmartPlant Electrical, DeltaV, or Yokogawa. Click
Browse to select a working folder in which to keep the .xml files containing your
published data.
SmartPlant > 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.
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.

Revision Management
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 Operating owner 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.
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

Revision Management
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 with the item
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.
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.

Revision Management
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.
Include parent items as
Dummy when claiming — Allows you to claim or copy to the Claim Buffer parent
items either as dummy items or fully-functional items. For example, if you claim an
instrument, the source loop number appears in the project as a dummy item. If you
clear this check box and claim a tag, the software claims the tag loop number as a
fully-functional item.
Note
• When you claim instruments directly from the Instruments folder of
the As-Built Explorer or Source Project Explorer, the source loop is
always claimed as a dummy item. In this case, the check box does not
apply.
Fully-functional when merging — Allows you to copy to the Merge Buffer parent
items either as dummy items or fully-functional items. When your Project
Administrator merges the items that you copied to the Merge Buffer, this preference
determines whether the parent item in the project remains as a fully-functional item or
is converted to a dummy item when you merge its sub-items with As-Built:

Revision Management
• If you select the check box and copy an item to the Merge Buffer, its
parent item appears in the Merge Buffer as a fully-functional item.
When your Project Administrator merges the items that you copied,
the parent project item remains in the project as a fully-functional
item.
• If you clear the check box and copy an item to the Merge Buffer, its
parent item appears in the Merge Buffer as a dummy item. When
your Project Administrator merges the items that you copied, the
parent project item is converted in the project to a dummy item. 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.
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 Operating owner, in the current project.
Default report generator

Report generator — Select an option: InfoMaker or None.
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.

Revision Management
• PDF – Generates PDF files. For this option to work, you must install
a PostScript printer driver or Acrobat Distiller.
Shared Web folder — Enables you to specify the path to the shared Web folder for
the SmartPlant Instrumentation Server. When you generate reports using IDEAL, the
output document folder must be a sub-folder of the shared Web folder. Click Browse
to navigate to the shared Web folder path. For example:
C:\inetpub\wwwroot
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 Operating
owner.
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.
Left pane — This pane contains all the available icons that can be placed on the
main toolbar in any position. To place an icon on the main toolbar, do one of the
following:
• Drag an icon from the Icons pane and drop it in the Main toolbar
pane.
• Double-click an icon or its name in the Icons pane.
• Select an icon and click Add.
Right pane — This pane contains all the icons that have already been placed on the
main toolbar. By default, all the icons appear in the Main toolbar pane. To remove
an icon from the main toolbar, do one of the following:

Revision Management
• Drag an icon from the Main toolbar pane and drop it in the Icons
pane.
• Double-click an icon or its name in the Main toolbar pane.
• Select an icon and click Remove.

Claiming As-Built Items in a Project

In an Operating owner 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 scope of items for the project. Before
claiming the items, you can copy the required items to the Claim Buffer, which 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, or use copy the copied items using command line parameters. Alternatively,
you can claim specific As-Built items directly from the project, without copying them
to the Claim Buffer first, provided that the Claim Buffer is empty.
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 claming, see Claim and Merge
Options (Preferences), page 193.
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.

Related Topics
• Claiming and Merging Items Common Tasks, page 203
• Display As-Built and Project Data, page 204
• Working with the Domain Explorer: An Overview, page 212

Preparing Project Items for Merging with As-Built
Preparing Project Items for Merging with As-

Built
In a project opened in an Operating owner 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 193.
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.
• 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.
Note
• 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.
Related Topics
• Display As-Built and Project Data, page 204
• Working with the Domain Explorer: An Overview, page 212

Claiming and Merging Items Common Tasks

In an Operating owner 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 Operating owner 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 204.
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 205.
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 206.
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 Operating owner 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 207.

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 208.
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 208.
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 209.
Related Topics
• Claiming As-Built Items in a Project: An Overview, page 199
• Preparing Project Items for Merging with As-Built: An Overview, page
201
Display As-Built and Project Data

1. On the Open dialog box, select a domain of type Operating owner.
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 .

• 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
• Item Status Indicators in the Domain Explorer, page 234
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 204.
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.
• 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 193.
• 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
loop. You must select and copy such a device panel manually.
Related Topics
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.
shortcut menu, click Project Activities > Claim.
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 207.
• 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 193.
• 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
Claim Instruments in the Browser or Instrument Index

Module
• 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

Claim Loops, Lines, and Equipment in the Browser Module

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
• 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.
• In the Browser module, you can also claim instrument tag numbers.
For details, see Claim Instruments in the Browser or Instrument Index
Module, page 207.
4. On the shortcut menu, click Claim.
Related Topics
Copy Items to the Merge Buffer as Merge Now

shortcut menu, click Project Activities > Copy to Buffer as Merge
Now.
on the shortcut menu, click Project Activities > Copy to Buffer as
Merge Now.

Tips
• 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.
• When you copy items to the Merge Buffer, in addition to the main
• 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
panel inside a cabinet or junction box, when merging the loop, this
Related Topics
201
Copy Items to the Merge Buffer as Release Claim

shortcut menu, click Project Activities > Copy to Buffer as Release
Claim.
on the shortcut menu, click Project Activities > Copy to Buffer as
Release Claim.

Tips
• 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.
• When you copy items to the Merge Buffer, in addition to the main
• 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
panel inside a cabinet or junction box, when merging the loop, this
Related Topics
201

Working with the SmartPlant Instrumentation Explorer
Working with the SmartPlant Instrumentation

Explorer
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 212.
• 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 252.
Note
• When you create an item in the domain explorer, make sure you set the
naming convention for it in the Admin module. For details see Naming
Conventions: An Overview in the Administration User's Guide, under
Domain Administration.
Related Topics
• SmartPlant Instrumentation Explorer Common Tasks, page 214
• Working with the Reference Explorer: An Overview, page 252

Working with the Domain Explorer

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
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.
Tip
• 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.
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
218.

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 234.
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 Working with the
SmartPlant Instrumentation Explorer: An Overview, page 211.
Related Topics
• Association Rules in the Domain Explorer, page 230
• Reference Explorer, page 257
page 211

SmartPlant Instrumentation Explorer Common

Tasks
The following tasks are used frequently when you work with the Domain Explorer.
Create an Item
This procedure shows how to create an item in the Domain Explorer. For more
information, see Create an Item in the Domain Explorer, page 235.
Copy a Reference Item to the Domain Explorer

This procedure explains how to copy a reference item 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 238.
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 236.
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 235.

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 236.
Delete Items
This procedure shows how to delete the items that you select in the Domain
Explorer. For more information, see Delete Items, page 236.
Search for Items

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 238.
Find an Item in the Tree View

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 239.

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 240.
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 242.

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 240.
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 244.
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 246.
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 246.
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 237.
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 237.

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 247.
For the rules that govern the dragging of items in the Domain Explorer, see
Association Rules in the Domain Explorer, page 230.
The Organization of Items in the Domain Explorer Tree View

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 228.
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 been published to SmartPlant
Instrumentation from SmartPlant Electrical. Note that you cannot create any new
electrical tags. However, you can right-click a tag and open the tag number
properties.

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 223.
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 221 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 223.
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 224.
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 226.
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 224.

Panels by Category Hierarchy Examples

The following examples show a number of different structures that you can create in
the Panels by Category folder.
Example 1:
Example 2:
Example 3:

Example 4:
Example 5:
Related Topics
• Domain Explorer, page 248

Panels by Location Hierarchy Example

The following is an example of a panel by location hierarchy structure:
Related Topics
Cable Hierarchy Example
Related Topics
• Creating and Managing Cables: An Overview, page 431

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
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.
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. 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 Indicators, page 234. For a detailed explanation of the tree
view and Items panes, see Domain Explorer, page 248.
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.
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
Related Topics


page 211
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.
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 Indicators, page 234. For a detailed
explanation of the tree view and Items panes, see Domain Explorer, page 248.
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.
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
page 211

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
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 see Item Indicators, page 234. For a detailed explanation of the tree
view and Items panes, see Domain Explorer, page 248.
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.
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
page 211

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>.
<unit>
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
<unit> <unit>.
Instrument Loop The software associates the
instrument with the target
loop.
Instrument Line The software associates the
line.
Instrument Process equipment The software associates the
process equipment.
Instrument P&ID drawing The software associates the
P&ID drawing.
Functional The Loops folder The software moves the
requirement tag in another functional requirement tag to
<unit> 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.


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)


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.


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 Operating owner domain, you cannot move items that have not
been claimed for the current project.
Related Topics
page 211

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.
Related Topics

Create an Item in 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
Domain Administration.
Related Topics
page 211
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.
• 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.
Related Topics

Move an Item in 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
page 211
Edit Item Properties

• In the tree view pane, select an item .
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
page 211
Delete Items
1. Press F7 to open the Domain Explorer or F8 to open the Reference Explorer.
• In the tree view pane, select an item .
4. Right-click the selected items and then on the shortcut menu, click Delete.

Perform Various Actions with an Instrument

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
page 211
Generate a Report for an Instrument

folder.
4. On the shortcut menu, point to Reports and then click the command that you
require.
Related Topics
page 211
Generate a Specification or a Process Data Sheet for an

Instrument
folder.
4. On the shortcut menu, point to Actions and then click the command that you
require.
Related Topics
page 211


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
page 211
Search for Items in SmartPlant Instrumentation 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.

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
page 211
Find an Item in the Tree View of an Explorer Window

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.
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.


• 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
• Search for Items in SmartPlant Instrumentation Explorer, page 238
page 211
Filter the Display of Items According to a Specific Item Type

1. In an Explorer window, do one of the following:
• To filter the entire tree view, select a hierarchy node whose immediate
child items are folders and not plant items. Then click the Filter icon
on the toolbar.
• 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
the Filter icon.
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:
• 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.
• 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
• 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.
• 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 242 and Filter Loops in an
Explorer Window, page 244.
• 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.

Filter the Display of Items According to a Specific Item

Name
1. In an Explorer window, do the following:
• 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.
• 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
• Filter the Display of Items According to a Specific Item Type, page
240
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.
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 244
• Filter Loops in an Explorer Window, page 244
page 211
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
• Filter Cables in an Explorer Window, page 240
page 211
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.
• 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
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
• Filter Cables in an Explorer Window, page 240
page 211
Display a Browser View in the Explorer Items Pane

• 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
page 211
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.
Related Topics
page 211
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.
• 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
page 211

Domain Explorer
Domain Explorer
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.
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 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.
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 click Tools > Domain Explorer.
Note
• 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.
The main features of the Domain Explorer are:
Domain Explorer — Enables you to select a custom view that you have defined.
To add items to a custom view, right-click a folder in the tree view pane or multiple
folders in the Items pane and then on the shortcut menu click Add to Custom View
and then click an appropriate custom view command.
Custom View Properties — Click to define a new custom view.
Toolbar
The toolbar contains the following options:
Search — Click to open the Search dialog box where you can find items that
you want to work with.
Refresh — Click to update the Domain Explorer display. This feature is useful
where multiple users are working on the same set of data.

Domain Explorer
Filter — Click to filter the Domain Explorer display. You can use this toolbar
command if you do one of the following:
• Do not select anything in the Explorer tree view — this allows you
to filter the entire tree view according to a specific item name.
• Select the root node in the Explorer tree view — this allows you to
filter the entire tree view according to a specific item name.
• Select a tree view node whose immediate child items are folders and
not plant items — this allows you to filter the entire tree view
according to a specific item type that you select from the Item type
list on the Filter Definition dialog box.
• Select any tree view node or folder that contains child item to filter
that node or folder according to a specific item type.
Views — Click to toggle through each view of the items in the list view pane,
or click the arrow and select the desired view.
Find — Click to open the Find Item dialog box where you can find an item in a
particular folder that contains numerous items.
Print — Click to print out the browser view that you selected for the current
hierarchy node. Note that this button becomes available only after selecting the Show
Browser command.
Tree View Pane

selected item type.
Expand or collapse the hierarchy by clicking the and icons respectively or by

double-clicking a folder. Expand a folder to display the items. If you cannot expand
a folder, that folder is empty. To perform an action, right-click a folder or an item
and then click a command. Also, to move an item to another parent item , drag that
item to another folder or a parent item as you require.

Domain Explorer
After you double-click the top level of your plant hierarchy, the tree view shows the
Domain Explorer folders and the next level of the plant hierarchy. The following is
a brief description of the item arrangement in the folders:
• Loops and instrument tags are arranged at the lowest level of the plant
hierarchy. You can navigate to a loop or an instrument tag by
expanding the plant hierarchy. Continue expanding your plant
hierarchy to display the Loops and Instruments folders. The
Instruments folder contains all the existing instrument tags in the
current <unit>. Instrument tags can be parent items of CS tags,
specification sheets, process data sheets, and any other documents that
are associated with the selected tag number. Also, there are several
other folders that contain view-only information.
• Panels are arranged by their locations and categories. Therefore, you
can access a panel and its child items by expanding the Panels by
Location or Panels by Category folder. Panels, in turn, contain other
wiring items such as racks, wiring equipment, terminal strips, and so
forth.
• Cables and their child items are arranged in a separate folder. There is
also a separate folder for cross cables.
• Process equipment and lines are arranged in separate folders. Right-
clicking the Process Equipment folder allows you to create a new
process equipment item . Right-clicking the Lines folder allows you
to create a new line.
• Hook-ups are arranged in a folder at top level of the tree view. You
can expand the Hook-Ups folder to access all the existing hook-ups
and their child items. Right-clicking the Hook-Ups folder allows you
to create a new hook-up types and hook-ups.
• CAD drawing are arranged in the Drawing Block Types folder at top
level of the tree view. You can expand the Drawing Block Types
folder to access all the existing block types and blocks. In this folder,
you create your current <plant> blocks but you do not make any
associations. you can associate blocks with loops or instruments only
in the Loops folder or using the Loop Drawings module options.
• There are several other folders at the top level of the tree view. These
folders hold P&IDs, Telecom panels, Foundation Fieldbus segments,
and controllers. Note that some of these folders only display the
existing items and do not allow you to create new ones.
For a detailed explanation of all the folders in the Domain Explorer, see The
Organization of Items in the Domain Explorer Tree View, page 218.

Domain Explorer
Items Pane
The Items pane (list view) pane of the Domain Explorer displays the individual
items that comprise the hierarchy of the item or the folder that you selected in the tree
view. You can choose one of the following three ways to display the items in this
pane:
• List— Displays the individual items that comprise the hierarchy of

the item or the folder that you selected in the tree view.
• 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. The list count displays the number of
items displayed in the List pane.
• Show Browser — 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 allows you to print out the current browser view,
however, you cannot edit the item properties.
• List count— Displays the number of individual items that comprise
the hierarchy of the item or the folder that you selected in the tree
view.
Notes
• You can open several instances of the Domain Explorer by pressing
F7.
• 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 Working with the
SmartPlant Instrumentation Explorer: An Overview, page 211.
Related Topics
• Association Rules in the Domain Explorer, page 230
• The Organization of Items in the Domain Explorer Tree View, page
218
page 211

Working with the Reference Explorer

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 238.
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
contains a particular item type, and the options available on the shortcut menus
depend on the currently selected item type.
indicate the status of a folder or an item, for example access denied, view only, an
Notes
• You can create several instances of the Reference Explorer by
pressing F8.
Related Topics
• Copy a Reference Item to the Domain Explorer, page 238
page 211

The Organization of Items in the Reference Explorer Tree

View
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 Example, page 221 to examine a few possible structures.
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 223.
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 254.
Related Topics
page 211

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
Indicators, page 234. For a detailed explanation of the tree view and Items panes,
see Reference Explorer, page 257.
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.
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.
• 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 939
Related Topics


218
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.
Related Topics
page 211

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
page 211

Reference Explorer
Reference Explorer
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.
You can create predefined configurations of various wiring equipment, panels,

terminal strips, as well as cables, cable sets, and wires. You can use predefined
configurations as reference items and copy them to the Domain Explorer. For more
information about using reference items, see Copying Reference Items, page 257.
You can open the Reference Explorer from anywhere in SmartPlant

Instrumentation. Press F8 or click Tools > Reference Explorer.
The main features of the Reference Explorer are:
Reference Explorer — Enables you to select a custom view that you have defined.
To add items to a custom view, right-click a folder in the tree view pane or multiple
folders in the Items pane and then on the shortcut menu click Add to Custom View
and then click an appropriate custom view command.
Custom View Properties — Click to define a new custom view.
Toolbar
The toolbar contains the following options:
Search — Click to open the Search dialog box where you can find items that
you want to work with.
Refresh — Click to update the Reference Explorer display. This feature is

useful where multiple users are working on the same set of data.

Reference Explorer
Filter — Click to filter the Reference Explorer display. You can use this
toolbar command if you do one of the following:
• Do not select anything in the Explorer tree view — this allows you
to filter the entire tree view according to a specific item name.
• Select the root node in the Explorer tree view — this allows you to
filter the entire tree view according to a specific item name.
• Select a tree view node whose immediate child items are folders and
not plant items — this allows you to filter the entire tree view
according to a specific item type that you select from the Item type
list on the Filter Definition dialog box.
• Select any tree view node or folder that contains child item to filter
that node or folder according to a specific item type.
Views — Click to toggle through each view of the items in the list view pane,
or click the arrow and select the desired view.
Find — Click to open the Find Item dialog box where you can find an item in a
particular folder that contains numerous items.
Print — Click to print out the browser view that you selected for the current
hierarchy node. Note that this button becomes available only after selecting the Show
Browser command.
Tree View Pane

selected item type.
Expand or collapse the hierarchy by clicking the and icons respectively or by

double-clicking a folder.
After double-clicking Reference Explorer, which is the top level in the tree view,
you can see the Panels, Cables, and Wiring Equipment folders. These folders
contain other folders which in turn hold reference items.
You can navigate to a reference item by expanding a folder and then double-clicking
an item to display the existing child items. If you cannot expand a folder, that folder
is empty.
To perform an action, right-click a folder or an item and then click a command. Also,
to move an item to another parent item , drag that item to another folder or a parent
item as you require.

Reference Explorer
For a detailed explanation of all the folders in the Reference Explorer, see The
Organization of Items in the Reference Explorer Tree View, page 253.
Items Pane
The Items pane (list view) pane of the Reference Explorer displays the individual
items that comprise the hierarchy of the item or the folder that you selected in the tree
view. You can choose one of the following three ways to display the items in this
pane:
• List— Displays the individual items that comprise the hierarchy of

the item or the folder that you selected in the tree view.
• 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. The list count displays the number of
items displayed in the List pane.
• Show Browser — 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 allows you to print out the current browser view,
however, you cannot edit the item properties.
• List count— displays the number of individual items that comprise
the hierarchy of the item or the folder that you selected in the tree
view.
Notes
• You can create several instances of the Reference Explorer by
pressing F8.
Related Topics
• The Organization of Items in the Reference Explorer Tree View, page
253
page 211

Browser Module
Browser Module
The Browser module provides you with a wide-angle view of your instrument index
data and allows you to browse through and modify it from a single location in
The core of the Browser module is the Browser Manager that contains a number of
predefined browsers categorized by data type. Each browser is associated with a
particular SmartPlant Instrumentation module but in some cases, it is possible to
present data from several different modules in a single browser view. In addition to
the predefined browsers, you can also create two types of custom browsers – form
browsers and Powersoft browsers that can be customized according to your needs.
The browsers are grouped according to their category. Such a group is referred to as
a browser group. For example, by defining a browser view for the Control Valve
browser in the Process Data & Calculation group, you can display information for
all instrument tags which have the same process function, for example, flow meters.
You access and manipulate module data and various items by creating customized
browser views for each of the predefined and custom browsers in the Browser
Manager. You customize each browser view by defining its style, sorting sequence,
and filter. You can define a number of different browser views for each browser to
organize your data according to different requirements. Each browser view will have
its own style settings, sorting sequence, and filter to present your instrument index
data in the most efficient and informative manner. The browser view style settings
determine which columns and items will be displayed. The sorting sequence
organizes the selected fields in a particular order and the filter lets you display the
data filtered according to the condition you define.
In addition to the database fields provided to you by default, the Browser Manager
also allows you to display custom fields, which you can use to complement data
attributes not supported by the given database fields in a particular module. You can
modify the names of custom fields, as you desire. Depending on your SmartPlant
Instrumentation license, you can also import browser views into SmartPlant
Instrumentation. The views are available as add-ons, and once added you can use
them to access the required data.
Related Topics
• Adding New Browsers: An Overview, page 309
• Browser Manager Overview, page 261
• Sort Settings: An Overview, page 296
• Style Settings: An Overview, page 284
• View Filter Settings: An Overview, page 302

Browser Module
Browser Manager Overview

The Browser Manager enables you to define the settings for the Browser View
window that displays your project data. You select your data and determine how the
software displays it in the Browser View window. You define your viewing settings
by defining a view for a selected Browser that is associated with a particular
SmartPlant Instrumentation module. Once you define and then select a view for a
particular browser, the Browser View window displays your data according to the
selected view settings. You define a view by either creating a new view or
duplicating an existing one.
The first step in defining view settings, is to create a browser view profile (viewing
template) for a browser that you select from the Browser groups list. Each browser
view must be based on a view profile that is defined before any other settings can be
selected. A browser view can contain style, sorting sequence, and filter settings:
• Style— select the fields to be displayed, define the field layout (that
is, the order in which these fields will be displayed), define the data
field headers which will be used for the current style, and set the field
length (number of characters) which will be displayed for each
selected field.
• Sort — determine the sorting sequence of the fields in the Browser
View window. You can also select a different sorting sequence when
viewing the data in the Browser View window.
• Filter — set a filtering condition that is used to filter the selected
data rows displayed in the Browser View window.
After you have defined all the view settings that you require, you can open the
Browser View window, where the current settings are applied to the data with which
the selected browser is associated.
Related Topics
• Browser Manager Common Tasks, page 262
• Browser Manager Hierarchy, page 271
• Browser Types, page 272

Browser Module
Browser Manager Common Tasks

The following tasks are used frequently when working with the Browser Manager.
Select a Default Browser

This procedure shows you how to define a default browser in the Browser Manager.
This enables you to open the default browser view whenever starting SmartPlant
Instrumentation with the Browser module. If other modules are open, the default
browser option is disabled. For more information, see Select a Default Browser, page
263.
Define a View Profile

This option shows you how to define a view profile, the first step in creating a
browser view. A browser view profile serves as a basis for a browser view. After
creating a view profile, you can define style, sort, and filter settings for the selected
browser view. Once you have defined all the view settings, you can open the view
and work with the available data. For more information, see Define a View Profile,
page 264.
Add a New View

This option shows you how to add a new view to an existing browser, enabling you to
create a customized display of your data. SmartPlant Instrumentation displays your
data in the Browser View window according to the style, sort, and filter settings you
chose. You start by defining a view profile . Then, you define the required style, sort,
and filter settings for the new view. Note that you can also duplicate an existing view
and then modify some of the settings as required. For more information, see Add a
New View, page 265.
Duplicate a View
This procedure shows you how to duplicate an existing view. Creating several
different views for the same browser can be very useful when you need to work with
the same module data organized in a different manner. Duplicating an existing view
within the same browser is a fast way to create a new view on the fly. After
duplicating a view, you can modify it as needed. For more information, see
Duplicate a View, page 265.
Copy a View to Another Plant

This procedure shows you how to copy a view from one <plant> to another within
the same SmartPlant Instrumentation domain. When copying view settings, the
software copies style, sort, and filter settings defined in the source view. For more
information, see Copy a View to Another Plant, page 267.

Browser Module
Modify a View Profile

This option shows you how to modify the profile of an existing browser view. This
can be necessary after duplicating a browser view. For more information, see Modify
a View Profile, page 267.
Delete a View
This option shows you how to delete a browser view that is no longer required.
Remember that when deleting a browser view you also delete its Style, Sort and
Filter settings. For more information, see Delete a View, page 269.
Find a Browser or Browser View

This option shows you how to find a browser or browser view in the Browser
Manager. For more information, see Find a Browser or Browser View, page 270.
Related Topics
Select a Default Browser

1. Open the Browser Manager and expand the required Browser Group to display
its browsers.
2. Highlight the required browser view, and click Edit.
3. Select the Set as default view check box.
4. Right-click the browser which you want to set as default and then, on the shortcut
menu, click Set As Default.
Important
• The default browser that you select must have a default view. For
details, see Add a New View, page 265
Related Topics

Browser Module
Define a View Profile

1. Open the Browser Manager and expand the required browser group to display its
browsers.
2. Select the browser to which you want to add a view and do one of the following:
• Click Actions > Add View.
• Right-click the highlighted browser and then, on the shortcut menu,
click Add View.
• Click .
3. In the View Name field, type the name of the new browser view that you are
creating.
4. In the View Description field, type a brief description of the new browser view.
5. From the Display data at level list, to set the level on which to display the data in
the Browser View window. You can select any of the hierarchy levels that you
defined for the domain , for example, <Plant> , <Area>, <Unit>, or the level of
the domain itself.
Tips
• For an Instrument Index Standard Browser or Tag Number Browser,
you can also select Typical to create a browser view profile with only
typical tag and typical loop data.
• For an Instrument Type browser, you can create a browser view profile
on the domain level only.
6. Select the Set as default check box to make the current view the default view for
the browser to which this view belongs. This way, all the settings defined for this
view will be used to display the data in all the views belonging to the current
browser.
7. Select the Count per group check box to display in the print preview and the
printed view, the total number of rows contained in each group, delimited by the
group separator in the print preview.
8. Select the Personal view check box to make this view available to the current
user only. Other users will not be able to see this view under Browser Groups
and therefore will not be able to open it.
9. Click Save.
Tip
• You can now define the required style, sort, and filter settings for the
current browser view.
Related Topics
• Create a Sorting Sequence View, page 298

Browser Module
Add a New View

1. Start the Browser Manager by doing one of the following:
• Click File > Browser Manager.
• Click .
2. If the Browser View is open, then open the Browser Manager by doing one of
the following:
• Click Actions > Manager.
• Click .
3. In the Browser Manager, highlight the required browser in the Browser Groups
data window. For more information on how the browsers are organized, see
Browser Manager Hierarchy, page 271.
4. Define a view profile for the new browser view. For more information, see
Define a View Profile, page 264.
5. Define the style settings. For more details, see Create a View Style, page 286
6. Set a sorting sequence. For more details, see Create a Sorting Sequence View,
page 298
7. Define a filtering condition if needed. For more details, see Define a View Filter,
page 305
8. Click to open the new browser view.
Related Topics
• Select a Default Browser, page 263
Duplicate a View
• Click .
the following:
• Click .

Browser Module
3. In the Browser Manager, highlight the required browser in the Browser groups
• To duplicate all the view settings, highlight the view that you want to
duplicate.
• To duplicate only a selected view setting, expand the view and select
the Style, Sort or Filter icon as required.
• Click .
• Click Actions > Copy.
• Right-click the view you want to copy and then, on the shortcut menu,
click Copy.
6. Select the target browser and do one of the following:
• Click .
• Click Actions > Paste.
• Right-click the target browser and then, on the shortcut menu, click
Paste.
Notes
• You can duplicate the view with all its settings or only with the setting
(view, sort, or filter) that you select.
• You can duplicate browser views only if they belong to the same
browser.
• If you close the Browser Manager, the item you copied will be lost.
Related Topics

Browser Module
Copy a View to Another Plant

1. On the Browser Manager, select a view that you want to copy to another plant.
• Right-click and from the shortcut menu select Copy to Other Plant.
• Click Actions > Copy to Other Plants.
3. On the Copy View Settings dialog box, select a plant, and then click Copy.
Note
• If the same view name already exists in the target plant browser, the
software does not overwrite the settings of the target view, but creates
another view with the same name.
Related Topics
Modify a View Profile

• Click .
the following:
• Click .
4. Click Edit.

Browser Module
5. Modify the current view profile settings, by doing any of the following:
• In the View name field — modify the name of the browser view.
• In the View description field — add or change a brief description of
the browser view.
• From the Display data at level list — change the level on which to
display the data in the Browser View window.
• In the Set as default check box — select to make the current view
the default view for the browser, or unselect the check box so the
current view is not the default view for the browser.
• In the Count per group check box — select to display in the print
preview and the printed view, the total number of rows contained in
each group delimited by the group separator in the print preview, or
unselect the check box so this option will not work.
• In the Select the Personal view check box — select to make this
view available to the current user only, or unselect the check box so
this option will not work.
6. Click Save, to save the view profile with the settings you have just entered.
Related Topics

Browser Module
Delete a View
• Click .
the following:
• Click .
4. In the Browser groups data window, highlight the view you want to delete.
• Click
• Click Actions > Delete.
• Right-click and on the shortcut menu select Delete.
Related Topics

Browser Module
Find a Browser or Browser View

1. In the Browser Manager, do one of the following:
• Click .
• On the menu bar, click Actions > Find.
2. Select the Browser or View option button, depending on what you want to find.
3. In the data field, type the value that you want to find.
4. To match the retrieved values with the value you are searching for, do one of the
following:
• Select Whole Value to find only occurrences that are whole words
• Select String to find occurrences that are either whole words or part of
a word.
5. Click Find.
Tips
• During the search, the Find button changes to Stop, allowing you to
stop the search, if required.
• When an appropriate occurrence is found, the corresponding row is
automatically selected.
6. Click Find to find the next occurrence.
7. Click Close when finished.
Related Topics

Browser Module
Browser Manager Hierarchy

You define the viewing settings for a specific browser hierarchy level as shown
below (the following example is the hierarchy which is displayed in the Browser
Manager Browser Groups data window).
The Browser Group hierarchy is as follows:
First Level — Browser Group

Second Level — Browser
Third Level — View
Fourth Level — View settings
• Browser Group — The first level of the hierarchy stands for a

Browser Group which represents a module or an item (for example,
Control System). Each group can contain one or more predefined
Browsers.
• Browser — Each browser is associated with the relevant module data
(for example, Loop and Equipment in the Instrument Index) or item
whose data it displays. A Browser contains one or more viewing
templates or Views that you can select and modify to customize the
way the corresponding data will be displayed in the Browser View
window. Note that you cannot add or delete any browser group or
browser, nor can you change their names. You can only delete a
custom browser.
• View — Each view contains the following viewing settings that will
be used to display the data with which that view is associated: the
viewing style, sorting order, and filtering condition. You can add,
delete, modify, and duplicate the view profile to customize the way the
data will be displayed in the Browser View window.
Related Topics
• Add a New View, page 265
• Delete a View, page 269
• Display the Current Sorting Sequence, page 297
• Display the Current Style Setting, page 286
• Duplicate a View, page 265
• Modify a View Profile, page 267

Browser Module
Browser Types
For more information on the different browser types, see:
• Instrument Index Browser Group, page 273

• Process Data and Calculation Browser Group, page 275
• Instrument Specifications Browser Group, page 276
• Wiring Browser Group, page 276
• Hook-Ups Browser Group, page 277
• Loop Drawings Browser Group, page 278
• Control System Browser Group, page 278
• Dimensional Data Browser Group, page 279
• Construction and Commissioning Browser Group, page 280
• Document Binder Browser Group, page 281
• Documents Browser Group, page 281
• General Browser Group, page 282
• Telecom Browser Group, page 282
Related Topics

Browser Module
Instrument Index Browser Group

The following table lists all the available browsers, and their descriptions, within the
Instrument Index Browser Group.
Browser Description
Calibration Results Displays instruments and their attributes that include instrument
Browser calibration results. After filtering the fields, create a calibration
result analysis for a certain period, an instrument calibration list,
and so forth.
Calibration Settings Displays calibration settings (ranges, set points, alarm points,
Browser and so forth) for a selected instruments.
Circuit Related Displays data for tag numbers derived from SmartPlant
Electrical Tag Electrical signals for circuits. If a circuit relates to more than
Browser one electrical item, a separate data row appears for each item.
DDP and Index Displays instruments and their associated dimensional data for
Browser piping.
Drawing Summary Allows you to generate a drawing list for selected instruments.
Browser A drawing list may include specifications, process data sheets,
loop and hook-up drawings.
Electrical Power Displays electrical properties owned by SmartPlant
Element Browser Instrumentation and SmartPlant Electrical for instruments and
cabinets.
Electrical Tag Displays data for all tag numbers derived from SmartPlant
Browser Electrical signals for all items but does not retrieve data values
of associated attributes for signals created under circuits. The
software displays data for the main item and also associated
circuit data.
Equipment Browser Process equipment list for the current plant, area, or unit.
Fieldbus Tag Displays fieldbus instruments and their associated segments.
Number List You can create browser views to be used in the Fieldbus Tag
Browser Numbers browser to associate tags with segments.
Function Displays existing function requirement tag numbers and their
Requirement properties. The browser allows you to view and edit the data.
Browser

Browser Module
Instrument Allows you to pre-assign specific panels to selected device

Connection Pre- panels. This pre-assignment facilitates faster and more efficient
assignment Browser wiring design. The purpose of this pre-assignment is to enable
you to define an AutoWiring task for the pre-assigned panels as
well as providing a criterion by which to filter the cables so that
only pre-assigned device cables are displayed for connection
with panels.
Instrument In addition to the options available for the Instrument
Connection Pre- Connection Pre-assignment Browser, you can also display the
assignment Control System Tag data in the browser view.
(Advanced)
Browser
Instrument Index Allows you to display and edit tag numbers from the Instrument
Standard Browser Index module.
Instrument Type Displays a list of instrument types and their default profiles.
Browser This browser is especially useful when you need to define a
default profile for numerous instrument types at the start of a
project design.
JB – Index Displays existing field devices and their connections to junction
Browser boxes and terminals. Note that you can view only those field
devices that are connected to the junction box whose wiring is
continued from the other side of the terminal.
Line Browser Lists existing lines and their properties (except for process data),
and allows you to edit the properties.
Loop Browser Lists existing loop numbers and their properties, and allows you
to edit the properties. This browser does not show associated tag
numbers.
Maintenance Lists existing instruments for which work requests or repair
Schedule Browser forms have been issued. Also, displays the instruments for
which preventive maintenance has been scheduled.
Range Browser Displays the following range values: calibration range, process
data range, alarm and trip settings.
Tag Category Displays existing instrument tag numbers that have been
Browser associated with a tag category.
Tag Number Lists existing instrument tag numbers and their properties, and
Browser allows you to edit the properties.
Related Topics

Browser Module
Process Data and Calculation Browser Group

Process Data and Calculation Browser Group.
Browser Description
Analyzer Browser Lists the existing analyzers, and allows you to edit the associated
data. You can also include custom fields.
Control Valve Lists the existing control valves for process and calculation data,
Browser and allows you to edit the control valve properties. You can also
include custom fields.
Flow Instrument Lists the existing flow instruments for process and calculation
Browser data, and allows you to edit the flow instrument properties. You
can also include custom fields.
General Process Lists all the General Process Data field records, tag number
Browser custom field data, as well as specification and process data
custom field information.
Level Instrument Lists the existing level instruments for process data, and allows
Browser you to edit the level instrument properties. You can also include
custom fields.
Line Component Lists existing line measuring components for analyzers and
Browser allows you to edit the components.
Line Process Data Lists the line data for process data and calculation, and allows
Browser you to edit the line data. You can also include line custom field
data.
Pressure Lists the existing pressure instruments for process data, and
Instrument allows you to edit the pressure instrument properties. You can
Browser also include custom fields.
Relief Valve Lists the existing relief valves for process data and calculation,
Browser and allows you to edit the relief valve properties. You can also
include custom fields.
Temperature Lists the existing temperature instruments for process data and
Instrument calculation, and allows you to edit the temperature instrument
Browser properties. You can also include custom fields.
Related Topics

Browser Module
Instrument Specifications Browser Group
Browser Description
Specifications Browser Lists specifications and allows you to edit
them. You can also include drawing
custom field data.
Related Topics
Wiring Browser Group

Wiring Browser Group.
Browser Description
Auto-Wiring Routing Allows you to define and execute auto-wiring tasks for
Task Browser selected junction boxes and control system panels.
Cable Browser Lists all the available cables and their attributes.
Cable Set Browser Displays all the cable sets in the existing cables and allows you
to edit the cable sets. Only the cable set data can be edited.
Device Panel Displays field devices and their connections.
Browser
General Panel Displays existing panel data and allows you to edit the data.
Browser
I/O Card Browser Displays I/O card data and allows you to edit the data. This
browser also includes I/O card custom fields.
I/O Terminal Displays I/O terminal data and allows you to edit the data. You
Browser can also view the panels and I/O cards to which the terminals
belong.
Local Signal Browser Displays the existing local signals.
Rack Browser Displays the existing hardware racks and allows you to edit
them.
Slot Browser Displays existing slot data and allows you to edit the data.
Strip Browser Displays all the existing terminals and allows you to edit them.
You can also view the appropriate strips and panels.

Browser Module
Browser Description
Telecom Channel Displays channel data for telecom objects and allows you to
Data Browser edit the data.
Terminal Browser Displays the existing terminals and allows you to edit them.
Terminal Connection Displays terminal connection data. The data includes the
Browser connection on both sides of the terminals.
Wire Browser Displays wire data and also displays the cable sets and cables
to which the wires belong. You can edit the wire data as you
require.
Wire Connection Displays wire connection data. The data includes the
Browser connection on both sides of the wires.
Wiring Equipment Displays existing wiring equipment data and allows you to edit
Browser the data.
Related Topics
Hook-Ups Browser Group

Hook-Ups Browser Group.
Browser Description
Hook-Up Display and edit the existing hook-up types, and the associated
Browser hook-ups.
Item List Lists all the items from the Hook-Up Library.
Browser
Related Topics

Browser Module
Loop Drawings Browser Group

Loop Drawings Browser Group.
Browser Description
Block Browser Displays all the existing blocks and allows you to edit them.
Display the loop and tag numbers to which the blocks belong.
Enhanced Report Displays all loop numbers that are assigned to Enhanced Report
Utility Browser Utility drawing layouts. You can reassign loop numbers to any
available layout.
Loop Browser Displays all the existing loop drawings with their revisions and
generation types.
Related Topics
Control System Browser Group

Control System Browser Group.
Browser Description
NIM General Browser Displays all the tag numbers that have been assigned to
channels and associate these tags with appropriate point
types. This browser uses Honeywell-specific terminology.
Control System Tag Display all the tag numbers that have been assigned to
Browser channels and enter custom information for the displayed
tags.
Delta V Conventional Displays all the conventional tag numbers available for
Tag Browser publishing to Delta V.
Delta V Fieldbus Tag Displays all the fieldbus tag numbers available for
Browser publishing to Delta V.
NIM Analog Input Displays all the tag numbers with the point type defined as
Browser NIM Analog Input. You can also set the control system tag
parameters. This browser uses Honeywell-specific
terminology.

Browser Module
Browser Description
NIM Analog Output Displays all the tag numbers with the point type defined as
Browser NIM Analog Output. You can also set the control system
tag parameters. This browser uses Honeywell-specific
terminology.
NIM Digital Input Displays all the tag numbers with the point type defined as
Browser NIM Digital Input. You can also set the control system tag
parameters. This browser uses Honeywell-specific
terminology.
NIM Digital Output Displays all the tag numbers with the point type defined as
Browser NIM Digital Output. You can also set the control system
tag parameters. This browser uses Honeywell-specific
terminology.
Publish Yokogawa CST Displays Yokogawa conventional control system tags
(Conventional) Browser intended for publishing.
Publish Yokogawa CST Displays Yokogawa fieldbus control system tags intended
(FF) Browser for publishing.
Related Topics
Dimensional Data Browser Group

Dimensional Data Browser Group.
Browser Description
Default Data Displays default dimensional data for piping and allows you to
Browser edit the data.
Vendor Data Displays vendor dimensional data for piping and allows you to
Working Data Displays working dimensional data for piping and allows you to
Related Topics

Browser Module
Construction and Commissioning Browser Group

Construction and Commissioning Browser Group.
Browser Description
Cable Schedule Installation Lists all the cables for the current unit or plant where you
Index Browser can change the Electrical Installation Index, edit cable
descriptions, and so forth.
Cable Schedule Installation Lists all the plant or unit cables, their attributes,
Index Changes Browser installation index status and version.
Instrument Installation Allows you to generate an electrical, instrument, and
Index Browser mechanical installation report that includes the
appropriate drawing references.
Instrument Installation Displays electrical, instrument, and mechanical
Index Changes Browser installation changes that include the installation status
and version.
Panel Termination Displays the plant or unit device panels and their
Installation Index Browser electrical index.
Panel Termination Displays the plant or unit device panels with their
Installation Index Changes electrical installation index and installation changes.
Browser
Terminal Schedule Displays the plant or unit termination schedule and the
Installation Index Browser appropriate installation indexes.
Terminal Schedule Shows the plant or unit termination schedule and the
Installation Index Changes installation index changes.
Browser
Wiring Schedule Displays the plant or unit cable, cable set, and wire
Installation Index Browser connections and their appropriate installation indexes.
Wiring Schedule Displays the plant or unit cable, cable set, and wire
Installation Index Changes connections and their installation index changes.
Browser
Related Topics

Browser Module
Document Binder Browser Group
Browser Description
Spec Binder Allows you to generate a browser that includes tag numbers
Package belonging to a Specification Binder package, tag number attributes,
Browser package item number, and specification data.
Related Topics
Documents Browser Group

Documents Browser Group.
Browser Description
Archive Allows you to generate a document list of all archived documents
Browser associated with the report names that you selected in the Admin module
for archiving, and then view and compare archived reports.
Drawing Allows you to generate a document list that shows the document name,
Browser type (P&ID, process data, calculation, specification, loop, or hook-up
drawing), and custom field data.
Revision Allows you to generate a document revision browser that includes all
Browser drawings in the plant hierarchy and all their revisions.
Changes Log These browsers allow you to generate reports that show when changes
Browsers were made to the item type. You can generate reports for Cables,
Control System Tags, Equipment, Instruments, Lines, Loops, Panels,
and Wiring Equipment.
Related Topics

Browser Module
General Browser Group

General Browser Group.
Browser Description
Changes Log Displays changes to property values for items at the selected plant
Browser hierarchy level. This browser is only visible when the System
Administrator selects the Item registry check box for the domain.
Task Displays tasks available in the To Do List (that is, tasks generated after
Browser you retrieve documents.
Related Topics
Telecom Browser Group

Process Data and Calculation Browser Group.
Browser Description
End Point Amplifier Browser Displays existing end point amplifier data
and allows you to edit the data.
End Point Hub Browser Displays existing end point hub data and
allows you to edit the data.
End Point Intercom Browser Displays existing end point intercom data
End Point Miscellaneous Browser Displays existing end point miscellaneous
equipment data and allows you to edit the
data.
End Point PABX Browser Displays existing end point PABX data
Hub Cabinet Browser Displays existing hub cabinet data and
Hub Equipment Browser Displays existing hub equipment data and
Intercom Cabinet Browser Displays existing intercom cabinet data

Browser Module
Browser Description
Intercom Equipment Browser Displays existing end point intercom
data.
Miscellaneous Cabinet Browser Displays existing miscellaneous cabinet
data and allows you to edit the data.
Miscellaneous Equipment Browser Displays existing miscellaneous
data.
PA Cabinet Browser Displays existing PA cabinet data and
PABX Cabinet Browser Displays existing PABX cabinet data and
Port-Data Browser Displays existing port data and allows you
to edit the data.
Related Topics

Browser Module
Style Settings: An Overview

You define style settings as part of the browser view customization. Style options
allow you to display or define the style settings for a browser view that you select in
the Browser groups pane. SmartPlant Instrumentation then uses these style settings
to display your data associated with the current browser.
Style settings include the following options:
• Determining which fields the software displays in the Browser View

window.
• Setting the order and width of the selected fields and determining how
they appear in the Browser View window.
• Customizing the layout of a browser view for printing.
• Printing out the style setting data.
Related Topics
• Style Settings Common Tasks, page 284
Style Settings Common Tasks

The following tasks are used frequently when customizing browser views in
Display the Current Style Setting

This option shows you how to display the current style settings of the browser view
that you select from the Browser groups list in the Browser Manager. If you have
not yet defined a view profile for a selected browser, no style settings are available.
For more information, see Display the Current Style Setting, page 286.
Create a View Style

You use this option to create new style settings for a selected browser view. For
more information, see Create a View Style, page 286.
Modify Style Settings

This option enables you to modify existing style settings for a selected browser view.
For more information, see Modify Style Settings, page 289.

Browser Module
Structure the Print Layout

This option shows you how to structure the print layout of the data when printing out
the data displayed in a customized Browser View window. You can select the fields
that you want to be displayed in the print preview and the printout as well as do the
following:
• Sequence the columns.

• Set the column width.
• Define the number of fields per column: a single field per column or
multiple (no more than five) fields per column.
• Set the text and header font size.
• Set the header height.
For more information, see Structure the Print Layout, page 292.
Clear a Layout Structure

This option shows you how to clear the existing print preview layout structure
defined for the current browser view without clearing all the style settings for this
browser view. For more information, see Clear a Layout Structure, page 293.
Duplicate a View Style

This option shows you how to copy view style settings to another existing browser
view. Note that this action overwrites the target style settings with the duplicated
style settings. For more information, see Duplicate a View Style, page 294.
Clear a View Setting

Use this option to clear all the style settings for a selected browser view. For more
information, see Clear a View Setting, page 289.
Print the Style Setting Data

Use this option to print out all the data that appears in the Style settings data window.
You can print out the data for all the fields or just for the ones you have selected to
view. For more information, see Print the Style Setting Data, page 295.
Related Topics

Browser Module
Display the Current Style Setting

• Click .
the following:
• Click .
data pane. For more information on how the browsers are organized, see Browser
Manager Hierarchy, page 271.
4. Expand the required browser view in the Browser Groups data window and do
• In the Browser Groups data window, click .
• In the upper-right data window, double-click .
The fields currently used in the selected style are listed in Style field list pane, to
the right of the Browser groups pane. The current style settings of the selected
view are displayed in the lower pane.
Related Topics
Create a View Style

• Click .
the following:
• Click .
3. In the Browser Manager, add a new view profile or edit an existing one.

Browser Module

• In the Browser groups data window, click .
• In the upper-right data window, double-click .
5. On the lower Style pane, click Edit.
6. In the Name data field, type the new style name (defaults to Style followed by a
number).
7. Select the Enable in explorer windows check box to make the current browser
view available in the Domain Explorer, Reference Explorer, and all the other
explorer windows in SmartPlant Instrumentation. After selecting this check box
and saving the style settings, the current browser view becomes available in the
Show Browser dialog box that you open from an explorer window.
8. Do one of the following to select the fields to be displayed in the browser view:
• Select the appropriate View check boxes, by scrolling down the Style
settings data window and selecting the required fields individually.
Note that the primary value field is always selected, and a check mark
appears in its View check box by default.
• Select the All check box in the Select group box, to select all the
available fields.
• Select the Custom check box in the Select group box to select all the
custom fields.
• Select the Non-custom check box in the Select group box to select all
the fields that are not custom fields.
9. Click the Data Field Header box to customize the header.
Tips
• Data field headers that you customize appear in the browser view
column headers when using the current style to view the data. You
can customize any data field header.
• In addition to the database fields provided to you by default, the
Browser Manager also provides you with custom fields, which you
can use to complement data attributes. A user with Domain
Administrator rights can make default custom field definitions in the
Administration module.
10. Click in the Length data field to edit the field's maximum number of characters
displayed in the Browser View when using the current style to view the data.
11. If you want to display in the Browser View print preview or print out the sum or
average value of any numeric field, select its Sum and/or Avg. check box. For
non-numeric fields, the Sum and Avg. check boxes are disabled.

Browser Module
12. To set the sorting options, do one of the following:

• Click on any header (Data Field header, Table Column Name,
Length, View, Sum, or Avg.) to sort the fields that appear in the Style
settings section in an ascending order (click again on the same header
to sort the displayed fields in a descending order.)
• Select the Default Sort check box when available to revert to the
default sorting order (the way the fields are arranged in the database).
The Default Sort option is available only if you changed the sort order
by clicking on any header in the Style settings screen section.
13. To set the width and sequence of the selected fields, do the following:
a. Click Customize to open the Column Layout dialog box.
b. To change the field sequence, drag the header of the field that you want to
move to the left or to the right, then release the mouse button to drop the
column in the new location.
c. To resize the column width, point to the right or left edge of the column you
want to resize so that the mouse pointer changes its shape to a double-headed
arrow. Drag the column edge either to the left or to the right until the column
matches the required width.
14. Click OK to close the Column Layout dialog box and save the changes that you
made to the column layout field and the style settings.
Tip
• Clicking OK in the Column Layout dialog box saves the new
column layout field and the changes you made to the style settings in
the Browser Manager. Therefore, when you return to the Browser
Manager the Save button automatically changes to Edit. Clicking
Cancel returns you to the Style settings to continue creating your view
style.
15. If changes have been made that have not been saved, the Save button will be
visible, click Save to save your new style settings.
Note
• In the Style settings data window, red is used to symbolize a selected
field. Yellow is used to symbolize a read-only field which cannot be
accessed in the browser for data editing. You can set a different color
for the read-only fields.
Related Topics

Browser Module
Clear a View Setting

• Click .
the following:
• Click .
3. In the Browser Manager, display the style settings you want to modify. For
more information, see Display the Current Style Setting, page 286.
4. Click Edit.
• Click .
Related Topics
Modify Style Settings

• Click .
the following:
• Click .
3. In the Browser Manager display the style settings you want to modify.
4. On the lower Style pane, click Edit.
5. In the Name field, type the new style name (defaults to Style followed by a
number).

Browser Module
6. Do one of the following to select the fields to be displayed in the browser view:
• Select the appropriate View check boxes, by scrolling down the Style
settings data window and selecting the required fields individually.
Note that the primary value field is always selected, and a check mark
appears in its View check box by default.
• Select the All check box in the Select group box, to select all the
available fields.
• Select the Custom check box in the Select group box to select all the
custom fields.
• Select the Non-custom check box in the Select group box to select all
the fields that are not custom fields.
7. Click the Data Field Header box to customize the header name.
Tips
• Data Field Headers that you customize appear in the browser view
column headers when using the current style to view the data. You
can customize any Data Field Header.
• In addition to the database fields provided to you by default, the
Browser Manager also provides you with custom fields, which you
can use to complement data attributes. A user with Domain
Administrator rights can make default custom field definitions in the
8. Click in the Length data field to edit the field's maximum number of characters
displayed in the Browser View when using the current style to view the data.
9. If you want to display in the Browser View print preview or print out the sum or
average value of any numeric field, select its Sum and/or Avg. check box. For
non-numeric fields, the Sum and Avg. check boxes are disabled.
10. To set the sorting options, do one of the following:
• Click on any header (Data Field Header, Table Column Name,
Length, View, Sum, or Avg.) to sort the fields that appear in the Style
settings section in an ascending order (click again on the same header
to sort the displayed fields in a descending order.)
• Select the Default Sort check box when available to revert to the
default sorting order (the way the fields are arranged in the database).
The Default Sort option is available only if you changed the sort order
by clicking on any header in the Style settings screen section.

Browser Module
11. To set the width and sequence of the selected fields, do the following:
a. Click Customize to open the Column Layout dialog box.
b. To change the field sequence, drag the header of the field that you want to
move to the left or to the right, then release the mouse button to drop the
column in the new location.
c. To resize the column width, point to the right or left edge of the column you
want to resize so that the mouse pointer changes its shape to a double-headed
arrow. Drag the column edge either to the left or to the right until the column
matches the required width.
12. Click OK to close the Column Layout dialog box and save the changes that you
made to the field layout and the style settings.
Tip
• Clicking OK in the Column Layout dialog box saves the new field
layout and the changes you made to the style settings in the Browser
Manager . Therefore, when you return to the Browser Manager the
Save button automatically changes to Edit. Clicking Cancel returns
you to the Style settings to continue creating your view style.
13. If changes have been made that have not been saved, the Save button will be
visible, click Save to save your new style settings.
Note
• In the Style settings data window, red is used to symbolize a selected
field. Yellow is used to symbolize a read-only field which cannot be
accessed in the browser for data editing. You can set a different color
for the read-only fields.
Related Topics

Browser Module
Structure the Print Layout

• Click .
the following:
• Click .
3. In the Browser Manager display the style settings you want to modify.
4. Click Edit.
5. Click Layout to open the Define Print Layout dialog box.
6. Select a field from the Column Header pop-up window and drag it to the field
where you want it to appear. Your print layout can take the form of single fields
in each column or multiple (no more than 5) fields in a column. Remember that
the fields that you do not select from the Column Header pop-up window will
not show up in the printout even though they exist in the current browser. Note,
however, that if you decide to display two or more fields in a column, the printed
out report will not display the Group Row Count, nor will it show the sum
and/or average field values even if you have selected these options.
7. Click Font to open the Customize Font Size dialog box, where you can
customize the column and header font size as well as the column and header
height.
8. Set the font sizes as required using the spinners:
a. Use the Column Font Size spinner to define the font size.
b. Use the Column Height spinner to define the column height. Note that if you
do not define the column height before generating the layout, the Define Print
Layout dialog box does not display any data.
c. Use the Header Font Size spinner to define the header font size.
d. Use the Header Height spinner to define header height size.
9. Click OK to accept your settings and return to the Define Print Layout dialog
box.
10. Click Generate to open the Generate Print Layout dialog box where you
customize the column sequence and size.

Browser Module
11. Set the layout structure as follows:

a. Set the column sequence by dragging the column header to the required
position.
b. Set the column size by dragging the edge of the column either to left or to the
right.
c. Click OK to accept the settings and return to the Define Print Layout dialog
box.
12. Click Save to save all the settings and close to the Define Print Layout dialog
box.
Related Topics
Clear a Print Layout Structure

• Click .
the following:
• Click .
4. Click Edit.
5. Click Print Layout.
6. In the Print Layout dialog box, click Clear.
7. Click Save.
Related Topics

Browser Module
Duplicate a View Style

• Click .
the following:
• Click .
4. Select the style that you want to duplicate.
• Click .
• Right-click the highlighted style in the Browser groups data window
and then, on the shortcut menu, click Copy.
6. Navigate to the target style whose settings you want to replace with ones you
copied.
7. Highlight the selected target style.
Important
• If you close the Browser Manager at this stage, you cannot paste the
duplicated style settings.
• Click .
• Right-click and on the shortcut menu, click Copy.
Related Topics

Browser Module
Print the Style Setting Data

• Click .
the following:
• Click .
3. Click Print to open the Print Preview window.
4. In the Show Fields group box, do one of the following:
• Select All to display and print out all the data for all the fields
appearing in the Style settings screen section.
• Select Selected to display and print out the data for only those fields
that you selected to be viewed.
5. Perform any of the following actions as required:
• Click Zoom to select your preview magnification level.
• Click Save As to save the data as an external file.
• Click Print to start printing.
Related Topics

Browser Module
Sort Settings: An Overview

A browser view sorting sequence determines the sequence in which the selected rows
are displayed in the Browser View window. In addition to defining a sorting
sequence for the Browser View window, you also determine whether the displayed
rows will be sorted in an ascending or descending order. Note that you will also be
able to sort the selected fields in the Browser View window that will override your
sort sequence settings. You can perform the following activities:
• Create and modify a view sorting sequence.

• Duplicate a view sorting sequence.
• Clear the existing view sorting sequence settings.
Related Topics
• Sort Settings Common Tasks, page 296
Sort Settings Common Tasks

The following tasks are used frequently when you define the sorting sequence for
your browser view.
Display the Current Sorting Sequence

This option shows you how to display the current sorting sequence for an existing
browser view that you select from the Browser Groups list in the Browser
Manager. Note that if you have not yet defined a view profile for a selected browser,
no sorting sequence will be available. For more information, see Display the Current
Sorting Sequence, page 297.
Create a Sorting Sequence View

This option shows you how to create a new sorting sequence for a selected browser
view. For more information, see Create a Sorting Sequence View, page 298.
Modify a Sorting Sequence View

This option shows you how to modify an existing view sorting sequence. For more
information, see Modify a Sorting Sequence View, page 299.
Duplicate a Sorting Sequence View

This procedure shows you how to copy an existing sorting sequence to another
existing browser view. This action overwrites the target sorting sequence with the
duplicated style settings. For more information, see Duplicate a Sorting Sequence
View, page 300.

Browser Module
Clear a Sorting Sequence Setting

This option shows you how to remove an existing sorting sequence. For more
information, see Clear a Sorting Sequence Setting, page 301.
Related Topics
Display the Current Sorting Sequence

• Click .
the following:
• Click .
3. In the Browser Manager, expand the required browser group, to navigate to the
browser view in the Browser groups data pane. For more information on how
the browsers are organized, see Browser Manager Hierarchy, page 271.
4. Expand the required browser view in the Browser groups data pane and do one
of the following:
• In the Browser groups data pane, click .

• In the upper-right data pane, double-click .
Note
• The fields currently selected for the sorting sequence are listed in the
right data pane (with the caption Sort field list) and the current sorting
sequence of the selected view is displayed in the lower data pane. You
can now modify the sorting sequence as needed.
Related Topics

Browser Module
Create a Sorting Sequence View

• Click .
the following:
• Click .
3. In the Browser Manager, add a new view profile or edit an existing one. For
more details, see Define a View Profile, page 264.
of the following:

5. Click Edit.
6. In the Name box, type the required sorting sequence name (defaults to Sort
followed by a number).
7. Under Data Field Header, from the list of database fields, select a sort field
according to which you want the data to be sorted in the browser view.
Tips
• For any browser view that supports sorting data by tag numbers, you
can sort tag numbers according to the numeric segment. From the
Data Field Header list, select Tag Trans Name, and define the sort
sequence in the Start Char and Length fields.
• For any browser view that supports sorting data by loop numbers, you
can sort loop numbers according to the numeric segment. From the
Data Field header list, select Loop Trans Name, and define the sort
sequence in the Start Char and Length fields.
8. In the Start Char. data field, type the starting position of the current segment,
i.e., the selected sorting field leftmost character.
9. In the Length data field, type the total number of characters (from the starting
character) the selected sorting field will contain.
10. Under Order, clear the Ascending check boxes if you want the data to be sorted
and displayed in the Browser in a descending order. The default setting is
Ascending.
11. Click Insert to insert a sorting field before the one currently selected in the Sort
settings group box.

Browser Module
12. Click Delete to remove the currently selected field from the sorting sequence.
13. To resize and re-sequence the fields currently displayed in the Sort settings group
box, do the following:
a. Drag and drop a field to a new position to change the field sequence.
b. To change the width of a field, position the cursor on the border between two
fields and then drag the order to the right or to the left.
14. Click Save to save the new sorting sequence. The Sort Field List data window
displays the sorting sequence you have created.
Related Topics
Modify a Sorting Sequence View

• Click .
the following:
• Click .
of the following:

4. Click Edit.
5. In the Name box, type the required sorting sequence name (defaults to Sort
6. Under Data Field Header, from the list of database fields, select a sort field
according to which you want the data to be sorted in the browser view.
7. In the Start Char. data field, type the starting position of the current segment,
i.e., the selected sorting field leftmost character.
8. In the Length data field, type the total number of characters (from the starting
character) the selected sorting field will contain.
9. Under Order, clear the Ascending check boxes if you want the data to be sorted
and displayed in the Browser in a descending order. The default setting is
Ascending.

Browser Module
10. Click Insert to insert a sorting field before the one currently selected in the Sort
settings group box.
11. Click Delete to remove the currently selected field from the sorting sequence.
12. To resize and re-sequence the fields currently displayed in the Sort settings group
box, do the following:
a. Drag and drop a field to a new position to change the field sequence.
b. To change the width of a field, position the cursor on the border between two
fields and then drag the order to the right or to the left.
13. Click Save to save the modified sorting sequence. The Sort Field List data
window displays the sorting sequence you have created.
Related Topics
Duplicate a Sorting Sequence View

• Click .
the following:
• Click .
3. Expand the Browser groups tree to display the sort sequence you want to
duplicate.
4. Highlight the sorting sequence, and do one of the following:
• Click .
5. Navigate to the target sorting sequence whose setting you want to replace with the
copied settings.
6. Highlight the sorting sequence, and do one of the following:
• Click .
Related Topics

Browser Module
Clear a Sorting Sequence Setting

• Click .
the following:
• Click .
of the following:

4. Click Edit.
• Click .
Related Topics

Browser Module
View Filter Settings: An Overview

This option enables you to define a filtering condition which will be used to filter the
data associated with the selected browser view.
You can use any of the following parameters in the filter:
• Data Field Headers.

• Operators and functions.
• Logical expressions: And -or- Or.
ImportantBETWEENSelect an alphanumeric value that is between the stated
expression.Price between 150 and 250LIKE (value)Select a similar value that is
similar to the one in the `[value]' field.
You can use the following wildcard characters:
% - any combination of characters.
_ - any single character.Tag Number LIKE `%AA%'
Process Function Name LIKE P__IS NULLContains an undefined valueService IS
NULLIS NOT NULLNot equal to NULLLoop Number IS NOT NULLANDInclude
the following expression in the filter combination.ORAccept either the previous or
the following expression in the filter expression
Related Topics
• View Filter Settings Common Tasks, page 303
• A complex filter condition may take longer to retrieve your data. For
this reason, performing an ÒR' operation is more time-consuming
than performing an ÀND' operation.
The following table lists the built-in operators and functions available to you when
defining the filter settings:
Operator/Function Description Example

= Equal to Manufacturer = "Shell"
> Greater than Tag Number > 101
<</TD> Less than Process Function Name <
'P'
>= Greater or equal to Velocity >= 10
<= Less than or equal to Low Alarm <= 30
<> Not equal to Loop Prefix <> AA

Browser Module
View Filter Settings Common Tasks

The following tasks are used frequently when working with filter settings in a
browser view.
Display the Current View Filter Condition

You use this option to display the current filter condition of browser view that you
select from the Browser groups list in the Browser Manager. If you have not yet
defined a filter condition for a selected browser, no filter settings will be available.
For more information, see Display the Current View Filter Condition, page 304.
Define a View Filter

This procedure shows you how to define a new filter condition for a selected browser
view. For more information, see Define a View Filter, page 305.
Modify a View Filter

This option shows you how to modify an existing filter condition for a selected
browser view. For more information, see Modify a View Filter, page 306.
Duplicate a View Filter

This option enables you to copy an existing filter condition to another existing
browser view. This action overwrites the target filter condition with the duplicated
filter condition. For more information, see Duplicate a View Filter, page 307.
Clear View Filter Settings

This option shows you how to clear the filter condition for a selected browser view.
For more information, see Clear View Filter Settings, page 308.
Related Topics

Browser Module
Display the Current View Filter Condition

• Click .
the following:
• Click .
of the following:
Note
• The filter condition you define is displayed in the Filter field list in
the right data pane.
Related Topics

Browser Module
Define a View Filter

• Click .
the following:
• Click .
of the following:
5. Click Edit.
6. In the Name data field, type the required filter condition name (defaults to Filter
7. Click the Data Field Header and select an appropriate tag number attribute
according to which you want to filter the data in the Browser View window.
Tip
• The Data Field Header list contains all the fields that are used for the
data that the current browser is associated with.
8. Click the Operator data field and select a suitable operator to determine how the
tag number attribute selected from the Column Name list will relate to the
expression in the Value field. For more information on filter operators, see View
Filter Settings: An Overview, page 302.
9. In the Value data field, select or type a suitable value to determine how the tag
number attribute selected from the Column Name list are specified.

Browser Module
10. Depending on whether you want to add another filtering condition, in the Logical
data field, do one of the following:
• Leave the field empty if the condition is the last one in the list.
• Click the field and select either And or Or as the logical function from
the list if the condition is to be followed by another one. Select And to
include the following expression in the filter condition. Select Or to
accept either the previous or the following expression in the filter
condition.
11. Click Verify to verify the current filtering condition.
• Click Insert to append new a data line.
• Click Delete to delete the currently selected data line.
• Click Save to save the new filter settings.
Tip
• The Filter field list data pane displays the filter condition you have
just defined.
Related Topics
Modify a View Filter

• Click .
the following:
• Click .
3. Expand the browser view you want to modify in the Browser groups data pane
and do one of the following:
4. Click Edit.
5. In the Name data field, type the required filter condition name (defaults to Filter

Browser Module
6. Click the Data Field Header and select the field from the list.
Tip
• The Data Field Header list contains all the fields that are used for the
data that the current browser is associated with.
7. Click the Operator data field and select the required operator from the list.
8. In the Value data field, select or type a suitable value.
9. Depending on whether you want to add another filtering condition, in the Logical
data field, do one of the following:
• Leave the field empty if the condition is the last one in the list.
• Click the field and select either And or Or as the logical function from
the list if the condition is to be followed by another one.
10. Click Verify to verify the current filtering condition.
• Click Insert to append new a data line.
• Click Delete to delete the currently selected data line.
• Click Save to save the new filter settings.
Tip
• The Filter field list data pane displays the filter condition you have
just defined.
Related Topics
Duplicate a View Filter

• Click .
the following:
• Click .

Browser Module
3. Expand the browser view you want to duplicate in the Browser groups data pane
and do one of the following:
• Click .
4. Navigate to the target filter condition that you want to replace with the one you
copied.
5. Highlight the selected filter condition, and do one of the following:
• Click .
Related Topics
Clear View Filter Settings

• Click .
the following:
• Click .
3. In the Browser groups pane, expand the browser view you want to clear the
view filter settings from, and do one of the following:
• Click .
Related Topics

Browser Module
Adding New Browsers: An Overview

SmartPlant Instrumentation is supplied with predefined browsers for you to view and
manipulate your data. In addition you can add two kinds of browser that can be
customized extensively. These two types of browsers are added to the Browser
Manager where you can use them just like any of the other supplied browsers. The
two browsers are:
• Form Browsers — a browser for every form that you generate and
save in the Spec Data Dictionary.
• Powersoft Browsers— a browser you create as a .psr report or a .pdb
file using InfoMaker.
Related Topics
• Adding New Browsers Common Tasks, page 309
Adding New Browsers Common Tasks

The following tasks are used when you add a new Form or PowerSoft Browser in
Create a New Browser for SmartPlant Instrumentation

In addition to the shipped browsers that are available in SmartPlant Instrumentation,
you can create custom browsers using InfoMaker. Using InfoMaker to create a
custom browser gives you complete flexibility to specify any number of tables, fields,
and database views, as you require.
You can create single custom browsers as .psr files or save a group of custom
browsers in a .pbl library. Then, in the Browser module, you can import several
browsers from a library or import a single .psr file.
Notes
• You must have a connection to the SmartPlant Instrumentation
database to be able to select SmartPlant Instrumentation tables and
fields.
• The procedure includes only those steps in InfoMaker that are required
for creating a new browser for SmartPlant Instrumentation.
For more information, see Create a New Browser for SmartPlant Instrumentation,
page 311.

Browser Module
Add a Form Browser

This procedure enables you to add form browsers to the Specifications browser
group. The basis for a form browser is a spec form with database fields you made
available using the Field Properties options of the Spec Data Dictionary. When
you generate such a form in the Specifications module, take into consideration the
following:
• Fields that you do not define in the Spec Data Dictionary are not
available for a form browser.
• A form browser displays the header text that you set in the Spec Data
Dictionary. This text can differ from the header text in the actual
forms, and in the specifications based on these forms.
• You can add one form browser for each form.
For more information, see Add a Form Browser, page 313.
Add a Powersoft Browser

This advanced shows you how to add a browser created in InfoMaker to an existing
browser group in the Browser Manager. This browser can be created in InfoMaker as
a .psr or .pbd file. For this browser to be fully compatible with the Browser module,
you must follow specific rules when creating the browser in InfoMaker.
Important
• Only proficient users who have advanced knowledge of the database
structure should attempt this advanced feature.
For more information, see Add a Powersoft Browser, page 313.
Related Topics

Browser Module

1. Click File > New.
2. On the New dialog box, on the Library tab, double-click the library icon and
create a .pbl library where you can group newly-created browsers.
3. Reopen the New dialog box and click the Object tab.
4. Select Grid for the report layout and click OK.
5. In the Grid Report Generator Wizard, select SQL Select, and then complete
the Wizard steps.
6. On the Select Tables dialog box, select the tables that you require.
7. In the Select window, do the following:
a. Select fields from the tables.
b. Select a primary key from each table.
8. Click the Return icon to open the Select Color and Border Settings dialog
box, where you can set the browser colors. After setting the browser colors, click
Next and then click Finish to display the Report preview window.
9. In the report preview window, click the Data Source icon to reopen the Select
window.
a. On the Design menu, click Convert to Syntax to convert the selected fields
from the graphic mode to the syntax mode.
b. Remove all the quotation marks (") from the displayed SQL statement.
The following example shows how the final SQL statement should appear:
SELECT component.cmpnt_name,
component.cmpnt_serv,
loop.loop_name,
loop.loop_serv, component.cmpnt_id,
loop.loop_id
FROM component,
loop
WHERE (loop.loop_id=component.loop_id )
loop

Browser Module
11. Return to the report preview window and do the following:

a. Set the header font style to MS Sans Serif, 8 point, Bold.
b. Protect fields that you want to reserve for internal use (do not protect the
primary keys) by the protected column attribute to 1 (one).
c. For each header name, use the following naming convention: <column
name>_t. For example, cmpnt_name_t.
d. For each field name, use the following naming convention: <column name>.
For example, cmpnt_name.
e. Delete the flag_color field, and also delete all the columns that contain
primary keys (the primary keys remain in the SQL statement).
12. Save the report data in one of the following ways:
• Without previewing, click Save As to save the report in the specially
created .pbl library.
• Save the report as a stand-alone .psr file.
13. If you saved the report in the .pbl library, do the following:
a. Copy the .pbl file to another location, preferably to the SmartPlant
Instrumentation home folder, and then change the file extension from .pbl to
.pbd.
b. In the [CUSTOM] section of your Intools.ini file, add the following line
(including the full pathname of the .pbd file): LibraryList=XYZ.pbd.
Related Topics
• Add a Powersoft Browser, page 313

Browser Module
Add a Form Browser

1. Start the Browser Manager.
2. Click Browser > Form Browser, to open the Add a Form Browser dialog box.
3. Select the specification forms for which you want to add browsers to the
Specifications browser group.
4. Click Add.
Note
• You can display the Notes field in a view defined in the Specifications
browser group and modify the contents one line at a time. To ensure
that each new line will be visible in the specification itself, press Ctrl
+ Enter to add a carriage return.
Related Topics
Add a Powersoft Browser

Important
• You must follow specific rules when creating a new browser in
InfoMaker. For more details, see Create a New Browser for
SmartPlant Instrumentation, page 311
1. Start the Browser Manager.
2. Click, Browser > Powersoft Browser.
3. In the Add a Powersoft Browser dialog box, click Browse next to the File Name
field.
4. In the Select a Powersoft File dialog box, do one of the following:
• Navigate to a desired .psr file.
• Navigate to a desired .pbd file and then, in the data window of the Add
a Powersoft Browser dialog box, select one or more Powersoft forms
belonging to the specified .pbd file.
Tip
• When defining settings for multiple Powersoft forms belonging to the
specified .pbd file, use the Previous and Next buttons, or click Form
List and then select a Powersoft form for which you want to define
browser settings.
5. Click OK to open the Powersoft Browser Settings dialog box.

Browser Module
6. In the Browser field, type the name of the target browser.

7. In the Description field, type the new browser description.
8. From the Primary table list, select the primary table for the new browser. This
list contains all the tables that you selected when creating the report in InfoMaker.
9. From the Primary value list, select the value for the primary key name of the
new browser. For example, in the COMPONENT table, the primary value is
CMPNT_NAME.
10. From the Browser group list, select a browser group to which you want to assign
the new browser.
11. From the Access right item list, select the item for the access rights definition.
For example, MODULE ACCESS – INDEX.
12. From the Default sort list, select the default sort value.
13. From the Item for enhanced reports list, select an item on which to apply the
Enhanced Report Utility macro filter.
Important
• An Enhanced Report Utility macro filter is a filter for which you
define conditions for displaying macro attributes in Enhanced Report
Utility drawings. After you select an item from this list, in the Loop
Drawings module, you can set filter conditions for Enhanced Report
Utility drawings that use this browser data. For details, see Set Filter
Conditions for Item Properties in the Enhanced Report Utility Guide,
under Using the Enhanced Report Utility, Using Filters, Set Filter
Conditions for Item Properties.
Tip
• If you want to work with the new browser in the Instrument Index
module, select the Define as browser for Instrument Index module
check box.
Related Topics

Browser Module
Browser Views: An Overview

A browser view is the customized presentation of your instrument index data. The
data displayed in a browser view depends on the settings you selected when creating
that view. Each browser view is associated with a particular browser that allows you
to retrieve data pertinent to the associated SmartPlant Instrumentation module. You
can create multiple browser views for the same browser to meet different
requirements. Each browser view has its own style settings, filter, and sorting
sequence. You can also select a default browser whose settings will be used to
display data in the Browser View window. Default settings take effect only when
you start the Browser module from one of the other modules.
All Browser View access rights correspond to the access rights of the appropriate
item type.
Note
• You can select a new P&ID drawing number from the P&ID list and
have this drawing number propagated to all tag numbers associated
with the current loop. After saving the settings, the new P&ID appears
selected in both the Loop Browser View window in the browser
module and in the Tag Number Properties dialog box in the
Instrument Index module. Before using this feature, make sure that in
the Instrument Index module, in the Loop Number Properties dialog
box, the Apply P&ID check box is selected.
Related Topics

Browser Module
Browser Views Common Tasks

The following tasks are used frequently when working in a Browser View to change
view settings on the fly, and to edit your data.
Open a Browser View

This option shows you how to open a Browser View window. For more information,
see Open a Browser View, page 318.
Edit Data in a Browser View

This option shows you how to edit your data in a Browser View window. For more
information, see Edit Data in a Browser View, page 319.
Modify and Save a Field Layout

This procedure is used to modify and save a field layout for a browser style in the
Browser View window directly, without having to structure the print layout from the
Browser Manager. In the Browser View window, prior to saving the field layout,
you can modify the following layout settings:
• Column sequence.
• Column width.
For more information, see Modify and Save a Field Layout, page 319.
Pre-Assign Junction Boxes to Device Panels

You use this feature to pre-assign specific junction boxes to selected instruments.
This pre-assignment serves several purposes:
• Pre-assign the required junction boxes to define an Auto-Wiring

routing task.
• Connect multiple pre-assigned device cables in batch mode.
• Filter the display of cables in the Domain Explorer so that only pre-
assigned device cables for connection with junction boxes are
displayed.
For details, see Pre-Assign Junction Boxes to Device Panels, page 580.
Browser View Buffer

This option shows you how to use the Browser View Buffer data window to copy
data from one row and update multiple rows in a batch with that data. For more
information, see Browser View Buffer, page 321.

Browser Module
Clear Data from the Buffer

This procedure shows you how to clear the stored data from the buffer. You can clear
the entire buffer or the data in the currently selected field. For more information, see
Clear Data from the Buffer, page 322.
Sort Displayed Rows

This option shows you how to modify the current sorting settings which were defined
in the Browser Manager. For more information, see Sort Displayed Rows, page 322.
Count Displayed Rows

This option shows you how to count the displayed rows. For more information, see
Count Displayed Rows, page 322.
Refresh Displayed Data

This option shows you how to refresh the displayed data with the data from your
database. The data which is displayed in the Browser View window is not kept
automatically up-to-date. Therefore, you need to manually refresh the displayed data
to view updated data. For more information, see Refresh Displayed Data, page 323.
Find a Value in a Specific Column

This procedure shows you how to search a selected column in a Browser View for a
specific value. The following search options are available:
• Search for a whole value.

• Search for a phrase or a sub-string.
• Search the column for a value as you type it in.
For more information, see Find a Value in a Specific Column, page 323.
Select Non-Editable Field Indication Color.

This procedure shows you how to change the color used in the Browser View to
mark fields which are not accessible for editing. For more information, see Select
Non-Editable Field Indication Color, page 324.
Open a Module from a Browser View

This option enables you to open the relevant module directly from the Browser View
window. In other words, the Browser module will open for you the appropriate
module for the item you select in the Browser View window. For example, if you
select a loop in the Loop Browser view of the Instrument Index browser, you can
automatically open the Loop Number dialog box to edit the selected loop. For more
information, see Open a Module from a Browser View, page 325.

Browser Module

This option shows you how to set up a Workflow Browser. Workflow needs to be
set up by an instrument engineer. This involves creating an appropriate view in the
Workflow Browser from which the process data statuses of the instrument tags can
be set. For more information, see Create a Workflow Browser, page 96.
Related Topics
Open a Browser View

1. To open the default Browser View, do one of the following:
• Click .
2. To select a Browser View other than the default view, with the browser default
view open, do one of the following:
• Click .
• Click .
3. In the Browser Manager, expand the Browser groups hierarchy and select the
browser you want to open.
• Click .
• Click Actions > Open View.
Note
• If you have not defined a default Browser View clicking on the
browser button or Actions > Open View opens the Browser
Manager where you can create a default view. For more details, see
Related Topics

Browser Module
Edit Data in a Browser View

1. Open the required browser view. For more details, see Open a Browser View,
page 318.
2. Select the data field that you want to edit.
3. To edit the selected data field, use one of the following methods, as required:
• Type the appropriate value.
• Click to open a list and select the appropriate value.
• Select or clear a check box.
• Right-click, and from the shortcut menu select the appropriate option.
Tip
• Press Tab to move to the next data field. Press Tab + Shift to move
to the previous data field.
Notes
• If you wish to add or delete some of the options in a list, you can
access that list from the Tables menu in the Instrument Index
Module window. For more details, see Supporting Tables: Overview,
page 56.
• Fields that hold naming convention data (Name, Prefix, Number, and
Suffix) cannot be edited.
Related Topics
Modify and Save a Field Layout

1. Open the Browser View window that you want to modify. For more details, see
Open a Browser View, page 318.
2. Place the mouse pointer over a column heading and then drag and drop the
column to a desired position in the data window.
3. Place the mouse pointer on an edge of a column heading so that the pointer
changes to a double-headed arrow, and then resize the column width as you
require.
4. Right-click anywhere in the data window and then, on the shortcut menu, click
Save Field Layout.
Related Topics

Browser Module
Modify Document Numbers in a Document Browser View

1. In the SmartPlant Instrumentation window, do one of the following to open the
Browser Manager:
• On the menu bar, click File > Browser Manager.
2. Double-click the Documents browser group.
3. Double-click Document Browser and do one of the following:
• Click Actions > Add View.
• Right-click the highlighted browser and then, on the shortcut menu,
click Add View.
4. Define a view profile for the new browser view. For more information, see
5. Define the view style settings containing the following data field column headers:
• Document Number (DWG_NAME) — Allows you to displays
document numbers.
• Document Type (DWG_TYPE_ID) — Allows you to display all
documents available in SmartPlant Instrumentation according to their
document type, for example, all specifications, all process data reports,
and so forth.
Tip
• For details on how to define view style settings, see Create a View
Style, page 286.
6. Set a sorting sequence and filter conditions if needed.
7. On the Browser Manager toolbar, click to open the browser view that you
created.
8. Under the Document Number column, modify the document numbers as you
require.
9. On exiting the browser view, save the changes when prompted.
Related Topics
• Create a Sorting Sequence View, page 298
• Define a View Filter, page 305
• Define a View Profile, page 264

Browser Module
Browser View Buffer

page 318.
2. Click in the appropriate field of the Buffer data window and type the relevant
information. Press the Tab key to move to the next data field or press Shift +
Tab to move to the previous data field.
3. To copy an entire row to the Buffer data window, select the appropriate row, and
do one of the following:
• Click .
• Click Edit > Copy to Buffer.
4. To copy a field to the Windows Clipboard, select the appropriate field and then
press either Ctrl + Ins or Ctrl + C.
5. In the Browser View window, highlight the row(s) or the field(s) that you want to
update. (To select more than one row, hold down Ctrl and click the required
rows.)
Important
• Use the scrollbar to view all parts of the Buffer data window and
check the data they contain before pasting data from the Buffer data
window to the Browser View window.
6. To paste the data from the buffer to the currently selected row, do one of the
following:
• Click .
• Click Edit > Paste From Buffer.
Tip
• Empty Buffer columns do not update the target fields.
7. To paste the data from the Windows Clipboard to a selected field, press Ctrl + V.
Related Topics

Browser Module
Clear Data from the Buffer

1. To clear the entire buffer, click .
2. To clear one field in the buffer, do the following:
a. Click in the field you want to clear.
b. Click .
Related Topics
Sort Displayed Rows

page 318.
2. Double click the header of the column you want the displayed rows to be sorted
by. The displayed rows are sorted in an ascending order according to the selected
column.
3. Double click the header again, and the displayed rows are sorted in a descending
order according to the selected column.
Related Topics
Count Displayed Rows

page 318.
• Click .
• Click Actions > Count.
Note
• If the data window contains a large number of rows, the counting
process may require a few seconds to refresh the data.
Related Topics

Browser Module
Refresh Displayed Data

page 318.
• Click .
• Click Edit > Refresh.
3. If you are prompted to save changes:
• Click Yes to save the modified data before refreshing the data from the
database.
• Click No to discard the changes that you made to the displayed data.
Related Topics
Find a Value in a Specific Column

page 318.
2. Click the header of the column you want to find the value in.
• Click Edit > Find.
• Click .
4. In the Find dialog box, do one of the following:
• Select Whole Value to find only occurrences that are whole words
• Select String to find occurrences that are either whole words or part of
a word.
• Select As Typed to search for the value as you type it in.

Browser Module
5. Type the value you are looking for. If you selected either Whole Value or
String, click Find to find the next occurrence.
Tips
• During the search, the Find button changes to Stop, allowing you to
stop the search, if required. When an appropriate occurrence is found,
the corresponding row is automatically highlighted. (If you selected
As Typed, the Find button becomes inactive, and the search is carried
out as you type the value in the Find dialog box.)
• Change the search column when the Find dialog box is open by
clicking on the header of another column.
6. Click Close when you have finished your search.
Related Topics
Select Color for Read Only Fields

1. Open the Browser Manager. For more details, see Open a Browser View, page
318.
2. Click Actions > Set Color for Read-Only Fields.
3. In the Color dialog box, to select a color, do one of the following:
• Select a color from the Basic colors.
• Click the approximate color on the color palette, and then use the
control bar to adjust the color to your requirements. You can save this
color as a custom color by selecting a Custom colors box, and then
clicking Add to Custom Colors.
• Enter the Red, Green, and Blue numeric values, or the Hue; Sat; and
Lum; numeric values in the relevant fields.
4. Click OK.
Related Topics

Browser Module
Open a Module from a Browser View

page 318.
2. Highlight the required data row.
3. Right-click the highlighted data row to open a shortcut menu.
Tip
• The shortcut menu displays the available modules relevant to the
selected data row. The disabled modules are either irrelevant to the
selected data row or do not contain appropriate data.
4. Select the required sub-menu item from the available options.
Related Topics
Browser Views for Instrument Index

You can also sort the data displayed in a browser view according to the existing
columns in the browser view. For further details, see Sorting Tag Rows in a Browser
View, page 322.
You can also open the supporting table dialog box for an active column and find a
drop-down list item in an active column of the browser view on the fly. For details,
see Accessing a Specific Supporting Table, page 56.
Performing Tag and Loop Number Activities — You can carry out numerous tag
and loop number activities with selected tag rows. You can access all the available
commands from the Actions and Options menus on the menu bar or by right-clicking
the highlighted rows and selecting an item on the shortcut menu. The browser view
toolbar is also available for the most commonly used commands.
Browser View Buffer — You can use the browser view buffer to:
• Update multiple tag number rows in batch mode.

• Copy data from one row in the browser view to the buffer or type the
information yourself and then paste it in as many rows in the browser
view as needed.

Browser Module
Browser Groups
The Browser Group window contains all the existing Browsers in a hierarchical
arrangement. You expand an item by either double-clicking its icon or by clicking
the + sign next to it. Note that after expanding an item, the + sign changes to - .
The Browser Groups hierarchy is as follows:
— First Level – Browser Group

— Second Level – Browser
— Third Level – View

— Fourth Level – View Settings
• Browser Group — The first level of the hierarchy stands for a

Browser Group which represents a module or an item category (for
example, Control System). Each group can contain one or more
browsers.
• Browser — Each browser is associated with the data of a particular
module (for example, Loop and Equipment in the instrument Index
module or an item type whose data it displays. A browser contains
one or more viewing templates or views that you can select and
modify to customize the way the corresponding data is displayed in the
Browser View window.
• View — Each view (a viewing template) contains the viewing
settings: viewing style, sorting order, and filtering condition. These
settings will be used to display the data that the selected view is
associated with. You can add, delete, modify, or duplicate the view
profile to customize the way the data is displayed in the Browser
View window.

Browser Module
View Settings — You can define the following settings for every view:
• Style — Allows you to determine which fields will be displayed, the

field layout (that is, the order in which these fields will appear), the
Data Field Headers that will be used for the current Style, and the
field length (number of characters) that will be displayed for each
selected field.
• Sort — Allows you to determine the sorting sequence of the fields in
the Browser View window. You can also select a different sorting
sequence when viewing the data in the Browser View window.
• Filter — Allows you to determine the filtering condition that will be
used to select the data rows displayed in the Browser View window.
After defining the required view settings, you can apply them to the data that the
selected browser is associated with and view the results in the Browser View
window.

Instrument Index Module

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
377
• Edit Data: An Overview, page 399
• Generating Documents: An Overview, page 413
• Managing Instrument Tags: An Overview, page 354
• Managing Lines: An Overview, page 394
• Managing Loop Numbers: An Overview, page 329
• Working with External Documents: An Overview, page 419
• Working with Typical Loops and Tags: An Overview, page 382

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 329
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 331.
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 333.
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 336.
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 338.

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 New Loop Number During Tag Edit

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 New Loop Number During Tag Edit.
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 341.
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
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 332
4. When prompted select No if you do not want to associate a new tag number at this
moment, the Loop Number Properties dialog box will open. Select Yes to
create a new tag number that will be associated with the new loop:
a. The New Tag Number dialog box opens.
b. Type the tag number and click OK, the Select Instrument Type dialog box
opens.
c. 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.
5. 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.

6. 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 Error! Bookmark
not defined.
• You can define a functional requirement while creating a new loop.
For details see Define a Functional Requirement for a Loop, page 345.
Related Topics
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 New Individual Loop Number, page 331
• Create a New Loop Number During Tag Edit, page 341

Duplicate a Loop Number

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.
Tip
• The data field on the Duplicate 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).
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. At the prompt Click Yes to edit the tag properties you have duplicated, or No
to duplicate the tag numbers with their existing parameter values.

g. If your current unit uses the Free or Loop naming conventions, you can also
select the Select instrument type check box to open the appropriate dialog
box where you select the required instrument type for the tags you are
associating with the target loop number.
8. 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.
9. Define a functional requirement if required. For details see Define a Functional
Requirement for a Loop, page 345.
10. Click OK .
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

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

Edit Loop Number Properties from the Domain Explorer

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 338
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.
For details see Define a Functional Requirement for a Loop, page 345
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.
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

Edit Loop Properties from the Instrument Index Module

1. To start the Instrument Index Module do one of the following:
• Click .
2. In the Instrument Index Module window, do one of the following:
• Click .
• Click Edit > Loop Numbers > Loop Number Properties.
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
Tips
the pertinent supporting table where you can rename a loop number,
add, edit, or delete an item on the list.
For details see Define a Functional Requirement for a Loop, page 345
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.
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

Edit Multiple Loop Numbers

• Click .
• Click .
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.
7. On the Loop Number Properties dialog box, edit the loop properties by entering
Tip
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 a Tag Number, page 363.
12. Click OK to close the Loop Number dialog box and save new loop number
values.

Create a New Loop Number During Tag Edit

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 332
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
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 Working with the SmartPlant
Instrumentation Explorer: An Overview, page 211.
Related Topics
Rename A Single Loop Number

• Click
2. On the Instrument Index Module, do one of the following:
• Click
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 343
• Make sure that your new loop number name complies with the naming
conventions for the current <unit>.
• All loop numbers must have unique names in the current <unit>.
Related Topics
Set Preference for Renaming A CAD File from A Loop

Number
1. From the Menu Bar click, File > Preferences.
2. On 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
• Rename A Single Loop Number, page 342

Rename Multiple Loop Numbers

• Click .
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.
c. Click on 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
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 331
• Duplicate a Loop Number, page 333
• Edit Loop Number Properties from the Domain Explorer, page 336
• Edit Loop Properties from the Instrument Index Module, page 338

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. In other words, when you create a new tag number based on a particular
instrument type, SmartPlant Instrumentation 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 347

Instrument Types Common Tasks

The following tasks are used frequently when you create and manage instruments in
your plant.
Define an Instrument Type Profile

This option shows you how to define a new instrument type, or edit the properties of
an existing instrument type. For more information, see Define an Instrument Type
Profile, page 348.
Define a General Process Function

This option shows you how 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 349.
Define an Instrument Type Default Setting

This option shows you how 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
tag numbers with certain predefined properties. For example, you can create new tag
numbers associated with a particular specification, I/O type, reference device panel,
and so forth. You define an instrument type profile for each instrument type. As a
result, SmartPlant Instrumentation creates new tag numbers with the predefined
properties based on the instrument type that you select for the new tag number. For
more information, see Define an Instrument Type Default Setting, page 350.
Define a Wiring and Controls System Instrument Type Profile

This option shows you how 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 350.
Copy Instrument Type Profile Data

This option shows you how 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 352.

Set an Alias Control System Tag

This option shows you how 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 352.
Apply all Existing Profiles

This option shows you how to create the following tag items specified in the
instrument type profiles for selected instruments in an Instrument Index Standard
Browser view: instrument specification sheets, control system tags, and device
panels and cables. For more information, see Apply all Existing Profiles, page 353.
Related Topics
Define an Instrument Type Profile

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.
• 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.
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 Sub-Category, page Error! Bookmark not defined..
Related Topics
• Apply all Existing Profiles, page 353
• Generate a Process Data Sheet for an Instrument, page 415
• Set an Alias Control System Tag, page 352
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 Profile, page 348

Define Instrument Type Default Settings

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.
3. In the data window, select the instrument type you desire.
4. Click Profile.
5. Make your definitions as you require.
Note
• Make sure that your preferences are set to activate the options that you
require.
Related Topics
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.
• 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.
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
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

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.
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.
Note
• 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.
Related Topics
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
Profile, page 348.
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.

Apply all Existing Profiles

1. Open an Instrument Index Standard Browser view.
2. Select the desired tag numbers.
• 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 profiles of the selected tag
number. For more details, see Define an Instrument Type Profile, page
348
• This option does not affect instrument profile options for items other
than instrument specification sheets, control system tags, and device
panels and cables.
Related Topics

Managing Instrument Tags: An Overview

SmartPlant Instrumentation allows you to easily create and manage instrument tags
through out 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 354
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 357.
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 361.

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 399.
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 363.
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 363.
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 364.
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 367.
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 368.
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 368.

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 369.
Rename an Instrument Tag

This option allows you to rename an existing instrument tag. For more information,
see Rename an Instrument Tag, page 370.
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 372.
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 373.
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 374.
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 374.
Related Topics

Create an Instrument in the Domain Explorer

2. Expand the plant hierarchy to display the Instruments and Loops folders.
• 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:
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
tag, 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 360.
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
361
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 358.
• 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.
Related Topics
• Create an Instrument Tag in the Instrument Index Module, page 358
Create an Instrument Tag in the Instrument Index Module

1. To start the Instrument Index module do one of the following:
• Click .
• Click Edit > Tag Numbers > New Tag Number.
• Click
want to create, a conventional, Foundation Fieldbus, HART instrument, soft
tag, 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 360.
4. Click OK.

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.
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.
• Type the loop number that the new tag is to be associated with.
• 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
361.
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 357.
• 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.

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 Error! Bookmark not defined.
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 357
• Rename an Instrument Tag, page 370
• Tag Number Renaming Options, page Error! Bookmark not defined.


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.
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.
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
• Duplicate an Instrument Tag in the Domain Explorer, page 364
• Duplicate an Instrument Tag in the Instrument Index, page 366
• Edit an Instrument Tag from the Domain Explorer, page 363

Edit an Instrument Tag from the Domain Explorer

Instruments folder.
2. Double-click the Instruments folder to display the existing tag numbers.
3. Right-click on 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),
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 a Tag Loop
Association, page 377.
• 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
Related Topics
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. Open the browser view, select the instrument tag that you require, and do one of
the following:
• Double-click the Rem. field.
• 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.
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 403
Related Topics
Duplicate an Instrument Tag in the Domain Explorer

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. Select the instrument type from the Select Instrument type dialog box, and click
OK.


• 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 a Tag Loop Association, page 377.
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 361.
9. Click OK.
Notes
• If you are working with the Free naming conventions, select the Select
Instrument Type check box to open a dialog box that allows you to
select the appropriate instrument type. This dialog box also opens if
more than one instrument type is appropriate for the tag number that
you entered.
• 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 366.
Related Topics

Duplicate an Instrument Tag in the Instrument Index

• 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. Select the instrument type from the Select Instrument type dialog box, click OK
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.
• Click OK, to accept the displayed loop number. The Loop Properties
dialog box opens, type the required 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 a Tag Loop Association, page 377.
7. 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 361.
8. Click OK.

Notes
• If you are working with the Free naming conventions, select the Select
Instrument Type check box to open a dialog box that allows you to
select the appropriate instrument type. This dialog box also opens if
more than one instrument type is appropriate for the tag number that
you entered.
• You can also duplicate an instrument tag from the Domain Explorer.
For more details, see Duplicate an Instrument Tag in the Domain
Explorer, page 364
Related Topics
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
Delete Instrument Tags in the Instrument Index Module

1. On the Instrument Index module menu bar, click Edit > Tag Numbers > Delete
Tag Numbers.
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.
4. Click OK.
Related Topics

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.
• 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.
Related Topics
Move an Instrument Tag to Another Plant Group

1. On the Instrument Index module menu bar, click Edit > Tag Numbers > Move
Tag Number.
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.
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

Move Multiple Instrument Tags in the Browser Window

1. Open the Instrument Index module, by doing one of the following:
• Click
2. Open an Instrument Index Standard Browser view, by doing one of the following:
• Click
3. Select the instrument tags you want to move.
• 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

Rename an Instrument Tag

1. From the Instrument index module, do one of the following:
• 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. Next to the Number field, Click .
5. On the Rename Tag Number dialog box, change the tag class, edit the tag
instrument type, number, or suffix as required.
6. Click OK.
7. 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.
8. 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.
9. Click OK, to close the 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.
• 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 360
• For more information about instrument tag renaming options, see
Instrument Tag Renaming Options, page 371
Related Topics
• Tag Number Renaming Options, page Error! Bookmark not defined.
Instrument Tag Renaming Options

1. 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 Error! Bookmark not defined.
• Instrument Tag Naming Convention, page 360
• Rename an Instrument Tag, page 370

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.


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.
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
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.

Add and Edit Instrument Tag Categories

2. Click Actions > Tag Categories.
3. Click New to add a new tag category row.
4. Type the required 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
Generate a Process Data Sheet in a Browser Window

1. In the browser view, select the tag numbers that you require.
• 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

Incorporating Soft Tags Within an Enhanced

Reports Loop Drawing
The Enhanced Reports utility allows you to generate loop drawings for loops that
include Soft tags. These tags can be, for instance, software codes, handling certain
process functions. 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 Reports 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.
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
Reports 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
• Add a Macro to a Symbol
• .
• You will later associate this symbol with a Soft tag.
3. Define a new instrument type for Soft tags, see Define Instrument Type. For
example, ST for Soft tag.
4. Create a new Soft tag. See Create an Instrument in the Domain Explorer.
5. Set the new Soft tag instrument type to ST , 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 ESL Drawing Symbol For 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 Reports
utility drawing, see Loop Drawing Generation Method
8. Generate an Enhanced Reports utility drawing for this loop, see Generate a Report
Using the Domain Explorer
9. In the Enhanced Reports 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. The selected tag can
also be from a different loop.
Tip
• 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.

Associating Instrument Tags with Loop Numbers:

An Overview
This section shows you how to associate instrument tags to 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
377
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
378.
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 379.
Change Instrument Tag Loop Associations in the Standard 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 Standard Instrument Index Browser View, page 380.

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 379.
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 379.
Associate Multiple Tag Numbers with a Loop

1. Start the Instrument Index module.
• Click Actions > Associate.
• Click .
• 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
377

Associate an Instrument Tag with a New Loop

Instruments folder.
3. Right-click on 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.
Related Topics
377
Change an Instrument Tag Loop Association in the Domain

Explorer
Instruments folder.
3. Right-click on 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.
Related Topics
377

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 .
• Click Edit > Tag Numbers > Tag Number Properties.
• 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
377

Incorporating Soft Tags Within an Enhanced

Reports Loop Drawing
The Enhanced Reports utility allows you to generate loop drawings for loops that
include Soft tags. These tags can be, for instance, software codes, handling certain
process functions. 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 Reports 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.

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 must be associated with a specific instrument type and
description. Furthermore, you can set instrument tag number properties for a virtual
tag. For example, you can define service, location, I/O type, and so forth. You must
define at least one typical tag for each typical loop you create.
You can create as many typical loops as required and use them to create loops in
batch mode. Typical loops with associated typical tags can be very useful when you
need to create numerous loops based on the same loop template.
You can view all the typical loops you have created in the current domain. The list of
typical loops is automatically updated after you create a new typical loop, or if you
edit or duplicate existing loops.
If you use the Free naming convention standard in the current domain, you cannot
work with typical loops and tags.
Related Topics
• Typical Loops and Tags Common Tasks, page 382
Typical Loops and Tags Common Tasks

The following tasks are used frequently when you create and manage typical loops
and tags in your plant.
Create a Typical Loop

This procedure shows you how to create a new typical loop and the associated tag.
Typical loops with associated typical tags can be very useful when you need to create
numerous loops based on the same loop template.
Creating a new typical loop is the first stage in batch loop creation procedure. This is
when you make all the required typical loop definitions including the typical loop
name, measured variable, and so forth. At this stage, you also select the appropriate
instrument types for the typical tags you associate with this typical loop.
If you use the Free naming convention standard in the current domain, you cannot
work with typical loops and tags.
For more information, see Create a Typical Loop, page 385.

Duplicate a Typical Loop

This option enables you to duplicate an existing typical loop.
Duplicating a typical loop involves defining a new typical loop name and new typical
tag names to ensure name uniqueness.
For more information, see Duplicate a Typical Loop, page 387.
Batch Loop Creation from Typical Loops

This option shows you how to create numerous loop numbers based on existing
typical loops. SmartPlant Instrumentation creates these loop numbers in batch mode.
The software also lets you verify that the data you selected and entered will not stop
the loop creation process. When creating numerous loop numbers based on existing
typical loops, the software also creates new tag numbers and associates them with the
newly created loops. The software creates these tag numbers according to your
settings on the Duplicate page of the Preferences dialog box.
For more information, see Batch Loop Creation from Typical Loops, page 388.
Verify New Loop Numbers

This option shows you how to verify new loop numbers that you want to create from
typical loop numbers in batch mode, are correct and will not cause problems during
there creation.
When creating numerous loops and tag numbers from typical loops in batch mode,
some data problems might cut short the creation process. If, during batch loop
creation, SmartPlant Instrumentation encounters a data problem with one loop, the
creation process cannot proceed with the rest of the typical loops. To avoid this
problem, SmartPlant Instrumentation helps you verify that you selected and entered
data that will not stop the creation process.
SmartPlant Instrumentation verifies the following:
• Loop number uniqueness.

• Loop and tag number naming conventions.
• Loops and tags reserved for other projects.
The verification procedure takes much less time than the actual creation; therefore,
you should do it before you start creating new loops and tag numbers.
For more information, see Verify New Loop Numbers, page 390.

Edit a Typical Loop

This option enables you to edit the properties of an existing typical loop. You can
modify the existing typical loop properties and associate new typical tags with the
current loop.
For more information, see Edit a Typical Loop, page 390.
Delete a Typical Loop

This option shows you how to delete the required typical loop with or without the
associated typical tags.
For more information, see Delete a Typical Loop, page 391.
Edit a Typical Tag

This option shows you how to edit the properties of an existing typical tag, including
renaming a typical tag if needed. You might want to edit the properties of the typical
tags if you plan to perform batch loop creation according to specific tag data you
define in the Typical Tag Number Properties dialog box. Depending on your
preference options, when creating loops in batch mode, the software creates
conventional tag numbers using the profile data of the source instrument type, or
creates typical tags using specific source tag data you define in the Typical Tag
For more information, see Edit a Typical Tag, page 391.
Edit a Typical Tag in a Browser View

Use the following procedure to edit the properties of one or more typical tags in an
Instrument Index Standard Browser view. You can select typical tags, edit the
properties of each typical tag separately and associate these typical tags with other
existing typical loops.
For more information, see Edit a Typical Tag in a Browser View, page 392.
Related Topics

Create a Typical Loop

2. On the Instrument Index menu bar, click Edit > Typical Loop Management.
3. On the Typical Loop Management dialog box, click New.
4. On the Typical Loop Properties (New) dialog box, in the Loop name field, type
a unique name for the new typical loop.
5. In the Loop service field, type an appropriate loop service if needed.
6. In the Loop suffix field, type a suffix if required.
Tip
• Use a suffix if you want to have numerous typical loops with the same
names. This is useful when you have numerous typical loops that
perform the same or similar function.
7. From the Measured variable list, select the required measured variable for the
new typical loop. If the required value is not available, click next to the list
arrow to open the Loop Measured Variables dialog box where you can add a
new loop process variable identifier or edit an existing one.
8. From the Loop type list, select the required loop type for the new typical loop. If
the required value is not available, click next to the list arrow to open the Loop
Types dialog box where you can add a new loop type or edit an existing one.
9. From the Loop function list, select the required loop function for the new typical
loop. If the required value is not available, click next to the list arrow to open
the Loop Functions dialog box where you can add a new loop function identifier
or edit an existing one.
10. In the Note field, type a short note if needed.
11. Select the Apply service to tags check box, to propagate the loop service you
entered for this typical loop to all typical tags that are associated with it.
12. Click Add, to append a new typical tag row in the Associated typical tags data
window.
13. In the data window, do the following:
a. From the Instrument Type list, select the instrument type that you require.
b. In the Number field, type the required typical tag number.
c. In the Suffix field, enter the required typical tag suffix to ensure tag name
uniqueness.

14. Click Add, to add as many typical tags as required, and then click OK, to create
the typical loop with the associated tags.
Tip
• On clicking OK, you are prompted to edit the newly-created typical
tag.
Notes
• Typical tags do not have any profile data associated with the
instrument type that you specify for typical tags. However, if you set
your preferences for tag creation to the profile options, the SmartPlant
Instrumentation creates the new tag numbers based on the instrument
type profiles defined for the typical tags that are associated with the
current typical loop.
• Make sure that you define the instrument type profiles prior to creating
a typical loop.
• SmartPlant instrumentation allows you to select only those instrument
types that belong to the conventional tag class.
• Ensure that the typical tag naming conventions comply with the
required naming convention rules. For more details, see Typical Tag
Naming Conventions, page 393.
• The New Tag Name field automatically displays the name of the new
typical tag after defining the typical tag instrument type, number, and
suffix.
Related Topics

Duplicate a Typical Loop

3. Select a typical loop to duplicate.
4. On the Typical Loop Management dialog box, click Duplicate.
Tip
• The changes you make to the source typical loop affect the properties
of the target typical loop only.
5. In the Loop name field, type a unique name for the new typical loop.
6. In the Loop service field, enter an appropriate loop service if required.
7. In the Loop suffix field, type a suffix if required.
Tip
• Use a suffix if you want to have numerous typical loops with the same
names. This is useful when you have numerous typical loops that
perform the same or similar function.
8. From the Measured variable list, select the required measured variable for the
new typical loop. If the required value is not available, click next to the list
arrow to open the Loop Measured Variables dialog box where you can add a
new loop process variable identifier or edit an existing one.
9. From the Loop type list, select the required loop type for the new typical loop. If
the required value is not available, click next to the list arrow to open the Loop
Types dialog box where you can add a new loop type or edit an existing one.
10. From the Loop function list, select the required loop function for the new typical
loop. If the required value is not available, click next to the list arrow to open
the Loop Functions dialog box where you can add a new loop function identifier
or edit an existing one.
11. In the Note field, type a short note if needed.
12. Select the Apply service to tags check box, to propagate the loop service you
entered for this typical loop to all typical tags that are associated with it.
13. Click Add, to append a new typical tag row in the Associated typical tags data
window.

14. On the data window, do the following:

a. From the Instrument Type list, select the instrument type that you require.
SmartPlant instrumentation retrieves profile data associated with this
instrument type and applies this data to new tag numbers only when
performing batch loop creation. For more details, see Batch Loop Creation
from Typical Loops, page 388.
b. On the Number field, type the required typical tag number.
c. On the Suffix field, enter the required typical tag suffix to ensure tag name
uniqueness.
15. Click Add, to add as many typical tags as required, and then click OK, to create
the typical loop with the associated tags.
Tip
• On clicking OK, you are prompted to edit the newly-created typical
tag.
Notes
suffix.
Related Topics
Batch Loop Creation from Typical Loops

2. Click Edit > Batch Loop Creation.
3. On the Batch Loop Creation dialog box, select an existing typical loop from the
Typical Loop list. SmartPlant Instrumentation will base the new loops on this
typical loop.
4. To find a typical loop from a long list of typical loops, do the following:
a. Click Find.
b. In the Find Typical Loop dialog box, enter the required search parameters
and click Find.
c. Select the required typical loop in the Search results data window and than
click OK. The selected typical loop will automatically appear in the Typical
Loop field of the Batch Loop Creation dialog box.

5. In the New Loop Numbers field, enter the range of numbers for the new loops
that will be created based on the selected typical loop.
Tip
You can create as many loops based on the selected typical loop as you
require. To create more than one loop, simply enter the required new loop
number names in the New Loop Number field. You can enter a range of loop
names or a list as needed.
For noncontiguous alphanumeric or numeric loop numbers, type the loop

numbers with commas between them. For a range of numeric loop numbers,
type the range of loop numbers with a hyphen between them. For example, to
create loops 1000, 1001, 1002, 1003, 1057, FT10, F11,and F12 type: 1000-
1003, 1057, FT10, F11, F12.
6. Click Add to add a new data row to create another set of loops. You can add as
many sets of loops as you require for batch creation.
Tip
• You should verify the correctness of the data if you are creating a large
number of loops. The creation process may stop if SmartPlant
Instrumentation encounters a problem with one of the loops. To avoid
this situation, click Verify to correct some possible data problems
before you proceed with loop creation. For more details, see Verify
New Loop Numbers, page 390.
7. Click Create to start the loop creation.
Tip
• If for some reason the loop creation process fails, the software displays
an appropriate message informing you that a particular set in a
specified row has not been created. Moreover, the Done check box for
that row remains cleared.
8. Click Close.
Note
• To avoid duplicate loop numbers in your <plant>, check which tag
number numeric segments are available before starting batch loop
creation. For more details, see Create a List of Available Tags, page
416
Related Topics
• Duplicate a Typical Loop, page 387

Verify New Loop Numbers

1. In the Batch Loop Creation dialog box, select the required typical loops and
enter the new loop numbers in the Loop creation set data window. For more
details, see Batch Loop Creation from Typical Loops, page 388.
2. Click Verify.
3. If a data problem is encountered, follow the instructions given by the software to
correct the problem.
Related Topics
Edit a Typical Loop

2. On the Typical Loop Management dialog box, select the required typical loop
and click Properties.
3. On the Typical Loop Properties dialog box, edit the fields as needed.
Important
• The Loop name and the Measured variable fields are required fields.
4. On the Associated typical tags data window, select an existing typical tag that
has been already associated with the current loop and do one of the following:
• Click Properties to open the Typical Tag Number Properties dialog
box to edit the typical tag properties. For more details, see Edit a
Typical Tag, page 391.
• Click Delete to delete the selected tag.
5. Click Add to append a typical tag row in the Associated typical tags data
window.
6. On the data window, do the following:
a. In the Instrument Type column, select the required instrument type from the
list. The selected instrument type serves as a typical tag associated with the
current typical loop.
b. In the Number field, type the required typical tag number.
c. In the Suffix field, type the required typical tag suffix to ensure tag name
uniqueness.

7. Add as many typical tags as required and click OK to associate the newly added
typical tags with the current loop.
Notes
suffix.
Related Topics
Delete a Typical Loop

2. On the Typical Loop Management dialog box, select the required typical loop
and click Delete.
3. On the Delete Typical Loop dialog box, review the typical loop properties and
click Delete.
4. If prompted, click Yes to delete the typical loop and associated tags. Click No to
delete the typical loop only.
5. On the Typical Loop Management dialog box, click Close.
Related Topics
Edit a Typical Tag

• Click Edit > Tag Numbers > Tag Numbers Properties.
• Click .
3. On the Enter Tag Number dialog box, Click Find to open the Find Tag dialog
box.
4. On the Find Tag dialog box, from the Tag class list select Typical, enter the
required search parameters if needed and click Find.
5. In the Search results data window, select the typical tag that you want to edit and
click OK.

6. In the Typical Tag Number Properties dialog box, modify the typical tag
properties as you require.
7. Click OK.
Note
• You can also edit a typical tag when editing a typical loop. For more
details, see Edit a Typical Loop, page 390.
Related Topics
Edit a Typical Tag in a Browser View

1. Open the Browser Manager by doing one of the following:
• From an Instrument Index Standard Browser view, click .

• On the main SmartPlant Instrumentation toolbar, click .
• On the SmartPlant Instrumentation menu, click File > Browser
Manager.
2. Select the browser (Instrument Index Standard Browser or a PowerSoft
Browser that supports tag number data, if available) that has the default view that
you want to open.
3. Select the appropriate browser view.
4. Click Edit.
5. On the View profile display, from the Display data at level list, select Typical.
6. Click Save.
7. Open the browser view and use the Shift or Ctrl key to select the typical tags that
you require.
• On the menu, click Edit > Properties.
• Click .
• Right-click the selected tag numbers, on the shortcut menu, click Tag
Number Activities > Properties.
9. In the Typical Tag Number Properties dialog box, edit the typical tag properties
as required.
10. Click Apply > Next, to edit the next selected tag.
11. Click OK.

Typical Tag Naming Conventions

You can use any naming convention for your typical tags as long as it contains the
typical tag number segment. The name segment of a typical tag can be the same
length or shorter than the name segment of a tag. You defined tag name segments in
the naming conventions for the current <unit>.
The naming conventions for typical tags are as follows:
• Instrument type — up to 4 characters in the name segment, (the

typical tag name segment is automatically truncated to 4 characters
when the instrument type name contains more than 4 characters).
• Typical tag number — up to 8 characters in the typical tag number
segment.
• Typical tag suffix — up to 3 characters in the typical tag suffix
segment.
Example of a typical tag name: FT-FLOW_CTLR/2.
The naming convention for typical loops is as follows:
• Typical loop name — up to 50 characters. When using a loop suffix

the maximum loop name length is shortened to 48 characters. The
typical loop suffix can contain up to 3 characters. In addition, there
must be a slash (`/') separator between the number and the suffix.
Related Topics
• Create a Typical Loop, page 385
• Duplicate a Typical Loop, page 387
• Edit a Typical Loop, page 390

Managing Lines: An Overview

You can create, modify, and delete lines in the Instrument Index module. The Lines
dialog box holds all the line data in your <plant>. Lines are categorized according to
line types. You can create new line types and then add new lines to these types as
required. You can also change the type of an existing line if needed and copy line
data from a selected line to several target lines.
Related Topics
• Working with Lines Common Tasks, page 394
Working with Lines Common Tasks

The following tasks are used frequently when you create and manage lines in your
plant.
Create a New Line

This option shows you how to create a new line in the Instrument Index module. For
more information, see Create a New Line, page 395.
Edit Line Data

This option shows you how to edit the data of an existing line. Line data comprises
such properties as the line number, pipe material and standard, line size, its internal
diameter, and wall thickness. For more information, see Edit Line Data, page 395.
Create or Edit a Line Type

Line types are used for categorizing the lines in your <plant>. Each line must belong
to a particular line type, for example, Process or Utilities. You can create as many
line types as required and move the existing lines from one type to another. For more
information, see Create or Edit a Line Type, page 396.
Change Type of Line

This option shows you how to change the line type of an existing line. For more
information, see Change Type of Line, page 396.
Copy Line Data

You use this option to copy line process data from a selected line to one or more
target lines. For more information, see Copy Line Data, page 397.
Delete a Line
This option shows you how to delete a line that is no longer in use. Note that you
cannot delete a line that is associated with a tag number. For more information, see
Delete a Line, page 398.

Define or Modify Pipe Specifications

Pipe spec is a specification that defines various process conditions for a specific pipe.
You use this procedure to define a pipe spec to the Pipe Specs supporting table from
the Instrument Index module, or to modify properties of an existing pipe spec. For
more information, see Define or Modify Pipe Specifications, page 398.
Related Topics
Create a New Line

2. To open the Lines dialog box, do one of the following:
• On the Tables menu, click Lines.
• Open the Tag Number Properties dialog box, click next to the
Line list arrow.
3. On the Line type list, select the required line type.
Tip
• If the required line type does not exist, click next to the Line type
list arrow to open the Line Types and create a new line type. For
more details, see Create or Edit a Line Type, page 396.
4. Click New to open the Line Properties dialog box.
5. Define the line properties as you require and click OK.
Related Topics
Edit Line Data

Line list arrow.
3. From the Line type list, select the required line type or select the Show all line
types check box.
4. Select the required line in the data window.
5. Click Properties to open the Line Properties dialog box.

6. Define the line properties as you require and click OK.
Related Topics
Create or Edit a Line Type

Line list arrow.
3. Click next to the Line type list arrow.
4. In the Line Type dialog box, click New to append a new data line.
5. Type the line type name and description in the appropriate fields.
6. To modify a line type, highlight the required line type and click in the desired
field.
Tip
• To quickly find a line type in a long list of line types, type the line type
name in the Find Line Type box. SmartPlant Instrumentation will
automatically highlight the line type you are looking for.
Related Topics
• Change Type of Line, page 396
• Create a New Line, page 395
Change Type of Line

Line list arrow.
3. From the Line type list, select the required line type.
4. Select the required line in the data window.
5. Click Change Type.

6. In the Change Type dialog box, highlight the required line type and click OK.
Tip
• If the required line type does not exist, click Cancel to close the
Change Type dialog box, then click next to the Line type list
arrow, to create or modify a line type. For more details, see Create or
Edit a Line Type, page 396.
Related Topics
• Change Type of Line, page 396
Copy Line Data

Line list arrow.
3. From the Line type list, select the required line type.
4. Select the source line from which you want to copy process data.
5. Click Copy Line.
6. On the Copy Line Data dialog box, from the Line Type list, select the required
line type of the target line.
7. In the Target lines data window, highlight the target lines to which you want to
copy the source line data.
Tip
• You can use the filter facility to display only the required lines in the
Target lines data window.
8. Click OK to start the copying process.
Note
• You can also copy line process data while working in the Process Data
module. The Process Data module allows you to select a source line in
the Copy Line Data dialog box different from the one you highlighted
in the Lines dialog box.
Related Topics

Delete a Line
Line list arrow.
3. From the Line type list, select the required line type or select the Show all line
types check box.
4. Highlight the required line in the data window.
5. Click Delete.
Related Topics
Define or Modify Pipe Specifications

Line list arrow.
3. On the Lines dialog box, under Line type, select a line type, or click to create
a new line type.
4. Click New to open the Line Properties (New) dialog box.
5. Beside the Pipe spec list, click to open the Pipe Specs dialog box.
• To create a new pipe spec, click New and type entries in the Pipe Spec
and Description boxes.
• To edit an existing pipe spec, click a field in a highlighted row and
modify the existing entry as needed.
Related Topics

Editing Data: An Overview

You can edit the data fields in a browser view by either selecting one row or by
selecting multiple rows. The single-edit mode is useful when you need to edit one
row or a few rows. The multi-edit mode is a more powerful tool. In addition to being
able to edit multiple rows, you can also carry out certain editing operations that are
not available in the single-edit mode.
You can view, organize, and edit your instrument index data by opening an
Instrument Index Standard Browser view in the Browser module. You can also add a
PowerSoft browser that supports the display of tag data and define a view for it to use
with the Instrument Index module.
In the selected browser view, you can access numerous commands to manage your
instrument index data. You can edit the tag number properties in the multi-edit or
single-edit mode, create new loop and tag numbers, associate an instrument with a tag
category, associate and open external documents, generate process data sheets and
specifications for tags, and so forth.
Related Topics
• Edit and View Data Common Tasks, page 399
Edit and View Data Common Tasks

The following tasks are used frequently for viewing and editing data in your <plant>.
Define a Standard Browser View for the Instrument Index

This procedure shows you how to create and define a designated custom browser
view in the Instrument Index Standard Browser. When you view and edit tags from
the Instrument Index browser using a browser view the Browse command opens this
designated custom browser. For more information, see Define a Standard Browser
View for the Instrument Index, page 403.
Edit a Single Row

This option shows you how single-row editing allows you to modify the data for one
tag number at a time from a browser view. You edit the data by typing or selecting
values from the available lists. You can also use the buffer to copy data from one row
and then paste in multiple rows as needed. For more information, see Edit a Single
Row, page 404.

Open a Specific Supporting Table

This option shows you how to open the supporting table dialog box for an active
column in an Instrument Index Standard Browser view. There are two main uses of
this feature:
• Adding, editing, duplicating or deleting items in a supporting table.

For more details, see Supporting Tables: Overview, page 56.
• Finding a select list item in an active column of the browser view on
the fly. This option is especially useful when you have a long list of
items in a select list and you need to scroll up or down to find the item
you need. Opening a supporting table for that select list enables you to
quickly find the required item which will automatically be selected for
you after closing the supporting table dialog box.
For more information, see Open a Specific Supporting Table, page 404.
Find a Record in a Browser View Column

This option shows you how to search the displayed instrument index data for a
specific record. You can search for any record that exists in any of the browser view
columns. For example, you can find a specific tag number, an instrument type, or an
I/O type, and so forth. The following search options are available:
• Find a record by entering the whole value, for example, 101-FV 100
(the full tag number name) or CONTROL VALVE (the full instrument
type value).
• Find a record by entering a string which is a part of a value, for
example, FV (or just V) or CONTROL VALVE (the full instrument
type value).
• Search for a record as you type in the value.
For more information, see Find a Record in a Browser View Column, page 405.
Sort Tag Rows in a Browser View

This option show you how to sort the tag number rows in an Instrument Index
Standard Browser view by a selected column for the current work session. You can
set a default sorting sequence for the browser view that takes effect every time you
open the browser view. You use the following procedure to override the default
sorting sequence for the current session. After closing the browser view, the sorting
sequence you set now will be lost and the default one will be applied when you
reopen the browser view. You can sort the rows in ascending or descending order as
needed. For more information, see Sort Tag Rows in a Browser View, page 406.
Edit Instrument Tag Data in Multi-Row Mode

This option shows you how to use the multi-row mode to select several rows of tag
number data that you can edit. You select the required tag numbers by highlighting
multiple tag rows in the browser view. The editing is done in the Tag Number

Properties dialog box, from which you also have access to the appropriate supporting
tables if you need to update the available options in the lists. For more information,
see Edit Instrument Tag Data in Multi-Row Mode, page 406.
Count Instrument Tag Rows in a Browser View

This option shows you how to count the total number of tag number rows currently
displayed in an Instrument Index Standard Browser view, where each tag number row
represents one record in the database. When selecting several tag number rows, you
can count both the total and the selected number of records. Also, when the list of
records is long, you can count the total number of tag number rows before the
software finishes retrieving the records from the database. For more information, see
Count Instrument Tag Rows in a Browser View, page 407.
View Point-to-Point Wiring Diagrams

This option shows you how with a tag that contains wiring information, you can open
the point-to-point wiring diagram directly from an Instrument Index Standard
Browser view. For more information, see View Point-to-Point Wiring Diagrams,
page 407.
View Data History in a Browser View

SmartPlant Instrumentation can indicate changes to the data currently displayed in an
Instrument Index Standard Browser view with the data stored in the audit trail
repository for the date range that you specify. You can choose any or all of the
following modes of emphasis:
• Set a color to emphasize changes on the screen.

• Set a shade of gray to emphasize the changed data in printed reports
and their previews.
• Set bold and italic font style for emphasis on the screen and in print.
History indication is available only if the System Administrator has activated the
audit trail functionality. When the audit trail functionality is activated, each time that
you save data after making changes, the data is recorded in the audit trial repository.
For more information, see View Data History in a Browser View, page 408.
Set a Date Range for Field Value Changes

This option shows you how to define a period within which you can track changes
made to a specific value in an Instrument Index Standard Browser view. For more
information, see Set a Date Range for Field Value Changes, page 409.

Track Field Value Changes

This option shows you how you can view the changes you have made to a value in
any field, in an Instrument Index Standard Browser view. Each field can display one
specific instrumentation value. You can view both the new and the old values, and
generate a report that displays these changes. For more information, see Track Field
Value Changes, page 409.
Open a Specification Sheet from the Browser Window

This option shows you how you can quickly access specifications for selected
instruments from the Browser window. You can open an existing specification
directly from an Instrument Index Standard Browser view and then perform the
appropriate action in the module that opens. For more information, see Open a
Specification Sheet from the Browser Window, page 410.
Open a Process Data Sheet from the Browser Window

This option shows you how you can quickly access a process data sheet from the
Browser window. You can open an existing process data sheet directly from an
Instrument Index Standard Browser view and then perform the appropriate action in
the module that opens. For more information, see Open a Process Data Sheet from
the Browser Window, page 410.
Open a Calculation Sheet from the Browser Window

This option shows you how you can quickly access a calculation sheet from the
Browser window. You can open an existing calculation sheet directly from an
Instrument Index Standard Browser view and then perform the appropriate action in
the module that opens. For more information, see Open a Calculation Sheet from the
Browser Window, page 410.
Display Existing Wiring Connections

This option shows you how to display existing wiring connections for selected
instrument tags in an Instrument Index Standard Browser view, where you can then
modify them if required. For more information, see Display Existing Wiring
Connections, page 411.
Open I/O Assignment from a Browser View

This option shows you how to access the I/O Assignment window for an instrument
you selected in the Instrument Index Standard Browser view. This way you can
implement the input/output assignment for the selected tags on the fly, by-passing the
Wiring Module window. For more information, see Open I/O Assignment from a
Browser View, page 411.

Change the Process Function and Instrument Type in Batch Mode

This option shows you how to change the process function and the instrument type of
multiple tag numbers in batch mode. You can choose whether to change both the
process function and the instrument type or only the instrument type. For more
information, see Change the Process Function and Instrument Type in Batch Mode,
page 411.
Related Topics
Define a Standard Browser View for the Instrument Index

1. Open the Browser Manager by doing one of the following:
• From an existing Instrument Index Standard Browser view, click .

• On the main SmartPlant Instrumentation tool bar, click .
2. On the Browser Manager, on the Browser groups pane, expand the hierarchy
Instrument Index > Instrument Index Standard Browser.
• Open an existing view for this browser.
• Click , or right-click and on the shortcut menu click Add View.
4. On the View profile pane, select Set as default view and Set as Instrument
Index browse view (per user) boxes.
5. Click Save.
6. Expand the Instrument Index Standard view.
7. Click Style, and on the Style pane click Edit.
8. Select the fields you want to see in the browser and click Save.
9. Right-click Instrument Index Standard Browser, and on the shortcut menu,
click Set as Default.
10. Close the Browser Manager.
Related Topics

Edit a Single Row

1. Open an Instrument Index Standard Browser view by doing one of the following:
• Click .
2. Highlight the required tag number.
3. Click in a required field to edit the data, and do one of the following:
• Type over the displayed value.
• Select an item from a list. If the item you need is not on the list you
just opened or if it is a long list and you need to scroll down to find
your value, click to open the appropriate supporting table where
you can find the required item on the fly. For more details, see Open a
Specific Supporting Table, page 404.
4. Press Tab to move to the next field.
Notes
• Fields that hold tag number data (Name, Prefix, Number, and Suffix)
cannot be edited.
• Changes you make to a record are automatically saved to the database
when you proceed to another record or when you close the browser
view.
Related Topics
Open a Specific Supporting Table

• Click .
2. Highlight the tag number that you require.
3. Click in a column of the highlighted row and do one of the following:
• Click Actions > Open Supporting Table.
• Click .
4. In the supporting table that opens, type the item you are looking for in the Find
box.

5. Click OK after the software highlights the row you need. Clicking OK closes the
supporting table and displays the selected item in the list.
Tip
• If the item you are looking for does not exist in the supporting table,
click New and add an item. Clicking OK after adding the new item
automatically selects this item in the active select list in the browser
view.
Related Topics
Find a Record in a Browser View Column

• Click .
2. Click on a column header to select the column you want to search. Note that all
the fields in the column become highlighted.
• Click Edit > Find.
• Click .
4. Select Case sensitive if you want to distinguish between uppercase and lowercase
characters. When selected, SmartPlant Instrumentation finds only those instances
in which capitalization matches the text you typed in the data field.
5. Select the required Match option:
• Whole value— searches for occurrences that are whole values and
not part of a larger value.
• String— searches for a particular string that you type in the data field.
• As typed— searches for a value as you type it in the data field.
6. Click Find.
7. Click Find again to find the next occurrence.
8. Close the Find dialog box when done.
Related Topics

Sort Tag Rows in a Browser View

• Click .
2. Double-click on the column header by which you want to sort the tag numbers.
Tip
• The first time you double-click a header, the software sorts the data in
ascending order - an arrow pointing down appears next to the header.
3. To sort the data in descending order, double-click the same header again. An
arrow pointing up appears next to the header according to which the data is
sorted.
Note
• After closing the browser view, the sorting sequence you set now will
be lost and the default one will be applied when you reopen the
browser view.
Related Topics
Edit Instrument Tag Data in Multi-Row Mode

• Click .
2. Select the tag numbers that you require using the Shift and Ctrl keys.
• Click Edit > Properties.
• Click .
• Right-click the selected tag numbers, and then on the shortcut menu,
click Tag Number Activities > Properties.
4. In the Tag Number Properties dialog box, edit the data for each tag as you
require. You can also do the following:
• Click New Loop to create a new loop number and then associate it
with the current tag number.
• Click New to create a new tag number.
5. When you have edited data for a particular tag number, click Apply.

6. Click Next or Previous to move from one tag number to another.
Related Topics
Count Instrument Tag Rows in a Browser View

• On the Instrument Index menu bar, click Actions > Browse Index.
• Click .
2. Select as many tag number rows as required.
• Right-click the highlighted row or rows, and on the shortcut menu,
click Count Records.
• Click Actions > Count Records.
• Click .
Related Topics
View Point-to-Point Wiring Diagrams

• Click .
• Click Actions > Documents.
• Click .
3. In the Documents pop-up window, select Tag Signal Diagram.
Related Topics

View Data History in a Browser View

• Click .
2. On the menu bar, click Options > History Options.
3. Select the date range for data history comparison, by doing one of the following:
• In the From and To data fields, type the appropriate dates. To set the
To data field value as today's date, click Today.
• Select the appropriate dates using the spinners.
4. To set a font style to emphasize changes on the screen and in print, do one or both
of the following:
• Select Bold.
• Select Italic.
5. To change the color used to display changes on the screen:
a. Beside the Highlight color for display box, click .
b. In the Color dialog box, choose the color that you require.
c. Click OK to save your new color settings and return to the History Options
dialog box.
6. To change the shade of gray used to emphasize the changed data in printed reports
and their previews:
a. Beside the Grayscale for printing box, click .
b. In the Grayscale dialog box, slide the bar to the required position.
c. Click OK to save your new grayscale settings and return to the History
Options dialog box.
7. Click OK to save your current history options and close the History Options
dialog box.
8. On the menu bar, click; Options > Mark Changes to mark changes in the data
currently displayed in the browser view for the dates that you specified in the
History Options dialog box.
Note
• To clear all history indications in the browser view, cancel the Mark
Changes selection on the Options menu.
Related Topics

Set a Date Range for Field Value Changes

• Click .
2. On the menu bar, click Options > Date Range for Changes.
3. In the From field, select or enter the date from where you want to start displaying
the changes using the DD/MM/YYYY format.
4. In the To field, select or enter the date until where you want to display the
changes using the DD/MM/YYYY format. Click Today to display the current
date in the To field.
5. Click OK to accept your settings and close the dialog box.
Related Topics
Track Field Value Changes

• Click .
2. Select the tag numbers that you require.
3. Right-click, and from the shortcut menu, select Field Value Changes.
4. Click Print to generate and print out a value changes report.
Notes
• To shorten the period within which you want to track field changes, set
a date range.
• The system records field value changes in the audit trail repository.
Before using this option on Sybase Adaptive Server Anywhere, make
a revision in the Spec Binder module to add records to the audit trail
repository. This operation is required because on Sybase Adaptive
Server Anywhere, if you want to track field value changes, the audit
trail repository must not be empty.
• Under Previous values in the Field Value Changes dialog box, for
the value you have selected in the browser view, you can view the
previous values, the date of the value change, the user name of the user
who changed the value, and the change status.

Open a Process Data Sheet from the Browser Window

1. On the main SmartPlant Instrumentation menu, click File > Preferences.
2. In the tree view pane, to expand the tree, click beside Process Data.
3. Click General.
4. In the Browser view options group box, select Always from the Open process
data sheet list.
5. Click OK to close the Preferences dialog box.
6. In an Instrument Index Standard Browser view, select the instrument tags you
require and click on the main toolbar to access the process data sheets.
Related Topics
Open a Specification Sheet from the Browser Window

2. In the tree view pane, to expand the tree, click beside Specifications.
3. Click General.
4. In the Browser view options group box, select Always from the Open
specification sheet list.
require and click on the main toolbar to access the specification sheets.
Related Topics
Open a Calculation Sheet from the Browser Window

2. In the tree view pane, to expand the tree, click beside Calculation.
3. Click General.
4. In the Browser view options group box, select Always from the Open
calculation sheet list.
require and click on the main toolbar to access the calculation sheets.

Display Existing Wiring Connections

1. On the Instrument Index Browser view, highlight the tags you require.
2. Right-click the highlighted tags and on the shortcut menu click Device Panel
Connection.
Open I/O Assignment from a Browser View

1. On the Instrument Index Browser view, highlight the tag you require.
2. Right-click the highlighted tag and on the shortcut menu click I/O Assignment.
Related Topics
Change the Process Function and Instrument Type in Batch

Mode
1. On an Instrument Index Standard Browser view, select the required tag numbers.
2. Right-click the selected tag numbers and on the shortcut menu, click Tag
Number Activities > Change Instrument Type.
3. In the Select New Process Function and Instrument Type dialog box, do one of
the following:
• To change both the process function and the instrument type in batch
mode, from the Process function list, select the required process
function, and on the data window highlight the required instrument
type.
• To change only the instrument type in batch mode, on the data
window, select a different instrument type.
4. Click OK.
Tip
• When changing the process function, clicking OK opens the Tag
Number Renaming Options dialog box; when changing the
instrument type only, clicking OK completes the procedure.
5. On the Tag Number Renaming Options dialog box, do one of the following:
• Select the Keep general process data option to delete only process
data that is specific for each tag number.
• Select the Delete process data option to delete all the process data
associated with the tag numbers.

6. Select Change all so that SmartPlant Instrumentation does not prompt you to
change the process function and the instrument type for each tag number.
Tip
system tag name, and all the specifications associated with the tags
will be deleted. Verify that the appropriate loop blocks and hook-ups
are associated with the new tag number.
7. Click OK when done.
Notes
• If among the tags whose process function and instrument type you are
changing there are control system tags, SmartPlant Instrumentation
reopens the Tag Number Renaming Options dialog box, so that you
can rename the CS tags if you want to.
• To find and select the instrument type that you require quickly, start
typing in the Find instrument type field, and the software highlights
the record in the data window as you type. If the instrument type is
not available, you can create a new one. For more details, see Working
with Instrument Types: An Overview, page 346.
Related Topics

Generating Documents: An Overview

SmartPlant Instrumentation enables you to generate various reports and
documentation to help you keep track of your <plant> and the items in it. For
example, the Loop Summary report, gives you an exact picture of all the loop
numbers in use within your <plant>, including those that don't have instrument tags
associated with them. All the reports are easily accessible from the Standard Index
Browser and include:
• Specification sheets
• Process Data sheets
• Drawing and Revision reports
• Available tag lists
• Loop Summary
• Generating Documents Common Tasks, page 413
Generating Documents Common Tasks

The following tasks are used frequently when you generate documents.
Generate a Specification Sheet for an Instrument

This option shows you how to generate specifications for the instruments you select
in an Instrument Index Standard Browser view. This option is useful when you need
to create a specification for a tag number for which a specification profile was defined
after the tag number had been created. Note that this option is applicable only to
instruments for which you have not generated specifications yet and if the tag has a
specification data profile. For more information, see Generate a Specification Sheet
for an Instrument, page 415.
Generate a Process Data Sheet for an Instrument

This option shows you how to generate process data sheets for the instruments you
select in an Instrument Index Standard Browser view. This option is useful when you
need to create a process sheet for a tag number for which a process data profile was
defined after the tag number had been created. Note that this option is applicable
only to instruments for which no process data sheets have been generated yet, and has
an appropriate instrument type. For more information, see Generate a Process Data
Sheet for an Instrument, page 415.

Generate a Drawing and Revision Report

This option shows you how to view and print out a report listing the drawings
(documents) and the drawing revision data for the tag numbers currently displayed in
an Instrument Index Standard Browser view. The report displays all the appropriate
tags according to the filtering and sorting conditions that you defined for the browser
view. You can display any of the following drawings:
• Specification
• Process data sheet
• Calculation sheet
• Loop drawing
• Hook-up drawing
• P&ID drawing
You can also display revision data for all of the above drawings, except P&ID
drawings. For more information, see Generate a Drawing and Revision Report, page
416.
Create a List of Available Tags

This option shows you how to generate a report that lists all the available numeric
segments of tag numbers in the current <unit> or <plant>. For more information,
see Create a List of Available Tags, page 416.
Generate Loop Summary Reports

This option shows you to how generate a summary report of the existing loop
numbers in the current <unit> or in all the <units> in the <plant>. You can generate
the following summary reports:
• Summary of all loop numbers.

• Summary of loop numbers with no associated tags.
For more information, see Generate Loop Summary Reports, page 417.
Generate Custom Table Reports

This option shows you how to generate a report that displays the values used in one or
more custom tables. Custom tables hold user-defined information for instrument
tags. You can only use custom tables after the Domain Administrator creates the
custom tables and names them as appropriate. For more information, see Generate
Custom Table Reports, page 418.
Related Topics

Generate a Specification Sheet for an Instrument

• Click .
2. Select the required tag numbers and do one of the following:
• Click Actions > Apply Profile > Generate a Specification Sheet.
• Right-click the selected tag numbers and on the shortcut menu click
Apply Profile > Generate a Specification Sheet.
3. In the Results dialog box, take note of the generation results and then click Close.
4. Access the new specification sheet by doing one of the following:
• Select the required tag numbers in the browser view and click .
• Select the required tag numbers in the browser view, click Actions >
Documents.
Related Topics
Generate a Process Data Sheet for an Instrument

• Click .
2. Select the required tag numbers and do one of the following:
• Click Actions > Generate a Process Data Sheet.
• Right-click the selected tag numbers and on the shortcut menu click
Generate a Process Data Sheet.
3. In the Results dialog box, take note of the generation results and then click Close.
4. Access the new specification sheet by doing one of the following:
• Select the required tag numbers in the browser view and click .
• Select the required tag numbers in the browser view, click Actions >
Documents.
Note
• You can generate a process data sheet only if the tag that has an
appropriate instrument type. For details, see Define an Instrument
Type Profile, page 348

Generate a Drawing and Revision Report

• Click .
2. Click Actions > Drawing Report.
3. In the Select Drawings and Revisions dialog box, do one of the following:
• Under Drawings, select the check boxes beside the drawings you want
to include in the drawing report or check the Select all drawings
check box.
• Under Revisions, select the check boxes beside the revisions you
want to include in the report or check the Select all revisions check
box.
4. Click OK to generate the report.
Note
• If revisions are available they can only be selected after the
appropriate drawings have been selected.
Related Topics
Create a List of Available Tags

1. On the Instrument Index Module window, click Reports > Available Tag
Numeric Segments.
2. On the Generate Available Tags List dialog box, do the following to set your
report criteria:
a. In the Numeric segment range group box, type the range of numbers that
will be included in the report.
b. Select Current <unit> or <plant> to specify the plant hierarchy level for the
tag numbers that will be included in the report.
c. For one process function, in the Process function selection group box, select
the Process function option button and then the required process function
from the list.
d. For all the existing process functions, select the Select all option. You can
also select the Include duplicate numbers for different process functions
check box if you want to include any duplicate numeric segments in tag
numbers belonging to different process functions.

e. Select the Exclude reserved tags check box to exclude the numeric segments
of reserved tag numbers.
f. Click OK
3. When prompted select Yes to preview the report before printing, select No to
print the report without previewing first.
Related Topics
• Batch Loop Creation from Typical Loops, page 388
Generate Loop Summary Reports

1. On the Instrument Index Module window, click Reports > Loop Summary.
2. In the Report Selection Options dialog box, do one of the following:
• Select Current <unit>, so that you can generate a loop summary
report of the loop numbers in the <unit> you are working.
• Select Current <plant>, so that you can generate a loop summary
report of the existing loop numbers in all the <units> in the current
<area>.
• Select All <units> in the <plant>, so that you can generate a loop
summary report of the existing loop numbers in all the <units> in the
current <plant>.
3. Click OK.
4. In the Loop Selection dialog box, do one of the following:
• Select All loops to generate the Summary of All Loop Numbers report.
• Select Loops with no associated tags to generate Summary of Loop
Numbers with no Associated Tags report.
5. Click OK.
6. When prompted select Yes to preview the report before printing, select No to
print the report without previewing first.
Related Topics

Generate Custom Table Reports

1. On the Instrument Index Module window, click Reports > Tables > Custom
Tables.
2. On the Select Custom Tables for Report dialog box, select a check box from
the Include column, beside every custom table that you want to include in the
report.
Tip
• Select the Include all check box, to include all of the available custom
tables into the report.
Related Topics

Working with External Documents: An Overview

External documents, that are associated with instrument tags, serve as an additional
document for the storage of information that can not be directly entered into
SmartPlant Instrumentation. These documents can be viewed and modified from
SmartPlant Instrumentation. Each document can be associated with a number of
Instrument tags and can be in any format supported by your Windows environment,
such as .doc, .txt, . bmp, .wav, and so forth.
Related Topics
• Managing External Documents Common Tasks, page 419
Managing External Documents Common Tasks

The following tasks are used frequently when you want to associate an external
documents with existing instrument tags in your plant.
Associate an External Document with Instrument Tags

This option shows you how to associate an external document to existing instrument
tags. For more information, see Associate an External Document with Instrument
Tags, page 420.
Open an External Document Associated with an Instrument Tag

This option shows you how to open an external file associated with an instrument.
You can do this on the fly while associating files with an instrument. SmartPlant
Instrumentation starts the appropriate application that is associated with the file you
want to open. For more information, see Open an External Document Associated
with an Instrument Tag, page 421.
Dissociate an External Document Associated with an Instrument Tag

This option shows you how to dissociate an external document from the instrument
tags. For more information, see Dissociate an External Document Associated with an
Instrument Tag, page 421.

View Associated Documents

Tag numbers in SmartPlant Instrumentation are associated with various documents
whether these are documents generated by the software or external documents that
can be opened with another application. SmartPlant Instrumentation displays the type
of document that is associated with a selected tag number in the Documents pop-up
window from which you can open the appropriate document on the fly.
Using this option, you can view the following documents associated with a tag
number:
• Various reports generated in other modules: Specifications, Process

Data, Calculation, and so forth.
• Enhanced SmartLoop drawings.
• Loop drawings generated using your CAD application (SmartSketch,
AutoCAD or MicroStation).
• Hook-Up drawings.
• External documents created using other applications.
Associate an External Document with Instrument Tags

2. Highlight the instrument tags you want to associate with an external file.
3. Click Actions > Associate Documents.
4. On the Associated Documents dialog box, click Associate.
5. On the Associate External Document dialog box, navigate to the required file
and click Open.
6. Click on the Description field and type a brief description as needed.
7. Click OK.
Related Topics

Open an External Document Associated with an Instrument

Tag
2. Highlight the required tag numbers.
4. On the Associated Documents dialog box, highlight the file you want to open.
• Click Open.
• Double click the highlighted file.
Related Topics
Dissociate an External Document from an Instrument Tag

2. Highlight the required instrument tags.
4. On the Associated Documents dialog box, highlight the external file you want to
dissociate.
5. Click OK.
Related Topics
View Associated Documents

2. Select the required tag numbers and then do one of the following:
• Click Actions > Documents.
• On the Instrument Index tool bar, click .
3. On the Documents pop-up window, click one of the available options to display
the print preview of the available documents. The disabled options represent
unavailable document types.

4. To view external documents, on the Documents pop-up window:

a. Click Other.
b. On the Associated Documents dialog box, select a document.
c. Click Open.
5. To view associated CAD drawings, on the Documents pop-up window:
a. Click CAD Loop Drawings.
b. On the View Drawing File pop-up window, open the CAD drawing.
6. To view associated hook-up drawings, on the Documents pop-up window:
a. Click Hook-Up Drawing.
b. On the Associated Hook-Up Drawings dialog box, select the required
drawing.
c. Click View.
Note
• You can generate a report showing all the tags in the browser view and
their related documents. To generate a report, click Actions > Related
Documents Report.
Related Topics

Wiring in SmartPlant Instrumentation

Overview
SmartPlant Instrumentation provides the means to efficiently create a comprehensive
and detailed wiring design of your plant. You can create various types of wiring
items that perform specific functions in your plant. You can define and manage the
following:
• panels belonging to a number of different categories, such as junction

boxes, DCS and PLC panels, marshaling racks, and so forth
• plug-and-socket boxes that support Foundation Fieldbus and Profibus
systems
• field devices and their cables
• multi-input devices with either terminal or plug-and-socket
connections
• terminal strips and terminals
• wiring equipment (I/O cards, fieldbus bricks, safety barriers, hubs,
relays, and so forth)
• cables based on shipped and user-defined configurations that include
cable sets (pairs, triads, and so forth), wires, and connectors
After creating the required wiring items, you can effect I/O assignment and make the
required connections. This will enable you to create a point-to-point wiring diagram
and generate numerous wiring reports using the Enhanced Report Utility.
Related Topics
• Fieldbus and Conventional Multi-Input Devices: An Overview, page
723
• Foundation Fieldbus Design: An Overview, page 644
• I/O Assignment: An Overview, page 545
• Principles of Wiring Operations in SmartPlant Instrumentation, page
424
• Profibus Design: An Overview, page 707
• Splitting the Wiring Design Among Several Teams, page 425
• Wiring Equipment: An Overview, page 485

Principles of Wiring Operations in SmartPlant

Instrumentation
SmartPlant Instrumentation creates and keeps track of wiring routing and connections
by identifying the wires and their connection points.
The wires and the items to which they are connected are arranged hierarchically as
they appear in the Domain Explorer. These terms are described in detail in the
relevant help topics.
You can make connections between or within any of the <unit> in a <plant>.
Reference cables and panels are, however, available for all the <plants> in the
domain.
The following sequence of operations is necessary for the creation of a wiring

scheme:
• Creation of panels, plug-and-socket boxes, terminal strips, wiring

equipment, terminals, and so on
• Creation of cables, cable sets, and wires
• Connecting wires to terminals
In addition, tagged instruments may be wired so that their wiring routing is
automatically tracked and wire names are automatically propagated. For details, see:
• Device Panels: An Overview, page 468

Related Topics
723

Splitting the Wiring Design Among Several Teams

There are projects in which, for various reasons, several teams work on the wiring
design of the same project. These teams can be located at the same site or be in
different geographical locations.
A good example of such a project is when the main contractor designs the field
instrumentation wiring up to the marshaling racks while the DCS vendor is
responsible for the DCS design and also for the design of the wiring from the
marshaling panels to the terminals of the I/O cards that they supply, as shown below:
At the end of the project, or at any intermediate stage, there is a need to integrate both
designs into one database to complete the wiring from the field to the DCS and then
generate the complete loop diagrams and the wiring reports.
At this time, the boundary or the scope of the design that each party is responsible for
can vary from project to project. Usually, the intersection point would be somewhere
around a marshaling panel, either at the field side of a terminal strip and the control
system terminal strip side. This issue is usually discussed between the parties and
they agree where to draw this line.
In SmartPlant Instrumentation, we recommend the following strategy to handle this

split wiring design:
1. The main contractor or the EPC starts with the creation of an As-Built domain and
then creates a project for each of the working parties involved in the overall
design. In the example mentioned above, the main contractor works on the main
As-Built plant and defines the projects for the DCS vendors.
2. All the teams work on the same database using Citrix. However, it is also
possible to work offline.

Using this approach for splitting the design has the following advantages:
• Provides the ability to see the current As-Built data while connecting
to the data (and not the other way around).
• Enables good control of new tag numbers and subcomponents.
• Retains the uniqueness of rules when adding various subcomponents
such as terminals on a terminal strip.
• Enables the comparison of As-Built loops and project loops.
Note that the members of the various teams working on the projects have to be
informed of the changes made in As-Built so that they can update their databases.
Consequently, based on the data maturity, teams should coordinate among themselves
when to transfer their wiring data to the rest of the projects.
For more information, see Operating Owner Domain (As-Built and Projects): An
Overview in the Administration User's Guide, under Domain and Project
Administration, Operating Owner: General Activities.

Creating a Wiring Scheme

After the System Administrator initializes and creates a domain, SmartPlant
Instrumentation creates the following items:
• reference cables
• reference device panels with terminal strips
• connection types
These reference items suffice for the most common connections to device panels. For
more sophisticated combinations, you should create your own reference items.
For example, for a 2-wire device you need to create in the Reference Explorer:
• a device panel with a two-terminal strip named DEFAULT 2W

DEVICE PANEL
• a cable with a shielded twisted pair (cable + one shielded pair), named
DEFAULT 2W CABLE
• a connection device that connects two wires from a pair one after the
other named 2 IN A ROW
You can then select the above items the wiring profile to define the reference wiring
properties for a given instrument type.
When you start a new wiring scheme, the folders in the Domain Explorer are empty.
You can right-click one of the panel folders in the Domain Explorer and on the
shortcut menu, click New and then click the required option. The Reference
Explorer contains several reference panels and cables that are provided as shipped
data that you can copy to the Domain Explorer.
Note that you must have appropriate access rights to alter the reference items.
Related Topics
• Create a Reference Item, page 256

Name and Sequence Uniqueness of Wiring Items

When creating or editing the properties of a wiring item , SmartPlant Instrumentation
validates that the wiring item has a unique name and sequence. The software applies
the following validation rules:
Item Sequence
If SmartPlant Instrumentation detects that the sequence of a wiring item is not unique,
the software displays an appropriate message and does not create the item until you
enter a unique sequence.
The software validates sequence uniqueness according to the following rules:
• In an Operating owner domain, the software validates sequence

uniqueness in As-Built and all the projects belonging to the current
Operating owner domain.
• Panels, cables, and connectors do not require any sequence.
• Terminals must have a sequence which is unique at the terminal strip
level.
• All the other wiring items must have a sequence which is unique at the
level of the immediate parent item under which the item exists.
Item Names
If SmartPlant Instrumentation detects that an item does not have a unique name, the
software displays a warning message, after which you proceed depending on the
setting you made on the General page of the wiring preferences. You can set the
software to proceed without changing the item name if you do not select the Enforce
name uniqueness wiring preference option on the General page. If you select the
Enforce name uniqueness check box, you must rename the item in order to proceed
with your work.
The software validates name uniqueness according to the following rules:
• In an Operating owner domain, the software validates name

uniqueness in As-Built and all the projects belonging to the current
Operating owner domain.
• For panels and cables, SmartPlant Instrumentation checks for name
uniqueness at the level of the current <plant>.
• Wires do not require name uniqueness.
• The software checks for terminal name uniqueness at the terminal strip
level.

• For all the other wiring items, SmartPlant Instrumentation checks for
name uniqueness at the level of the immediate parent item under
which the item exists.
• If you try to create a wiring item that has no name, the software
prompts you to enter a name. If you select the Enforce name
uniqueness wiring preference option, the software treats items without
names according to the validation rules stated above. If you do not
select this wiring preference option, the software allows you to create
wiring items without names.
• When moving an item to another parent item , the software validates
the name uniqueness at the target level. If you did not select the
Enforce name uniqueness wiring preference option, the software
moves the item and retains its name. If you selected the Enforce
name uniqueness wiring preference option, the software does not
allow you to move the item if the item name violates the validation
rules.
For more information, see Naming Conventions: An Overview in the Administration
User's Guide, under Domain and Project Administration, Naming Conventions: An
Overview.

General Definitions Common Tasks

The following tasks are used frequently for general definitions in SmartPlant
Instrumentation.
Apply Naming Conventions to Wiring Items

SmartPlant Instrumentation allows you to apply naming conventions to various
wiring items. You can apply naming conventions to all panels, racks, and wiring
equipment. Note that naming conventions are set by your Domain Administrator.
After applying the naming conventions, the software renames the selected items
according to the existing conventions. You can apply naming conventions to a single
item or multiple items. If you need to that for a single wiring item, you can do it in
the Properties dialog box of that item by selecting the Apply naming convention
check box.
For more information, see Apply Naming Conventions to Wiring Items, page 430.
Remove Trailing Separators From Wiring Item Names

Wiring items that have been created according to naming conventions sometimes may
have trailing separators. This happens when the last naming convention segment is
not defined and there is no value for it. You can instruct the software to remove the
trailing separators automatically when creating wiring items. For more information,
see Remove Trailing Separators From Wiring Item Names, page 431.
Apply Naming Conventions to Wiring Items

1. In the Domain Explorer, do one of the following:
• In the Tree view, select one desired item.
• Expand a folder and in the Items pane, select the items you require.
2. Right-click the selected items and then on the shortcut menu, click one of the
following:
• Apply Naming Conventions to Selected Items— to rename only the
items you selected without renaming the child items that exist on the
lower hierarchy level of these items.
• Apply Naming Conventions to Selected Items and Child Items—
to rename the items you selected and all the child items that exist on
the lower hierarchy level of these items.
Related Topics
• General Definitions Common Tasks, page 430

Remove Trailing Separators From Wiring Item Names

1. In the Wiring module, click File > Preferences.
2. In the Preferences dialog box, under Wiring, click Custom.
3. In the Custom features for the Wiring module group box, under Parameter,
type Remove Trailing Separator.
4. Under Value type Y.
Note
• The default setting is N which instructs the software not to remove the
trailing separators,
Related Topics
• General Definitions Common Tasks, page 430
Associate a Symbol with an Item

Important
• Make sure that you have defined a custom symbol folder in the
SmartPlant Instrumentation Preferences dialog box for the appropriate
enhanced report type before you associate a symbol with an item.
• When you associate a symbol with an item that can have more than
one possible relation to other items for which you want to display data,
make sure that the symbol you select uses macros with the appropriate
relations. If a macro has an incorrect relation, the software cannot
display the data.
1. In the Domain Explorer, select the desired item , for example, a particular panel.
2. Right-click the item and click Properties.
3. Click the Associate Symbols tab.
4. Click New.
5. In the Name column, select the desired report type.
6. Beside the Symbol File column, click Browse.
7. Navigate to the desired .sym file.
8. If you require, repeat steps 4 -7 to associate symbols with the item for other report
types.
Tip
• When associating symbols with a panel, for example, you will use one
symbol to represent the panel in a Location Layout report, and another
symbol to represent the panel in a Panel Layout report.

Notes
• For an instrument, when you associate a symbol for Enhanced Report
Utility reports, the symbol will also be displayed in other wiring
reports.
• You can associate each item with one symbol only per available report
type.
• You can associate the same symbol with more than one item if you
desire.
• When using custom terminal symbols in enhanced reports, there are
two ways of displaying the terminals on the drawing sheet:
1. Associating a symbol with a panel, where the symbol exactly represents the
panel-strip-terminal configuration, and dragging the panel onto the drawing
sheet. With this method, the software displays the entire panel.
2. Associating a symbol with each individual terminal and dragging the desired
terminals onto the drawing sheet. With this method, the software displays the
selected terminals with their associated strips and panels, together with the
appropriate macros.

Creating and Managing Cables: An Overview

You create new cables in SmartPlant Instrumentation based on a particular cable
configuration. A cable configuration includes a particular arrangement of cable sets
(pairs, triads, and so forth within a cable) and wires to be built with the cable.
Therefore, when creating a new cable, you have to select an existing cable
configuration or define a new one. After creating a cable, you can add additional
cable sets and wires to that cable if required.
As a time saver, it is recommended that you create reference items for the cable, cable
set, and wire arrangements you intend to use frequently. You create these reference
cables in the Reference Explorer. You can then drag them to the Domain Explorer
and this way create numerous cables on the fly.
In SmartPlant Instrumentation Explorer, cables occupy the top hierarchy level

under which you can create various wiring items such as cable sets, wires, and
connectors. There is a lot of flexibility in creating a cable hierarchy. There is no
rigid structure like "cable – cable set – wire" that limits your cable design. You
can create various cable hierarchy structures, as you require. See Cable Hierarchy
Example, page 223 to examine a possible structure.
Related Topics
• Creating and Managing Cables Common Tasks, page 434
218

Creating and Managing Cables Common Tasks

The following tasks are used frequently when you manage the cables in your plant.
Define a Cable Configuration

This option allows you to create a new cable configuration. All cables in SmartPlant
Instrumentation are based on a particular cable configuration. Therefore, you need a
cable configuration so that you can create a new cable. A cable configuration
includes a cable set (pairs, triads, and so forth within a cable) and wire arrangement.
As a result, when creating a new cable, SmartPlant Instrumentation creates the
required cable sets and wires within that cable automatically based on the
configuration that you define. You can add more cable sets and wires to that cable
manually later if needed. For more information, see Define a Cable Configuration,
page 438.
Edit a Cable Configuration

This procedure explains how to modify an existing cable configuration. For more
information, see Edit a Cable Configuration, page 439.
Delete a Cable Configuration

This procedure explains how to delete a cable configuration. For more information,
see Delete a Cable Configuration, page 441.
Create a Cable
This procedure explains how to create cables. You can create new cables either in the
Domain Explorer or the Reference Explorer. If you are creating a cable that is
going to have a frequently used configuration, we recommend that you create it in the
Reference Explorer. Reference cables facilitate fast creation of plant cables by
copying an existing cable configuration from the Reference Explorer to the Domain
Explorer. However, if you want to create a cable that does not have a configuration
that you intend to use frequently, we recommend that you create this cable in the
Domain Explorer and in the <unit> where it is to be physically located. This is
helpful when filtering the cables in the current <unit>.
For more information, see Create a Cable, page 441.

Create a Connector
Connectors are needed for fieldbus home-run cables, telecom cables, and other cables
that require connectors. SmartPlant Instrumentation allows you to build your wiring
system with any of the following connector implementations:
• Connector at one or both cable ends

• Connector at end of a single cable set
• Connector at end of wires from different cable sets
For details on how to create a connector, see Create a Connector, page 443.
Edit Cable Properties

This procedure shows how to edit the properties of a cable. For more information,
see Edit Cable Properties, page 444.
Create a Cable Without Sets and Wires

This option allows you to create a cable that does not have any sets or wires. You can
use such cables in the early stages of your design and when creating cable block
diagrams where it is not necessary to specify cable types, the number of sets and
wires in the cables, and so forth. For more information, see Create a Cable Without
Sets and Wires, page 447.
Apply a Reference Cable to Multiple Cables Without Sets and Wires

This feature enables you to apply a reference cable to cables that do not have any sets
or wires. This batch operation enables you to select multiple cables in the Domain
Explorer and then select an appropriate reference cable for each cable that you
selected. For more information, see Apply a Reference Cable to Multiple Cables
Without Sets and Wires, page 448.
Apply a Reference Cable to One Cable Without Sets and Wires

This procedure explains how to apply a reference cable to a single cable that does not
have any sets or wires. You can apply a reference cable or a cable structure as you
require. For more information, see Apply a Reference Cable to One Cable Without
Sets and Wires, page 449.
Add a Cable Set

SmartPlant Instrumentation adds cable sets (pairs, triads, and so forth within a cable)
automatically when you create a new cable based on a cable configuration. This
procedure describes how you can add another cable set to an existing cable that
already contains a number of cable sets. For more information, see Add a Cable Set,
page 445.

Add a Wire to a Cable Set

SmartPlant Instrumentation adds wires automatically when you create a new cable
based on a cable configuration. This procedure describes how you can add another
wire to an existing cable set. You can add a wire either to a cable set created
automatically or to a cable set that you added manually. For more information, see
Add a Wire to a Cable Set, page 446.
Edit Wire Properties

This option describes how to edit the properties of a wire. For more information, see
Edit Wire Properties, page 449.
Define or Edit a Connector Type

A connector type contains pin configuration and other properties for a connector
model of a specific manufacturer. When you create a connector for a specific cable,
selecting a connector type copies these properties for the cable connector. For more
information, see Define or Edit a Connector Type, page 691.
Define or Edit a Connector Type Pin Configuration

This topic explains how to define or edit a pin configuration for a connector type. For
more information, see Define or Edit a Connector Type Pin Configuration, page 691.
Delete a Connector Type

This topic shows how to delete a connector type. For more information, see Delete a
Connector Type, page 692.
Create a Connector

Assign Connector Pins to Cable Wires

This procedure shows how to assign connector pins to cable wires. For more
information, see Assign Connector Pins to Cable Wires, page 693.

Associate a Pin or a Terminal with a Channel

SmartPlant Instrumentation enables you to associate terminals and pins with wiring
equipment channels. Note that these terminals and the terminal strip must belong to
the same parent wiring equipment. Also, if you want to associate pins, the pins must
belong to a connector which is a child item of the parent wiring equipment.
After you drag a terminal or a pin to a wiring equipment channel, the software retains
it in its original place from which you dragged it. However, after expanding the
destination hierarchy, the software also shows the terminal or pin that you dragged.
This means that the terminal or pin is physically located in its original place but it is
associated with the item to which it was dragged.
For more information, see Associate a Pin or a Terminal with a Channel, page 694.
Delete a Connector
This topic shows how to delete a connector. For more information, see Delete a
Connector, page 694.
Apply Regional Wire Colors to Project Cables

This allows you to apply regional wire colors to your project cables based on
reference cables. For more information, see Apply Regional Wire Colors to Project
Cables, page 451.
Related Topics
• Create a Plug-and-Socket Device Panel, page 675

Define a Cable Configuration

2. In the Domain Explorer or Reference Explorer, right-click the Cables folder
and then click New > Cable.
3. In the Cable Configuration dialog box, click New.
4. In the New Cable Configuration dialog box, enter the total number of sets (pairs,
triads, and so forth) that SmartPlant Instrumentation will create automatically
when a new cable is based on this new configuration.
Tip
• Add an additional cable set for an overall shield.
5. From the Default cable set type list, select the appropriate cable type.
Tip
• The selected cable type determines whether cables based on this
configuration have multiple wires, pairs, triads, and so forth.
6. Click OK to return to the Cable Configuration dialog box.
7. In the Cable Configuration dialog box, type the name of the new configuration
in the Cable Configuration data field.
8. In the Cable default name field, type a name of the cables that will be based on
the current configuration.
Tip
• This means that every time you create a new cable based on this new
configuration, SmartPlant Instrumentation uses this default setting to
name the new cable. You can then modify this name as needed when
you define the cable in the Cable Properties dialog box.
9. In the Description text field, type a brief description of the new configuration.
10. Click in the Cable Set text field and type the name of each cable set that is
defined in this configuration. You can rename the individual cable sets later if
needed when editing the cable set in the Cable Set Properties dialog box.
11. For each cable set, in the Cable Set Type field, accept the displayed value (the
cable set type you selected in the New Cable Configuration dialog box) or select
another one if needed.

12. For each first cable set of a given cable set type, do the following under Cable set
details:
a. Click in the Wire Tag text field and type the names of the individual wires
within the cable sets. You can accept the displayed value if needed.
b. From the Wire Color list, select a color for each wire. If the required value is
not available, you can add it in the Wire Color dialog box that you access
from the Tables menu in the Wiring Module window.
c. From the Wire Type list, select a type for each wire. If the required value is
not available, you can add it in the Wire Type dialog box that you access
d. From the Polarity list, select the appropriate polarity or shield for each wire.
13. For additional cable sets based on a cable set type for which you already entered
settings under Cable set details, do one of the following:
• To copy the values from a selected cable set to all sets based on the
current cable set type, click Apply. You can select the Exclude wire
tags check box before you click Apply if you do not wish to copy the
wire tags while copying wire color, wire type, and polarity details.
• Enter the settings individually for each cable set.
14. Click Save.
Related Topics
Edit a Cable Configuration

3. In the Cable Configuration dialog box, select a configuration from the Cable
configuration list.
4. Click Edit.
5. In the Cable Configuration dialog box, enter the total number of sets (pairs,
triads, and so forth) that SmartPlant Instrumentation will create automatically
when a new cable is based on this new configuration.
Tip
• Add an additional cable set for an overall shield.

6. From the Default cable set type list, select the appropriate cable type.
Tip
• The selected cable type determines whether cables based on this
configuration have multiple wires, pairs, triads, and so forth.
7. Click OK to return to the Cable Configuration dialog box.
8. In the Cable Configuration dialog box, type the name of the new configuration
in the Cable Configuration data field.
9. In the Cable default name field, type a name of the cables that will be based on
the current configuration.
Tip
• This means that every time you create a new cable based on this new
configuration, SmartPlant Instrumentation uses this default setting to
name the new cable. You can then modify this name as needed when
you define the cable in the Cable Properties dialog box.
10. In the Description text field, type a brief description of the new configuration.
11. Click in the Cable Set text field and type the name of each cable set that is
defined in this configuration. You can rename the individual cable sets later if
needed when editing the cable set in the Cable Set Properties dialog box.
12. For each cable set, in the Cable Set Type field, accept the displayed value (the
cable set type you selected in the New Cable Configuration dialog box) or select
another one if needed.
13. For each first cable set of a given cable set type, do the following under Cable set
details:
a. Click in the Wire Tag text field and type the names of the individual wires
within the cable sets. You can accept the displayed value if needed.
b. From the Wire Color list, select a color for each wire. If the required value is
not available, you can add it in the Wire Color dialog box that you access
c. From the Wire Type list, select a type for each wire. If the required value is
not available, you can add it in the Wire Type dialog box that you access
d. From the Polarity list, select the appropriate polarity or shield for each wire.

14. For additional cable sets based on a cable set type for which you already entered
settings under Cable set details, do one of the following:
• To copy the values from a selected cable set to all sets based on the
current cable set type, click Apply. You can select the Exclude wire
tags check box before you click Apply if you do not wish to copy the
wire tags while copying wire color, wire type, and polarity details.
• Enter the settings individually for each cable set.
15. Click Save.
Related Topics
Delete a Cable Configuration

3. In the Cable Configuration dialog box, select a configuration from the Cable
configuration list.
4. Click Delete.
Related Topics
Create a Cable
3. In the Cable Configuration dialog box, select a cable configuration from the
Cable configuration list.
Tip
• Click New if you do not have a suitable configuration. For details, see
Define a Cable Configuration, page 438.

4. Click Create.
5. In the Cable Properties dialog box, under Cable, type the cable name.
Tip
• If you are working under cable type dependency, your selection of
cable type determines the reference cable name.
6. Under Description, type the new cable description as needed.
7. Select one of the following under Cable class:
• To create a conventional cable, accept the default setting
Conventional.
• To create a fieldbus spur, select Conventional.
• To create a fieldbus home-run cable, select Fieldbus home-run.
• To create a telecom cable, select Telecom.
8. Under Type, select the required cable type if needed. If the required type is not
available, click next to the list arrow to add the required item to the list.
9. Select the cable manufacturer, model, color as appropriate. If the item that you
need is not on the list, click .
10. Type the end one and end two locations of the cable.
11. Type the cable length and select the unit of measure.
12. To assign this cable to a cable drum, select values from the Pulling area list and
from the Cable drum list. For details, see Assign Cables to Drums Manually
(Without Optimization), page 630.
13. To define a cable harness, select the cable harness from the list. If the item that
you need is not on the list, click .
14. To name the wires ends in this cable according to a naming convention, select the
appropriate naming convention from the Wire end naming convention list.
15. To define the cable as intrinsically safe, select Set as intrinsically safe.
16. To define glands for the cable, from the Glands group box, select the End 1, End
2 or both cable glands. If the required gland is not available, click .
17. Note the graphic representation of cable glands in the software:
— A cable with no glands
— A cable with a gland on one of its sides
— A cable with a gland on both sides

18. Click Connectors to create connectors for the cable and manage connector-wire
assignments.
19. In the Cable Properties dialog box, click OK.

Create a Connector
1. In the Domain Explorer or Reference Explorer, do one of the following:
• To create a new cable, right-click the Cables folder and on the
shortcut menu click New > Cable.
• Right-click an existing cable, and on the shortcut menu click
Properties.
2. Modify cable properties as needed. For details, see Create a Cable, page 441.
3. Click Connectors.
4. In the Connector Assignments dialog box, do one of the following:
• To manage connector-wire associations for end 1 of the cable, click
the End 1 tab.
• To manage connector-wire associations for end 2 of the cable, click on
the End 2 tab.
5. In the Connector Assignments dialog box, click New.
6. In the Connector Properties dialog box that opens, under Connector, type the
name of the new connector.
• From the list, select a connector type as configured.
• To modify or create a connector type, click . For details, see Define
or Edit a Connector Type, page 691.
7. Under Male/female select Male or Female as needed.
8. Click OK to return to the Connector Assignments dialog box.
Note
• You can now assign. For details, see Define or Edit a Connector Type
Pin Configuration, page 691.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 645
• Making Connections and Associations for Fieldbus Common Tasks,
page 689
• Profibus Design Common Tasks, page 710

Edit Cable Properties

2. Expand the Cables folder and right-click a cable.
3. On the shortcut menu, click Properties.
4. In the Cable Properties dialog box, under Cable, type the cable name.
Tip
• If you are working under cable type dependency, and have already
created plant cables based on a reference cable that you are editing,
certain reference cable fields are not enabled for editing. The System
Administrator can enable cable type dependency when making domain
definitions.
5. Under Description, type the new cable description as needed.
6. Select one of the following under Cable class:
• To create a conventional cable, accept the default setting
Conventional.
• To create a fieldbus spur, select Conventional.
• To create a fieldbus home-run cable, select Fieldbus home-run.
• To create a telecom cable, select Telecom.
7. Under Type, select the required cable type if needed. If the required type is not
available, click next to the list arrow to add the required item to the list.
8. Select the cable manufacturer, model, color as appropriate. If the item that you
need is not on the list, click .
9. Type the end one and end two locations of the cable.
10. Type the cable length and select the unit of measure.
11. To assign this cable to a cable drum, select values from the Pulling area list and
from the Cable drum list. For details, see Assign Cables to Drums Manually
(Without Optimization), page 630.
12. To define a cable harness, select the cable harness from the list. If the item that
you need is not on the list, click .
13. To name the wires ends in this cable according to a naming convention, select the
appropriate naming convention from the Wire end naming convention list.
14. To define the cable as intrinsically safe, select Set as intrinsically safe.

15. To define glands for the cable, from the Glands group box, select the End 1, End
2 or both cable glands. If the required gland is not available, click .
16. Note the graphic representation of cable glands in the software:
— A cable with no glands
— A cable with a gland on one of its sides
— A cable with a gland on both sides

17. Click Connectors to create connectors for the cable and manage connector-wire
assignments.
18. In the Cable Properties dialog box, click OK.
Related Topics
Add a Cable Set

Important
created plant cables based on a particular reference cable, the software
does not allow you to add cable sets to such a reference cable. Further,
you cannot add cable sets to a plant cable created under cable type
dependency. The System Administrator can enable cable type
dependency when making domain definitions.
2. Expand the Cables folder and right-click a cable.
3. On the shortcut menu, click New > Cable Set.
4. In the Cable Set Properties dialog box, type the cable set name in the Cable set
text field.
5. Under Cable set sequence, enter the sequence of the cable set in the cable.
Tip
• Typically, the cable set sequence is determined by the manufacturer.
If you change the sequence number of a cable set, make sure that you
also change the sequence number of the other cable sets in the cable as
appropriate to avoid duplicate values and erroneous terminations.
6. Click OK to add a new cable set.

Add a Wire to a Cable Set

Important
does not allow you to add cable sets or wires to such a reference cable.
Further, you cannot add cable sets or wires to a plant cable created
under cable type dependency. The System Administrator can enable
cable type dependency when making domain definitions.
2. Expand the Cables folder and then double-click a cable to display its cable sets.
3. Right-click a cable set and then on the shortcut menu, click New > Cable Wire.
4. In the Wire Properties dialog box, under Wire, type the wire tag.
Tip
• By default, wire tags are based on the signal that they carry. To name
wires based on user input the Domain Administrator needs to enable
5. In the Details group box, under Wire sequence in set, accept the automatically
assigned value that determines the numbering sequence of the wire in the cable
set.
Tip
• The values that SmartPlant Instrumentation suggests under Wire
sequence in set are unique throughout As-Built and all engineering
projects where the current cable set appears.
6. From the Polarity list, select the signal polarity or shield.
Tip
• When you create a cable for the first time, or when you copy from
reference cables, check for the existence of shield indication wherever
needed. Shield indication is important when SmartPlant
Instrumentation propagates signals through wires. In this case, the
software does not overwrite the wire tag with the tag signal. You can
also define a wire as an overall shield if required.
7. From the Type list, select the required wire type. If the required type is not on
this list, click next to the list arrow to open a dialog box where you can add,
modify, or delete items from the Wire type list.

8. From the Color list, select the required wire color. If the required color is not on
modify, or delete items from the Wire color list.
9. In the Note text field, type a brief note if needed.
10. To name the wire ends according to a naming convention, select the appropriate
naming convention from the Wire end naming convention list. Note that this
check box is available only if the Domain Administrator has enabled it in the
Wire End Naming Conventions dialog box.
11. Do the following to name the wire ends not according to a naming convention:
a. Select Override naming convention.
b. Under Wire end 1, type the first wire end name.
c. Under Wire end 2, type the second wire end name.
12. Click Revisions to manage revisions for the current wire.
13. Click OK in the Wire Properties dialog box.
Related Topics
Create a Cable Without Sets and Wires

Important
• The software does not allow you to create cables without sets and
wires if you are working under cable type dependency.
2. Right-click the Cables folder and then on the shortcut menu click New > Cable.
3. On the Cable Configuration dialog box, click New.
4. Do the following on the New Cable Configuration dialog box:
a. Under Number of cable sets, type 0 (zero).
b. Click OK.
5. On the Cable Configuration dialog box, click Save and then Create.

6. On the Cable Properties dialog box, enter the cable properties as you require.
Tip
• Since cables without cable sets and wires are useful during the early
stages of plant design and when creating cable block diagrams, the
only cable property that you need to enter is the cable name. You can
populate the other properties when you apply a reference cable to this
cable.
7. Click OK.
Related Topics
Apply a Reference Cable to Multiple Cables Without Sets

and Wires
1. In the Domain Explorer, click the Cables folder.
2. In the Items pane, press and hold the Ctrl key and then right-click the cables you
require.
3. On the shortcut menu, click Actions > Apply Reference Cable.
4. On the Apply Reference Cable dialog box, select an appropriate reference cable
for each cable.
5. Click OK.
Related Topics

Apply a Reference Cable to One Cable Without Sets and

Wires
1. In the Domain Explorer, click the Cables folder.
2. In the tree view right-click a cable you require.
3. On the shortcut menu, click Actions > Apply Cable Structure.
4. On the Apply Cable Structure dialog box, do one of the following:
• Click the Create items based on a reference cable option button and
then select an appropriate reference cable from the list.
• Click the Create items based on a cable configuration option button
and then select an appropriate cables structure from the list. You can
click to open the Cable Configuration dialog box to define a new
cable configuration if needed.
5. Click OK.
Related Topics
Edit Wire Properties

Important
does not allow you to add cable sets or wires to such a reference cable.
Further, you cannot add cable sets or wires to a plant cable created
under cable type dependency. The System Administrator can enable
2. Expand the Cables folder and then double-click a cable to display its cable sets.
3. Double-click a cable set to display the existing wires.
4. Right-click a wire and then on the shortcut menu, click Properties.
5. In the Wire Properties dialog box, under Wire, type the wire tag.

Tip
• By default, wire tags are based on the signal that they carry. To name
wires based on user input the Domain Administrator needs to enable
6. In the Details group box, under Wire sequence in set, accept the automatically
assigned value that determines the numbering sequence of the wire in the cable
set.
Tip
• The values that SmartPlant Instrumentation suggests under Wire
sequence in set are unique throughout As-Built and all engineering
projects where the current cable set appears.
7. From the Polarity list, select the signal polarity or shield.
Tip
• When you create a cable for the first time, or when you copy from
reference cables, check for the existence of shield indication wherever
needed. Shield indication is important when SmartPlant
Instrumentation propagates signals through wires. In this case, the
software does not overwrite the wire tag with the tag signal. You can
also define a wire as an overall shield if required.
8. From the Type list, select the required wire type. If the required type is not on
modify, or delete items from the Wire type list.
9. From the Color list, select the required wire color. If the required color is not on
modify, or delete items from the Wire color list.
10. In the Note text field, type a brief note if needed.
11. To name the wire ends according to a naming convention, select the appropriate
naming convention from the Wire end naming convention list. Note that this
check box is available only if the Domain Administrator has enabled it in the
Wire End Naming Conventions dialog box.
12. Do the following to name the wire ends not according to a naming convention:
a. Select Override naming convention.
b. Under Wire end 1, type the first wire end name.
c. Under Wire end 2, type the second wire end name.
13. Click Revisions to manage revisions for the current wire.
14. Click OK in the Wire Properties dialog box.
Related Topics

Apply Regional Wire Colors to Project Cables

Important
• This feature works only if your System Administrator has enabled the
1. Import the required reference cables.
2. In the target database, turn off the cable type dependency feature.
3. Change the wire color of the reference cables.
4. Turn on the cable type dependency feature.
5. In the Wiring module, click Actions > Apply Regional Wire Colors.
6. On the Apply Regional Wire Colors dialog box, click Apply.
Notes
• You can view the results on the Regional Wire Colors Application
Results dialog box.
• The software applies the wire colors only to those project cables that
fully conform to the structure of reference cables on the basis of which
they were built. That is, project cables must have the same number of
cable sets and wires in each set as the appropriate reference cables.
Related Topics

Conventional Panels: An Overview

The Wiring module enables you to create and configure various types of conventional
panels. Conventional panels in SmartPlant Instrumentation refer to all types of panels
and cabinets that do not have a plug-and-socket connection. In SmartPlant
Instrumentation Explorer, panels occupy the top hierarchy level under which you
can create various wiring items such as terminal strips, I/O cards, racks, and so on.
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
Example, page 221 to examine a few possible structures.
SmartPlant Instrumentation allows you to create the following types (categories) of

conventional panels:
• Junction boxes
• Marshaling racks
• Cabinets (multi-purpose panels)
• Device panels
• Distributed Control System (DCS) panels
• Programmable Logic Controller (PLC) panels
Related Topics
• Fieldbus Plug-and-Socket Boxes: An Overview, page 673
218

Managing Conventional Panels Common Tasks

The following tasks are used frequently when you manage the conventional panels in
your plant. Conventional panels in SmartPlant Instrumentation are those panels that
do not have a plug-and-socket connection.
You can create new panels either in the Domain Explorer or the Reference
Explorer. If you are creating a panel that is going to have a frequently used
configuration, we recommend that you create it in the Reference Explorer.
Reference panels facilitate fast creation of plant panels by copying an existing panel
configuration from the Reference Explorer to the Domain Explorer. However, if
you want to create a panel that does not have a configuration that you intend to use
frequently, we recommend that you create this panel in the Domain Explorer and in
the <unit> where it is to be physically located. This is helpful when filtering the
panels in the current <unit>.
Create a Junction Box

This procedure explains how to create a generic junction box. For more information,
see Create a Junction Box, page 455.
Create a Marshaling Rack

This procedure explains how to create a marshaling rack. For more information, see
Create a Marshaling Rack, page 456.
Create a Cabinet
This procedure explains how to create a cabinet. For more information, see Create a
Cabinet, page 458.
Create an Unassociated Conventional Device Panel

This procedure explains how to create a device panel that is not associated with any
tag number and not connected to any device cable. For more information, see Create
an Unassociated Conventional Device Panel, page 459.
Create a Distributed Control System (DCS) Panel

This procedure explains how to create a distributed control system (DCS) panel. For
more information, see Create a Distributed Control System (DCS) Panel, page 461.
Create a Programmable Logic Controller (PLC) Panel

This procedure explains how to create a programmable logic controller (PLC) panel.
For more information, see Create a Programmable Logic Controller (PLC) Panel,
page 463.

Create a Panel with Terminals and Connectors

Use this procedure to create a panel that contains both terminals and plug-and-socket
connections. Some fieldbus and Telecom devices have inputs via a plug-and socket
arrangement and outputs via terminated wires on terminals. To provide for this need,
SmartPlant Instrumentation allows you to add a connector under any panel type
(except for device panels) and then make the required connections either through the
terminals or the connectors. For more information, see Create a Panel with
Terminals and Connectors, page 464.

This procedure explains how to enter power supply data for various panels 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,

This feature allows you to customize field headers on various dialog boxes, windows,
and reports to fit panel manufacturer terminology. The customized field headers and
labels replace the default headers and labels. The default headers are the same as the
Data Dictionary display names. After customizing panel manufacturer-specific
headers, the custom headers appear not only on the relevant panel properties dialog
box but also on all child items dialog boxes and appropriate reports. For more
information, see Customize Manufacturer-Specific Field Headers, page 67.
Create a Rack
This procedure deals with the creation of racks. Since racks are panel child items,
you can add a new rack under any panel except for a device panel. For more
information, see Create a Rack, page 466.
Related Topics

Create a Junction Box

• Press F8 to open the Reference Explorer and expand the Panels
folder. For more information, see Create a Reference Item, page 256 .
• Expand the Panels by Category folder to display all the panel
category folders.
• Expand the Panels by Location hierarchy and right-click a location
where you want your new panel to reside.
3. In the Domain Explorer under Panels by Category or in the Reference
Explorer under Panels, right-click the Junction Boxes folder and then click New
> Junction Box (Generic).
4. In the Junction Box Properties dialog box, on the General tab, do one of the
following to define the name of the new panel:
• Clear the Apply naming convention check box and under Panel, type
the name of the new panel. Note that if you do not clear the Apply
naming convention check box, the software will ignore the name that
you type under Panel.
• Keep the Apply naming convention check box selected if you want
the software to name the new panel automatically according to the
naming conventions that are set for this type of panel in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
5. Select the required values from the Type, Manufacturer, Model, Dimensions,
Area classification, and Location lists. If the required value is not available,
click next to the relevant list arrow to open the appropriate supporting table.
(For details, see Add a New Value to a Select List, page 66.)
6. Under Dimensions, type a value for the marshaling rack dimensions if needed.
7. Under Maximum number of racks, type a value to set the maximum number of
racks that can be created in this panel.
Tip
• Setting this value to zero means that the current panel can have an
unlimited number of racks.
8. Under Mounting, type a value if needed.
9. Under Backplane, type a value if needed.

10. Select the Set as intrinsically safe check box if this junction box has intrinsic
safety certification.
11. Click the Associate Symbols tab to associate a symbol with the current panel.
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 431.
12. Click Revisions to manage the revisions of the new panel if needed.
13. Click OK to accept your definitions for the new junction box and close this dialog
box.
Note
• To create a junction box panel that contains both terminals and plug-
and-socket connections, see Create a Panel with Terminals and
Connectors, page 464.
Related Topics
• Create a Panel with Terminals and Connectors, page 464
• Create a Plug-and-Socket Junction Box, page 676
Create a Marshaling Rack

category folders.
Explorer under Panels, right-click the Marshaling Racks folder and then click
New > Marshaling Rack.
4. In the Marshaling Rack Properties dialog box, on the General tab, do one of
the following to define the name of the new panel:

Naming Conventions.
Tip
10. Select the Set as intrinsically safe check box if this marshaling rack has intrinsic
11. If you need to enter power supply properties, select the Requires power supply
check box and then click the Power Supply tab. For details, see Enter Power
Supply Data for Panels and Instrument Tags, page 361.
Report Utility. For details, see see Associate a Symbol with an Item, page 431.
14. Click OK to accept your definitions for the new marshaling rack and close this
dialog box.
Note
• To create a marshaling rack that contains both terminals and plug-and-
socket connections, see Create a Panel with Terminals and
Related Topics

Create a Cabinet
category folders.
Explorer under Panels, right-click the Cabinets folder and then click New >
Cabinet.
4. In the Cabinet Properties dialog box, on the General tab, do one of the
Naming Conventions.
6. Under Dimensions, type a value for the cabinet dimensions if needed.
Tip
• Setting this value to zero means that the current cabinet can have an

10. Select the Set as intrinsically safe check box if this cabinet has intrinsic safety
certification.
13. Click Revisions to manage the revisions of the new cabinet if needed.
14. Click OK to accept your definitions for the new cabinet and close this dialog box.
Note
• To create a cabinet that contains both terminals and plug-and-socket
connections, see Create a Panel with Terminals and Connectors, page
464.
Related Topics

category folders.
Explorer under Panels, right-click the Device Panels folder and then click New
> Device Panel (Conventional).
4. In the Device Panel Properties dialog box, on the General tab, do one of the

Naming Conventions.
5. In the Address 1 and Address 2 fields, type the required definitions.
Tip
• You can change the Address 1 and Address 2 field headers to reflect
manufacturer specific terminology. For details, see Customize
Manufacturer-Specific Field Headers, page 67.
(For details, see Add a New Value to a Drop-Down List, page 66.)
9. Select the Set as intrinsically safe check box if this marshaling rack has intrinsic
12. Click OK to accept your definitions for the new device panel and close this dialog
box.
Note
• To create a device panel that contains both terminals and plug-and-
Related Topics
• Managing Device Panels Common Tasks, page 470

Create a Distributed Control System (DCS) Panel

category folders.
Explorer under Panels, right-click the DCS Panels folder and then click New >
DCS Panel.
4. In the Distributed Control System (DCS) Properties dialog box, on the
General tab, do one of the following to define the name of the new panel:
Naming Conventions.
5. In the Highway and Node fields, type the required DCS definitions.
Tip
• You can change the Highway and Node field headers to reflect
manufacturer-specific terminology. For details, see Customize
6. Select the required values from the Type, Manufacturer, Model, Area
classification, and Location lists. If the required value is not available, click
next to the relevant list arrow to open the appropriate supporting table. (For
details, see Add a New Value to a Select List, page 66.)

Tip
8. To create a DCS panel compatible with a Profibus DP segment, do the following:
a. Select the Enable DP Profibus check box.
b. Under DP Profibus node, type a node for the new panel.
12. Click OK to accept your definitions for the new DCS panel and close this dialog
box.
Note
• To create a DCS panel that contains both terminals and plug-and-
Related Topics

Create a Programmable Logic Controller (PLC) Panel

• Press F8 to open the Reference Explorer. For more information, see
Create a Reference Item, page 256 .
• Double-click the Panels by Location folder, right-click a location and
then on the shortcut menu click New > PLC Panel.
• Double-click the Panels by Category folder, right-click the DCS
Panels folder and then on the shortcut menu click New > PLC Panel.
3. In the Programmable Logic Controller (PLC) Properties dialog box, on the
General tab, do one of the following to define the name of the new panel:
Naming Conventions.
4. In the Address 1 and Address 2 fields, type the required PLC definitions.
Tip
• You can change the Address 1 and Address 2 field headers to reflect
manufacturer-specific terminology. For details, see Customize
next to the relevant list arrow to open the appropriate supporting table. (For
details, see Add a New Value to a Select List, page 66.)
Tip

7. To create a PLC panel compatible with a Profibus DP segment, do the following:

a. Select the Enable DP Profibus check box.
b. Under DP Profibus node, type a node for the new panel.
11. Click OK to accept your definitions for the new PLC panel and close this dialog
box.
Note
• To create a PLC panel that contains both terminals and plug-and-
Related Topics
Create a Panel with Terminals and Connectors

1. In the Domain Explorer or Reference Explorer, create or select a panel.
Tip
• You can select or create any type of panel except for device panels.
2. Right-click the panel you selected and then on the shortcut menu, click New >
Connector.
3. In the Connector Properties dialog box, under Connector, type the name of the
new connector.
4. Under Connector type, do one of the following:
• From the list, select a connector type with pins.
• To modify or create a connector type, click . For details, see
Making Connections and Associations for Fieldbus Common Tasks,
page 689.
6. Click OK.


1. Do one of the following to open the Properties dialog box of a panel or tag
number:
panel and then click Properties.
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.

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 a Rack
folder. Then, select a desired reference panel. For more information,
see Create a Reference Item, page 256 .
category folders.
• Expand the Panels by Location hierarchy to display the available
locations and their panels. Then, select a desired panel.
3. In the Domain Explorer or in the Reference Explorer, right-click the selected
panel and then click New >Rack.
4. In the Rack Properties dialog box, on the General tab, do one of the following
to define the name of the new panel:
• Clear the Apply naming convention check box and under Rack, type
the name of the new rack. Note that if you do not clear the Apply
you type under Rack.
naming conventions that are set for racks in the Administration
module. For more information, see SmartPlant Instrumentation
Administration Help, Domain Administration > Naming Conventions.
5. In the Details group box, type a description and sequence as you require.
6. Click Slots to add some slots for the current rack.

7. In the Batch Slot Creation dialog box, type the number of new slots that you
want to add in the new rack.
8. Do the following to define the slot numbering:
a. Type a prefix for the slot name.
b. Enter a value in the Start from number and Increment by fields.
9. Click OK and to add the new slots return to the Rack Properties dialog box.
Tip
• In the Rack Properties dialog box, the software now displays the
number of slots that you added.
10. Click the Associate Symbols tab to associate a symbol with the current rack. 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 431.
Note
• When duplicating a rack that contains child items, the software
duplicates the rack together with its child items.
Related Topics
Create a Slot
folder. Then, select a desired reference panel. For more information,
see Create a Reference Item, page 256 .
category folders.
• Expand the Panels by Location hierarchy to display the available
locations and their panels. Then, select a desired panel.
3. In the Domain Explorer or in the Reference Explorer, expand the hierarchy of a
panel to display the existing racks.
4. Right-click a rack and then click New > Slot.
5. On the Slot Properties dialog box, enter the values for the new slot as you require
and click OK.

Device Panels: An Overview

A device panel in SmartPlant Instrumentation is a wiring item that has wiring and
instrument tag information, for example transmitters, transducers, sensors, and so
forth.
Wiring information consists of a signal (a wire group), signal level, and signal
sequence. An instrument generates a signal which is carried through a group of
wires. These wires are connected to a device panel associated with that instrument.
The software propagates the signal through the wires on different levels. Signal
levels can be, for example, plus, minus, and shield. A signal sequence is a method
used by SmartPlant Instrumentation to assign numbers, in ascending or descending
increments, to connection points along the signal propagation path at the same signal
level.
The following diagram indicates how a device panel is associated with an instrument.
You may then continue the wiring routing as required.
Each signal level defines a signal routing associated with a particular loop. It is
possible to have up to 99 levels within one signal.
Note that SmartPlant Instrumentation automatically tracks signals and assigns the
signal, signal level, and signal sequence values when you create a device panel.
Related Topics
• Principles of Creating Device Panels, page 469

Principles of Creating Device Panels

SmartPlant Instrumentation offers the following options for device panel creation:
• Create an individual device panel in the Domain Explorer. This

device panel will not be associated with any instrument and will not
have a device cable.
• Create a device panel for an existing instrument and configure its
connection manually or automatically.
• Create a new instrument with an associated device panel and device
cable. You can configure the connection automatically or manually as
desired.
SmartPlant Instrumentation provides you with an easy to use mechanism to create
device panels and their wiring directly from the Instrument Index module.
Alternatively, you can create the connection information manually in the Device
Panels window in the Wiring module, including the terminals, the cable, and the
connections between them. The Device Panels window can help create the
connection information needed in most cases where a `single' cable is connected to
the terminals of the instrument.
Before creating a device panel with wiring information you need to define a number
of reference items. These reference items are the panel, cable, and connection type.
You can also define appropriate instrument type profiles that include wiring
definitions. When creating an instrument based on a defined instrument type profile,
the software automatically checks if the instrument that is being added needs to have
a device panel. Based on the given default settings, the software will create the panel,
the cable, and the connections between them. Also, SmartPlant Instrumentation
automatically propagates the signals and names the device panels and cables
according to the appropriate naming conventions defined in the Administration
module. If no naming convention for device cables has been defined, the software
names the cable after the instrument, when the name is prefixed with "C-".
Related Topics
218

Managing Device Panels Common Tasks

The following tasks are used frequently when you manage the device panels and
cables in your plant.
Create an Instrument with an Automatically Configured Device Panel

This option enables you to create a new instrument with an associated device panel
and device cable. In this case, SmartPlant Instrumentation automatically creates a
device panel and a device cable and automatically configures the required connection
for you. SmartPlant Instrumentation does not prompt you to select a reference panel,
reference cable, or a connection type. The software selects the default configuration
for the new device panel, device cable, and connection type that you have defined in
the Wiring and I/O Profile group box of the Instrument Type Profile dialog box in
the Instrument Index module. The new device panel will have the same name as the
new instrument. SmartPlant Instrumentation will create the new instrument
according to the wiring profile defined for it in the Instrument Index module. 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 with an
Automatically Configured Device Panel, page 473.
Create an Instrument with a Manually Configured Device Panel

You use this option to create a new instrument with an associated device panel and
device cable. In this case, SmartPlant Instrumentation creates a device panel and a
device cable and lets you manually configure the required connection. The software
prompts you to select a reference device panel and reference cable that will be used to
create the new device panel and cable. SmartPlant Instrumentation copies the
definitions for the new device panel and cable from the selected reference panel and
cable that you defined in the Reference Explorer. You can also select an existing
connection type and you can name the new device panel as you require. SmartPlant
Instrumentation creates the new instruments according to the wiring profile that you
defined in the Instrument Index module. 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 with a Manually Configured Device Panel,
page 475.

Create an Instrument Without a Device Panel

This option enables you to create a new instrument in the Device Panels window
without creating a device panel or a device cable. You can then select an existing
device panel and associate it with the new instrument. You can also create a new
device panel for the new instrument if needed. Note that SmartPlant Instrumentation
creates the new instrument according to the wiring profile defined for it in the
Instrument Index module. Make sure that you set all the required instrument type
profiles before you start creating new instruments.
For more information, see Create an Instrument Without a Device Panel, page 477.
Create Device Panels for Selected Instruments

This option enables you to create device panels associated with selected a
instruments. This process also includes the creation of the required device cables that
will be connected to the new device panels. You can let SmartPlant Instrumentation
configure the connection for you or you can choose the manual configuration option
that allows you to configure the connection:
• Automatic configuration — the software creates a device panel, a

device cable, and automatically configures the required connection for
you. SmartPlant Instrumentation does not prompt you to select a
reference panel, reference cable, or a connection type. Instead, the
software selects the reference configuration for the new device panel,
device cable, and connection type that you have defined in the Wiring
and I/O Profile group box of the Instrument Type Profile dialog box
in the Instrument Index module. The new device panel will have the
same name as the new instrument. Make sure that you set and activate
all the required instrument type profiles before you start creating new
instruments.
• Manual configuration — SmartPlant Instrumentation creates a
device panel and a device cable and lets you manually configure the
required connection. The software prompts you to select a reference
panel and reference cable that will be used to create the new device
panel and cable. SmartPlant Instrumentation copies the definitions for
the new device panel and cable from the selected reference panel and
cable that you defined in the Reference Explorer. You can also select
an existing connection type and name the new device panel as needed.
For more information, see Create Device Panels for Selected Instruments, page 480.

This procedure explains how to create a device panel that is not associated with any
instrument and not connected to any device cable. For more information, see Create
an Unassociated Conventional Device Panel, page 459.

Create a Plug-and-Socket Device Panel

This procedure explains how to create a new plug-and-socket device panel. For more
information, see Create a Plug-and-Socket Device Panel, page 675.
Associate Instruments with Device Panels

This option enables you to associate an instrument with a device panel. This feature
is useful when, for instance, you create a number of device panels in the Domain
Explorer by copying a reference item from Reference Explorer. The device panels
you create in the Domain Explorer are not associated with any instruments and they
are not connected to device cables. A device panel must be associated with an
instrument before you can create a device cable for it.
For more information, see Associate Instruments with Device Panels, page 482.
Dissociate Device Panels from Instruments

This feature enables you to dissociate an instrument from a device panel. When
carrying out this procedure, SmartPlant Instrumentation automatically disconnects
single cables belonging to the dissociated device panels. Furthermore, the software
renames the disconnected cables to `?-' plus <name>. For example, a cable named
`C-FT -2221' is renamed to `?-C-FT -2221'.
SmartPlant Instrumentation renames the cable to draw your attention to the fact that
the cable is not connected to any device. In addition, the software renames the wires
to SPARE throughout the signal run. For more information, see Dissociate Device
Panels from Instruments, page 482.

This pre-assignment serves several purposes:
• Pre-assign the required junction boxes to define an Auto-Wiring

routing task.
• Connect multiple pre-assigned device cables in batch mode.
• Filter the display of cables in the Domain Explorer so that only pre-
assigned device cables for connection with junction boxes are
displayed.
For details, see Pre-Assign Junction Boxes to Device Panels, page 580.

Create a Device Cable

You use this option to create a new device cable and connect it to a selected device
panel. This feature is useful when you created a device panel in the Domain
Explorer, associated it with an instrument in the Device Panels window, but have
not yet defined a device cable for it. You can configure the cable and its connection
type manually or you can let SmartPlant Instrumentation select the reference cable
and connection type automatically. For more information, see Create a Device
Cable, page 483.
Rename Device Cables in Batch Mode

This option enables you to select a panel with device cables (cables connecting a
device panel and any other panel) and rename all the device panel cables connected to
this panel in batch mode. For more information, see Rename Device Cables in Batch
Mode, page 484.
Related Topics
Create an Instrument with an Automatically Configured

Device Panel
1. Activate the instrument type profile default settings as follows:
a. Click File > Preferences.
b. In the tree view pane, to expand the tree, click beside Instrument Index.
c. Click Profile.
d. Under Activate instrument type profile options, select the Wiring check
box.
e. Click OK
2. In the Wiring Module window, do one of the following:
• Click .
• On the menu bar click Actions > Device Panels.
3. In the Device Panels window, clear the Manual configuration check box.
• Click .
• On the menu bar click Actions > New Tag.

5. In the New Tag Number dialog box, do the following:

want to create a conventional instrument, Foundation Fieldbus instrument,
HART instrument, Telecom instrument, and so forth.
b. Type the name of the new instrument. If needed, it is possible for instruments
and device panels to have the same names. make sure that you follow the
naming conventions for new tag numbers.
c. If you are working with the Free naming conventions, choose the Select
Instrument Type check box to open a pop-up window that allows you to
select an appropriate instrument type.
d. Click OK to create the instrument.
6. If more than one function identifier exists for the current instrument type
acronym, select the required instrument type in the Select Instrument Type
dialog box and click OK.
Tips
• If the instrument name does not correspond to an existing loop name,
SmartPlant Instrumentation prompts you to enter a loop name based on
the tag number you have entered. The software automatically
associates the new instrument with the loop if the loop identifier
already matches an existing loop
prompt always appears. In this case, you have to complete the loop
number. If a profile exists for the selected instrument type, the
software creates the new instruments for that instrument type
according to the selected reference items For details, see Define
Instrument Type Default Settings, page 350.
7. In the Loop Name dialog box, do one of the following:
• Type the loop number name that the new instrument will be associated
with.
• Accept the displayed value to create a new loop with this name.
• Click OK to create the new loop number.
• Click Cancel to create the new instrument without a loop association.
9. On the Tag Number Properties dialog box, edit the instrument properties as you
require and click OK.
Note
• The software adds the new instrument to the list of instruments in the
Device Panels window. Also, you can see the new instrument in the
Instruments folder of the Domain Explorer.

Create an Instrument with a Manually Configured Device

Panel
1. Activate the instrument type profile default settings as follows:
c. Click Profile.
d. Under Activate instrument type profile options, select the Wiring check
box.
e. Click OK
• Click .
3. In the Device Panels window, select the Manual configuration check box.
• Click .
Tips


with.
9. On the Create Device Panel and Cable dialog box, under Device panel, accept
or the displayed name of the device panel that will be created with the current
instrument.
Tip
• The Create Device Panel and Cable dialog box opens only if the
instrument that you creating is based on an instrument type profile that
has at least partial wiring definitions.
10. From the Reference device panel list, select a reference device panel that you
want to use as a basis for the new device panel.
Tips
• The displayed reference panel is the one that you defined in the
Instrument Index module, in the Instrument Type Profile dialog box,
under Wiring and I/O Profile.
• The properties of the reference panel that you select determine whether
one or both of the Conventional connections and Plug-and-socket
connections group boxes are enabled, and the values that are initially
displayed.
11. In the active group boxes, to define the device cables, do the following as
necessary:
• To modify the properties of a selected device cable connection, click
Properties, and in the dialog box that opens, change the values as
necessary.
• To add an additional device cable connection, click New, and in the
dialog box that opens, enter the appropriate values.
• To delete selected cable connections, click Delete.
12. Click OK to complete the process.

Note
• The new device panel appears next to the selected instrument in the
Device Panels window. SmartPlant Instrumentation displays a cable
icon next to the new device cable indicating that a device cable
is connected to it.
Related Topics
Create an Instrument Without a Device Panel

1. Deactivate the instrument type profile default settings as follows:
c. Click Profile.
d. Under Activate instrument type profile options, clear the Wiring check
box.
e. Click OK
• Click .
3. In the Device Panels window, do one of the following:
• Click .
4. In the New Tag Number dialog box, do the following:


Tips
with.
Note
• The software adds the new instrument to the list of instruments in the
Device Panels window. Also, you can see the new instrument in the
Instruments folder of the Domain Explorer.
Related Topics

Create Device Panels and Cables in the Instrument Index

Standard Browser View
1. In the Instrument Index Module window, do one of the following to open the
Instrument Index Standard Browser view:
• On the menu bar, click Actions > Standard Browser View.
• On the toolbar, click
• Right-click, and on the shortcut menu, click Apply Profile > Create
Device Panel and Cable.
• On the Actions menu, click Apply Profile > Create Device Panel
and Cable.
4. On the Results dialog box, view the propagation results, and then click Close.
Note
• To make this feature work, you must select the Create wiring check
box and choose a reference device panel on the Wiring and Control
System tab in the instrument type profile of the selected tag number
before you attempt to create a new device panel. You can also select a
reference device cable if you want SmartPlant Instrumentation to
create device cables with the device panels. For more details, see
Define an Instrument Type Profile, page 348.
Related Topics
• Define a Standard Browser View for the Instrument Index, page 403

Create Device Panels for Selected Instruments

• Click .
• Select the Manual configuration check box to define the device panel
and cable manually.
• Clear the Manual configuration check box to define the device panel
and cable automatically.
3. On the menu bar, click Actions > New Tag or click on the toolbar.
4. Select the instruments for which you want to create device panels and cables.
You can use the Ctrl and Shift keys to select multiple instruments.
5. On the menu bar click Actions > Create.
Tips
• If you cleared the Manual configuration check box, SmartPlant
Instrumentation creates and configures the device panel automatically.
The creation process ends at this point and the new device panels
appear next to the selected instruments in the Device Panels window.
The software displays a cable icon next to the new device panel
indicating that a device cable is connected to it.
• If you selected the Manual configuration check box, the creation
process continues.
6. On the Create Device Panel and Cable dialog box, under Device panel, accept
or the displayed name of the device panel that will be created with the current
instrument.
Tip
• The Create Device Panel and Cable dialog box opens only if the
instrument that you creating is based on an instrument type profile that
has at least partial wiring definitions.
7. From the Reference device panel list, select a reference device panel that you
want to use as a basis for the new device panel.
Tips
• The displayed reference panel is the one that you defined in the
Instrument Index module, in the Instrument Type Profile dialog box,
under Wiring and I/O Profile.

• The properties of the reference panel that you select determine whether
one or both of the Conventional connections and Plug-and-socket
connections group boxes are enabled, and the values that are initially
displayed.
8. In the active group boxes, to define the device cables, do the following as
necessary:
• To modify the properties of a selected device cable connection, click
Properties, and in the dialog box that opens, change the values as
necessary.
• To add an additional device cable connection, click New, and in the
dialog box that opens, enter the appropriate values.
• To delete selected cable connections, click Delete.
9. To apply the values that you set to the selected instruments with incomplete
wiring profiles, select Apply to all selected instruments with incomplete
profile.
Note
• You can also create device panels and cables for selected instruments
in the Instrument Index Standard Browser view. For details, see
Create Device Panels and Cables in the Instrument Index Standard
Browser View, page 479.
Related Topics

Associate Instruments with Device Panels

• Click .
2. In the Device Panels window, select the Manual configuration check box.
3. In the Device Panels window, select the instruments you require and then do one
of the following:
• Click .
• On the menu bar, click Actions > Associate.
4. On the Select Device Panels dialog box, select the appropriate device panels.
5. Click OK.
Note
• The new device panel appears next to the selected instrument in the
Device Panels window. You can now create a device cable for these
panels.
Related Topics
Dissociate Device Panels from Instruments

• Click .
2. In the Device Panels window, select the instruments you require and then do one
of the following:
• Click .
• On the menu bar, click Actions > Dissociate.
Related Topics

Create a Device Cable

• Click .
• Select the Manual configuration check box to define the device panel
and cable manually.
• Clear the Manual configuration check box to define the device panel
and cable automatically.
3. Select the required device panel - instrument associations for which you want to
create device cables.
4. On the menu bar, click Actions > Create.
Tips
• If you cleared the Manual configuration check box, SmartPlant
Instrumentation creates and configures the device panel automatically.
The creation process ends at this point and the new device panels
appear next to the selected instruments in the Device Panels window.
The software displays a cable icon next to the new device panel
indicating that a device cable is connected to it.
• If you selected the Manual configuration check box, the creation
process continues.
5. On the Create Device Panel and Cable dialog box, in the active group box
(Conventional connections or Plug-and-socket connections) do the following
for each device panel — associated with an instrument.
a. Click New.
b. On the dialog box that opens, enter the appropriate values.
c. Click OK.
6. On the Create Device Panel and Cable dialog box, click OK.
Note
• The new device cable appears in the Device Panels window next to
the selected instrument.
Related Topics

Rename Device Cables in Batch Mode

1. In the Domain Explorer, expand the Panels by Location or Panels by Category
folder.
2. Right-click a junction box in the tree view or select several junction boxes in the
Items pane and then right-click them.
3. On the shortcut menu, click Actions > Rename Device Cables.
4. On the Rename tab of the Rename Device Cables dialog box, select the check
boxes next to the cables that you want to rename or choose the Select All check
box to select all the cables displayed in the data window.
5. Click the Convention tab to define the cable name template, that is, the rules how
the cable names will change.
Tip
• If a name template has been defined, it is displayed in the Current
Convention field.
6. Insert and define as many conventions as required.
7. Select the Use as default check box to use the convention row definitions as your
default naming conventions.
8. Click Apply when done.
Note
• You can modify the device panel name according to your needs.
Device cable names are, however, not editable in this dialog box. You
can rename device cables in the Domain Explorer.
Related Topics

Wiring Equipment: An Overview

SmartPlant Instrumentation enables you to create and manage various types of wiring
equipment. Wiring equipment is a generic name for different termination objects that
can handle multiple input and output signals (channels). These items need an external
power supply and they usually have several terminals to feed the electronic
components. Examples of wiring equipment are barriers, isolators, trip amplifiers,
relays, and so forth. I/O cards, I/O termination items, and various terminal strips also
belong to the group called wiring equipment.
Prior to Version 7, SmartPlant Instrumentation provided for this type of objects only
by letting you create an apparatus. However, apparatus did not deal with certain
aspects of wiring equipment such as electric properties. Apparatus provided a "flat"
structure that could only group terminals on an apparatus strip under a position name.
Wiring equipment, however, introduces a structured object which you can remove,
add, and copy. You can accurately define wiring equipment properties such as
category, manufacturer, model, and so forth.
Wiring equipment is a much wider feature which allows you to create various types
of termination objects and define their electric properties. You can use wiring
equipment whenever you need to define any type of card, or piece of hardware that
you need to buy separately, count the number of units you need (BOM), install it
inside a panel, and make connections
SmartPlant Instrumentation enables you to create and manage wiring equipment items
that:
• contain various terminal strips or combination of terminal strips.

• serve multiple tags or channels.
• contain terminal strips and connectors.
• require custom properties for each wiring equipment category.
• require a specific presentation using special custom symbols.
Wiring equipment items are classified according to various categories. SmartPlant
Instrumentation is shipped with a number of these categories. You can customize
your own wiring equipment categories and create various wiring equipment items
belonging to these customized categories. For more information, see the following:
• Customize and Use Wiring Equipment Categories, page 489

• Add User-Defined Wiring Equipment Category Properties, page 491
When designing a Foundation Fieldbus or Profibus system, you can create a wiring
equipment item belonging to the fieldbus brick category. Then, under a fieldbus
brick you can add a fieldbus apparatus. This compound object provides for the
creation and management of fieldbus termination objects required for your

Foundation Fieldbus or Profibus system. For details, see Fieldbus Bricks: An

Overview, page 683.
Also, note the following features of wiring equipment:
• Wiring equipment can encapsulate multiple objects, terminal strips,

and channels.
• Since every wiring equipment is a separate item , the Connection
window cannot display multiple objects as it does for an apparatus
strip. Nor is it possible to connect a cable to multiple wiring
equipment items in one step.
• Using wiring equipment in combination with custom symbols provides
for a better representation of loop drawings.
• Wiring equipment information does not appear in loop drawing
generation. In most cases, it is possible to add macros and retrieve
information or use custom symbols.
• Wiring reports do not show wiring equipment. All reports continue to
show panels, terminal strips, and terminals.
Related Topics
• Wiring Equipment Common Tasks, page 487

Wiring Equipment Common Tasks

The following tasks are used frequently when you create and manage the wiring
equipment in your plant.
Customize and Use Wiring Equipment Categories

SmartPlant Instrumentation provides you with a number of predefined wiring
equipment categories. However, you can also customize your own wiring equipment
categories for wiring items that do not belong to any existing categories.
This procedure explains how to customize a wiring equipment category and add a
customized property to a category. Note that some of the shipped wiring equipment
categories have predefined properties. You can add your own customized properties
to the shipped categories as well as to the customized ones.
After customizing a new wiring equipment category, it becomes available in the

Categories list of the New Wiring Equipment dialog box and you can create new
wiring equipment items belonging to this category. For more information, see
Customize and Use Wiring Equipment Categories, page 489.
Add User-Defined Wiring Equipment Category Properties

This feature allows you to add user-defined properties to existing wiring equipment
categories. This option applies to the user-defined categories as well as to those that
have been supplied with SmartPlant Instrumentation. For more information, see Add
User-Defined Wiring Equipment Category Properties, page 491.
Create a Wiring Equipment Item

This procedure explains how to create a wiring equipment item that belongs to any
wiring equipment category except for I/O cards and I/O terminations.
You can create new wiring equipment items either in the Domain Explorer or the
Reference Explorer. If you are creating a wiring equipment item that is going to
have a frequently used configuration, we recommend that you create it in the
Reference Explorer. Reference wiring equipment items facilitate fast creation of
plant items by copying an existing wiring equipment item from the Reference
Explorer to the Domain Explorer. However, if you want to create a wiring
equipment item that does not have a configuration that you intend to use frequently,
we recommend that you create it in the Domain Explorer and in the <unit> where it
is to be physically located. This is helpful when filtering the wiring equipment items
in the current <unit>.
For more information, see Create a Wiring Equipment Item, page 492 .

Create an I/O Card

As a rule, I/O cards reside in slots. Therefore, you have to navigate to a particular
rack and select a slot where you want to create a new I/O card. Note that I/O cards
may or may not have built-in termination blocks. If an I/O card does not have a built-
in termination block, you need to associate it with an I/O termination. To define an
I/O card that has a built-in termination block, create an I/O card and then add a
terminal strip with channels under this I/O card. For an I/O card with a built-in
terminal block, you need to create a terminal strip with channels under an I/O card to
be able to effect I/O assignment and make connections.
You can create new I/O cards either in the Domain Explorer or the Reference
Explorer. If you are creating an I/O cards that is going to have a frequently used
Reference I/O cards facilitate fast creation of plant I/O cards by copying an existing
item from the Reference Explorer to the Domain Explorer. However, if you want
to create an I/O card that does not have a configuration that you intend to use
frequently, we recommend that you create it in the Domain Explorer and in the
<unit> where it is to be physically located. This is helpful when filtering the I/O
cards in the current <unit>.
For more information, see Create an I/O Card, page 497.
Customize the Controller/Processor List Header in I/O Card Properties

This option enables you to make the Controller/Processor list header on the Control
System tab of the I/O Card Properties dialog box dependant on the panel
manufacture to which the current I/O card belongs. For more information, see
Customize the Controller/Processor List Header in I/O Card Properties, page 501.
Create an I/O Termination

I/O terminations are wiring equipment items that are used to connect I/O cards and
other wiring items that do not have built-in termination blocks. You associate an I/O
termination with an I/O card that does not have a built-in termination block and then
make the required connections to the I/O termination. You can also associate an I/O
termination with several I/O cards if there are redundant I/O cards.
Also, you can create an I/O termination when you need to define a distant I/O card
that resides in a different panel or rack. You need to create a terminal strip with
channels under an I/O termination to be able to effect I/O assignment and make
connections.

You can create new I/O termination cards either in the Domain Explorer or the
Reference Explorer. If you are creating an item that is going to have a frequently
used configuration, we recommend that you create it in the Reference Explorer.
Reference items facilitate fast creation of plant items by copying an existing item
from the Reference Explorer to the Domain Explorer. However, if you want to
create an I/O termination that does not have a configuration that you intend to use
frequently, we recommend that you create it in the Domain Explorer and in the
<unit> where it is to be physically located. This is helpful when filtering the wiring
equipment items in the current <unit>.
For more information, see Create an I/O Termination, page 499.
Associate an I/O card with an I/O Termination

I/O terminations function as termination blocks for I/O cards that do not have built-in
termination blocks. Therefore, you need to associate an I/O termination with an I/O
card that needs a built-in termination block. You can associate only those I/O cards
that have been created in a particular rack and slot.
For more information, see Associate an I/O card with an I/O Termination, page 502.
Related Topics
Customize and Use Wiring Equipment Categories

1. On the Wiring module menu bar, click Tables > Wiring Equipment >
Categories.
2. In the Wiring Equipment Category dialog box, click New.
3. In the New Wiring Equipment Category dialog box, type a category name and
description.
4. To select a user-defined icon for the current wiring equipment category, under
Icon file name, click Browse to navigate to the icon file that you require.
Tip
• The icon that you select will appear in the Domain Explorer or the
Reference Explorer next to each wiring equipment item belonging to
the current category.
5. In the Properties group box, click Add.
6. Under Header, type the text that will appear as the property name on the
Category Properties tab of the appropriate wiring equipment properties dialog
box.

7. From the Type list, select the type of value for the new customized category
property. You will then be able to enter a value for this new property on the
box. The values can be numeric, text, or date/time.
• Click Add to define another new property.
• Click OK to accept your definitions and close this dialog box.
9. Create a new wiring equipment item .
Tip
• In the Domain Explorer, right-click a panel or a panel child item, and
then on the shortcut menu, click New > Wiring Equipment.
10. In the New Wiring Equipment dialog box, from the Category list, select the
newly created category, type the wiring equipment item name, and click OK.
11. On the General tab of the Properties dialog box, define wring equipment
properties as you require and click the Category Properties tab.
12. On the Category Properties tab, enter the values for each property as you
require,
13. Continue defining the properties of the new wiring equipment item as you need.
Note
• The software does not allow you to delete or rename the shipped
wiring equipment categories. Nor can you delete or rename any of the
predefined properties belonging to the shipped wiring equipment
categories.
Related Topics

Add User-Defined Wiring Equipment Category Properties

1. On the Wiring module menu bar, click Tables > Wiring Equipment >
Categories.
2. In the Wiring Equipment Category dialog box, select a category and click
Properties.
3. To select a user-defined icon for the current wiring equipment category, under
Icon file name, click Browse to navigate to the icon file that you require.
Tip
• The icon that you select will appear in the Domain Explorer or the
Reference Explorer next to each wiring equipment item belonging to
the current category.
4. In the Wiring Equipment Category Properties dialog box click Add.
5. Under Header, type the text that will appear as the property name on the
box.
6. From the Type list, select the type of value for the new customized category
property. You will then be able to enter a value for this new property on the
box. The values can be numeric, text, or date/time.
• Click Add to define another new property.
• Click OK to accept your definitions and close this dialog box.
Notes
• You cannot delete or rename any of the predefined properties
belonging to the shipped wiring equipment categories.
• After adding a category property, it becomes available on the
Category Properties tab of the appropriate wiring equipment
properties dialog box.
Related Topics

Create a Wiring Equipment Item

folder.
• Expand the Panels by Category folder and navigate to a wiring item
under which you want to create a new wiring equipment item .
• Expand the Panels by Location folder and navigate to a wiring item
under which you want to create a new wiring equipment item .
Tip
• There is a lot of flexibility in creating a wiring hierarchy in SmartPlant
Instrumentation. There is no rigid structure like "panel – terminal
strip – terminal" that limits your wiring design. Therefore, you can
create wiring equipment items under various types of items. To see
examples of possible wiring hierarchy structures, see Hierarchy
Examples of Wiring Items, page 494.
3. Right-click a wiring item under which you want to create new wiring equipment
and then on the shortcut menu, click New > Wiring Equipment.
4. In the New Wiring Equipment dialog box, from the Category list, select a
category to which the new item belongs.
Tip
• If you need to create an I/O card or an I/O termination, see Wiring
Equipment Common Tasks, page 487.
5. Under Name, type the name of the item and click OK.
6. In 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
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.

7. Select the Double width check box if the item occupies a double width slot.
8. 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.
9. Click the Category Properties tab.
Tip
• If you are creating a miscellaneous wiring equipment item , the
Category Properties tab is not available.
10. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
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
11. Click the Associate Symbols tab to associate a symbol with the current item .
Related Topics

Hierarchy Examples of Wiring Items

There is a lot of flexibility in creating a wiring hierarchy in SmartPlant
Instrumentation. There is no rigid structure like "panel – terminal strip – terminal"
that limits your wiring design. Therefore, you can create wiring equipment items
under various types of items.
Example 1:
Example 2:
Example 3:

Example 4:
Example 5:
Example 6:
This example shows the wiring items that can exist in the Panels by Location folder.

Example 7:
This example shows the items that can exist in the Cables folder.
For a better understanding of the Domain Explorer, see Working with the Domain
Explorer: An Overview, page 212.
Related Topics

Create an I/O Card

folder.
under which you want to create a new I/O card.
under which you want to create a new I/O card.
3. Double-click a panel and then a rack till you see the existing slots.
Tip
• As a rule, I/O cards reside in rack slots. Therefore, you have to
navigate to a slot where you want to create an I/O card. However,
SmartPlant Instrumentation allows to create flexible wiring hierarchies
and therefore you can add I/O cards to a number of various item types.
To see examples of possible wiring hierarchy structures, see Hierarchy
Examples of Wiring Items, page 494.
4. Right-click a slot or any other wiring item under which you want the new card
reside and then on the shortcut menu, click New > Wiring Equipment.
5. In the New Wiring Equipment dialog box, from the Category list, select I/O
Card.
6. Under Name, type the name of the new I/O card and click OK.
7. In 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:
the software to name the new card automatically according to the
naming conventions that are set for this type of equipment in the
Naming Conventions.
the name of the new card. Note that if you do not clear the Apply
you type under Name.
8. Select the Double width check box if the card occupies a double width slot.


b. Select an I/O card type, model, and manufacturer. If the required value is not
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.
10. Click the Control System tab.
11. 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.)
12. Under Module, type the software address that this card is assigned to.
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 501.
13. 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.
14. To view the list of all I/O terminations associated with the current I/O card, click
the I/O Terminations button.
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 489.
17. Click the Associate Symbols tab to associate a symbol with the current I/O cards.

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.
Related Topics
Create an I/O Termination

folder.
under which you want to create a new I/O termination.
under which you want to create a new I/O termination.
3. Double-click a panel and then a rack till you see the existing slots.
Tip
• As a rule, I/O terminations reside in DCS panels or marshaling racks.
However, SmartPlant Instrumentation allows to create flexible wiring
hierarchies and therefore you can add I/O terminations to a number of
various item types. To see examples of possible wiring hierarchy
structures, see Hierarchy Examples of Wiring Items, page 494.
4. Right-click a slot or any other wiring item under which you want the new card
reside and then on the shortcut menu, click New > Wiring Equipment.

5. In the New Wiring Equipment dialog box, from the Category list, select I/O
Termination.
6. Under Name, type the name of the new I/O termination and click OK.
7. In 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:
Naming Conventions.
8. Select the Double width check box if the card occupies a double width slot.
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.
11. 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
12. 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.
13. 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 502.

14. 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.
Tip
• I/O termination is a wiring equipment category that is shipped with
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
489.
17. 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
431.
Related Topics
Customize the Controller/Processor List Header in I/O Card

Properties
1. In the Domain Explorer, navigate to a panel.
2. Right-click the selected panel and then on the shortcut menu, click Properties.
3. On the General tab of the Properties dialog box, click beside the
Manufacturer list.
4. In the Panel Manufacturers supporting table, select a manufacturer and then
scroll to the right to the Controller/Processor header.
5. Click in the Controller/Processor field and type the text that you want to appear
instead of the Controller/Processor list header on the Control System tab of the
I/O Card Properties dialog box.
6. Click OK to close the Panel Manufacturers supporting table.
7. Click OK in the Panel Properties dialog box.

Associate an I/O card with an I/O Termination

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.
folder.
• Expand the Panels by Category folder, hierarchy and navigate to a
wiring item under which you want to create a new I/O card.
• Expand the Panels by Location hierarchy and navigate to a wiring
item under which you want to create a new I/O card.
3. Create or select an I/O card under a particular panel, rack, and slot.
4. Create or select an I/O termination that you want to associate with an I/O card.
5. In the Wiring Equipment Properties - I/O Termination dialog box, click the
Control System tab.
Tip
• To open the Wiring Equipment Properties - I/O Termination dialog
box, in the Domain Explorer, right-click an I/O termination and then
on the shortcut menu, click Properties.
6. To associate a primary I/O card, in the Primary I/O card group box, click
next to the I/O card select list arrow.

7. In the Domain Explorer, select an appropriate I/O card and click OK.
Tips
• You cannot select an I/O card whose child item is a terminal strip with
channels.
• Note that the I/O type of both the I/O card and the I/O termination
must be the same. If the I/O type of the I/O termination differs from
the I/O type of the I/O card, the software displays a warning.
8. To associate a secondary I/O card, do the following:
a. Click the Define a redundant I/O card check box.
b. In the Secondary I/O card group box, click next to the I/O card select list
arrow.
c. Click OK.
Note
• To be able to effect I/O assignment and make connections, create a
terminal strip with channels under the I/O termination you are editing.
Related Topics

Apparatus: An Overview
Apparatus is a wiring item that pertains to different types of multi-purpose I/O
devices. These devices accept wires and signals, for example, barriers, opto-couplers,
relays, repeaters, isolators, and so forth. You also use this feature to create a fieldbus
termination block whose configuration is different from an apparatus configuration.
SmartPlant Instrumentation allows you to create a group of apparatuses or a single

apparatus. An apparatus group constitutes an apparatus strip (that is, a terminal strip)
with a number of apparatuses created according to a selected apparatus configuration.
Adding a new apparatus group to a panel or a wiring equipment item starts with
configuring the new apparatuses: setting the number of apparatuses on an apparatus
strip, defining the apparatus terminal numbering pattern, signal propagation, and the
color of the terminals. After defining an apparatus configuration, you can proceed
with the creation of an apparatus group. The software opens the Terminal Strip
Properties dialog box so that you can define an apparatus strip for the new apparatus
group. After defining the apparatus strip properties in the Terminal Strip Properties
dialog box, the software creates the apparatus strip and the apparatuses according the
selected configuration.
SmartPlant Instrumentation also allows you to add a single apparatus to an apparatus

group. In this case, you do not define an apparatus configuration. Then, you can
select the new apparatus and add the required terminals.
Once you have created a new apparatus group or a single apparatus, SmartPlant
Instrumentation displays it in the Domain Explorer showing the terminals belonging
to the apparatus.
Note that an apparatus is a wiring item . Therefore, you can define apparatus
properties, duplicate, or delete an apparatus, and assign it a special symbol. The
software uses this symbol in the Enhanced Report Utility.
Related Topics
• Apparatus Common Tasks, page 505

Apparatus Common Tasks

The following tasks are used frequently when you create and manage the apparatus
items in your plant.
Define an Apparatus Configuration

You need to create an apparatus configuration before you can add an apparatus group
to a selected panel or wiring equipment item. An apparatus group constitutes an
apparatus strip (that is, a terminal strip) with a number of apparatuses created
according to a selected apparatus configuration.
When defining an apparatus configuration, you define the apparatus profile (name,
description, manufacturer, and model), the number of apparatuses, the apparatus
terminal configuration, and the position numbering.
For more information, see Define an Apparatus Configuration, page 506.
Create an Apparatus Group

SmartPlant Instrumentation allows you to add an apparatus group to a panel or a
wiring equipment item . An apparatus group constitutes an apparatus strip (that is, a
terminal strip) with a number of apparatuses created according to a selected apparatus
configuration. You can add an apparatus group to a panel or a wiring equipment item
.
The software adds an apparatus group after selecting an appropriate apparatus

configuration. You can add a new apparatus group after creating an apparatus
configuration. When adding a new apparatus to a panel, the software also creates a
new apparatus (terminal) strip on which the apparatus is created.
You can add an apparatus to a panel or to a wiring equipment item . It is also

possible to add a single apparatus to another apparatus.
For more information, see Create an Apparatus Group, page 508.
Add an Apparatus to an Apparatus Group

SmartPlant Instrumentation allows you to add a single apparatus to an apparatus
group. The software creates a new apparatus without any terminals and adds it at the
bottom of the apparatuses in the current apparatus group. If needed, you can then
change apparatus sequence within the group and add the required terminals. For
more information, see Add an Apparatus to an Apparatus Group, page 509.
Edit Apparatus Terminal Properties

The following procedure explains how to edit the properties of an apparatus terminal.
For more information, see Edit Apparatus Terminal Properties, page 510.

Configure a Fieldbus Apparatus

To create a fieldbus brick assembly, you must have a predefined apparatus group
configuration An apparatus group constitutes an apparatus strip (that is, a terminal
strip) with a number of apparatuses created according to a selected apparatus
configuration. When defining an apparatus configuration, you define the apparatus
profile (name, description, manufacturer, and model), the number of apparatuses, the
apparatus terminal configuration, and the position numbering. For more information,
see Configure a Fieldbus Apparatus, page 687.
Related Topics
• Apparatus: An Overview, page 504
Define an Apparatus Configuration

Important
• To facilitate fast creation of apparatus groups with various
configurations, we recommend that you create several apparatus
configurations in the Reference Explorer so that you can create
different reference apparatus groups that can be copied to the Domain
Explorer.
• In the Domain Explorer, double-click the Panels by Location folder,
and select a panel.
• In the Domain Explorer, double-click the Panels by Category folder,
and select a panel.
• In the Reference Explorer, double-click the Panels folder, and select
a panel.
3. Right-click a panel to which you want to add an apparatus and then on the
shortcut menu, click New > Apparatus Group.
4. In the Apparatus dialog box, click New.
5. In the Apparatus profile group box, in the Configuration name field, type the
name of the new apparatus configuration.
6. Select the Fieldbus apparatus check box if you need to create a configuration for
a fieldbus brick. Note that the apparatus configuration for a fieldbus brick differs
from the conventional one. For details, see Configure a Fieldbus Apparatus, page
687.

7. From the Manufacturer list, select the appropriate apparatus manufacturer. If the
required value is not available, click next to the list arrow to add or edit values
for this list.
8. In the Apparatus numbering group box, type the position name in the Prefix
field if required.
Tip
• Position names can be 15-character long. This name will appear in the
Domain Explorer within the new strip (only the first four characters),
in the Connection window, and in the appropriate reports.
9. Select the Numbered check box to number the positions.
10. Select the Internal terminator check box if you need to add an internal
terminator on the new termination block.
11. In the Description field, type a short description for the new configuration.
12. From the Manufacturer list, select the appropriate termination block
manufacturer. If the required value is not available, click next to the list arrow
to add or edit values for this list.
13. From the Model list, select the appropriate termination block model. If the
for this list.
14. Use the Number of apparatuses spinner or type the required number of
apparatuses to be added. This way you can have a block of more than one
apparatuses. This number will be displayed by default when adding a new
apparatus to an apparatus strip.
15. In the Apparatus numbering group box, type the apparatus name in the Prefix
field if required.
Tip
• Apparatus names can be 15-character long. This name will appear in
the Domain Explorer within the new apparatus strip (only the first
four characters), in the Connection window, and in the appropriate
reports.
16. Select the Numbered check box to number the apparatuses.
17. In the Apparatus configuration group box, from the Orientation list, select one
of the following terminal patterns:
• Left / Right— an apparatus that has two sides: input and output (that
is, left and right).
• Left— an apparatus that has wires on the left side only.
• Right— an apparatus that has wires on the right side only.
• Regular— an apparatus that has a conventional terminal that
functions as a single unit.

18. Do the following to define the apparatus terminal name and color:
a. Click in the left and/or right terminal side text box and type the required
terminal name, for example 1A:
b. Select a color of the terminal side from the list, for example red:
19. Repeat steps 17 and 18 for the other terminal side if appropriate. Note that the
line between the two terminal list arrows represents the internal relation between
the input and output terminals.
20. Click Add Terminal to add another terminal to this apparatus configuration if
needed and then repeat steps 14 through 16.
21. Click Delete Terminal if you need to delete a selected terminal from the current
configuration.
22. Click Save and then Close. You can now add the required apparatus as needed.
Related Topics
Create an Apparatus Group

and select a panel.
and select a panel.
a panel.
3. Right-click a panel to which you want to add an apparatus and then on the
4. In the Apparatus dialog box, select the required configuration from the
Configuration name list.

Tip
• If you do not have an appropriate configuration, create one. For
details, see Define an Apparatus Configuration, page 506.
apparatuses to be added. This way you can have a block of more than one
apparatus to an apparatus strip.
7. Click Create.
Tip
• SmartPlant Instrumentation automatically assigns sequential position
numbers to each apparatus. You can edit them later if required. For
details, see Edit Apparatus Terminal Properties, page 510.
8. In the Terminal Strip Properties dialog box, define the new apparatus strip as
required and click OK. For details, see Create a Terminal Strip, page 518.
9. Click Close in the Apparatus dialog box.
Tip
• The new apparatus appears in the Domain Explorer within the new
terminal strip.
10. Connect the apparatus to the appropriate cables. Select the apparatus group you
want to connect and click . The Connection window opens displaying the
apparatus terminals in yellow:
Related Topics
Add an Apparatus to an Apparatus Group

1. In the Domain Explorer or Reference Explorer, right-click an apparatus group.
2. On the shortcut menu, click New > Apparatus.
3. In the Apparatus Properties dialog box, enter the apparatus properties as you
Related Topics

Edit Apparatus Terminal Properties

1. In the Domain Explorer, select the terminal that you want to edit.
2. Right-click the selected terminal and click Properties on the shortcut menu.
3. In the Terminal Properties dialog box, on the General tab, from the Terminal
configuration list, select the required orientation of the current apparatus
terminal.
4. Define the terminal name by typing values in the Left terminal and Right
terminal boxes as you require. The combination of the left and right terminal
name will then appear in the Domain Explorer.
5. In the Sequence field, type a unique terminal sequence number.
Tip
• This number designates the physical position of the terminal on the
strip. The software assigns this number automatically when you add a
new terminal to the selected terminal strip. If you change the sequence
number of a terminal, be sure to change the sequence numbers of the
other terminals on the apparatus strip to avoid duplicate values, which
may interfere with the termination process.
6. Define the color as required.
7. Under Details, from the Manufacturer list, select the required terminal
to open the Terminal Manufacturer dialog box where you can add additional
items to the Manufacturer list.
8. From the Model list, select the required terminal model. If the required value is
not available, click next to the list arrow to open the Terminal Model dialog
box where you can add additional items to the Model list.
9. From the Type list, select the appropriate terminal type to which the new terminal
belongs. If the required type is not on the list, click next to the list arrow to
open the Terminal Type dialog box where you can add additional items to the
Type list. The Terminal Type dialog box, also allows you to replace the default
image of terminal side icons for single and multiple connections.
10. In the Note text box, type, if required, a brief note or a remark about this terminal.
11. Click OK to create the new terminal.
Related Topics

Terminal Strips: An Overview

In SmartPlant Instrumentation, you create terminal strips based on a particular
configuration of terminals. This configuration is a repeating numbering pattern that
enables logical numbering of terminals on a strip. A strip terminal configuration
includes the total number of terminals and the terminal numbering system.
You can create terminal strips either in the Domain Explorer or the Reference
Explorer. If you are creating a terminal strip that is going to have a frequently used
Reference terminal strips facilitate fast creation of terminal strips in your plant by
copying a terminal strip from the Reference Explorer to the Domain Explorer.
However, if you want to create a terminal strip that does not have a configuration that
you intend to use frequently, we recommend that you create it in the Domain
Explorer and in the <unit> where it is to be physically located. This is helpful when
filtering the terminal strips in the current <unit>.
In the SmartPlant Instrumentation Explorer, terminal strips are child items of

panels, racks, slots, and various wiring equipment items. Terminal strips are parent
items of channels and terminals.
Related Topics
• Managing Terminal Strips Common Tasks, page 512
218

Managing Terminal Strips Common Tasks

The following tasks are used frequently when you manage the terminal strips and
terminals in your plant.
Define a Terminal Strip Configuration

When creating a terminal strip, you are required to use a basic repeating numbering
pattern (configuration) to enable logical numbering of terminals. A numbering
pattern identifies the basic numbering system, or stepping method used for terminals
in a terminal strip. Set +1,-1,+2,-2, for example, has a pattern of two, while the Set
1,2,3SH,4,5,6SH has a pattern of three.
You can label the terminals on a terminal strip according to any numbering system
that you require (up to ten characters in length). To facilitate logical terminal
numbering, SmartPlant Instrumentation requires you to configure the basic repeating
numbering pattern (configuration) for the terminals in the new terminal strip before
defining that terminal strip.
When creating a strip in an I/O card or I/O termination, you use configurations that
include channels. If you want to create a terminal strip without channels in one of
these panels, set the number of terminals per channel to zero.
For more information, see Define a Terminal Strip Configuration, page 513.
Modify a Terminal Strip Configuration

This procedure explains how to modify an existing configuration of terminals.
Modifying a terminal configuration does not affect the existing terminal strips. They
retain their previous terminal configuration.
For more information, see Modify a Terminal Strip Configuration, page 515.
Create a Terminal Strip

This procedure explains how to create a terminal strip. You can add a terminal strip
to a panel, rack, slot, or a wiring equipment item. For more information, see Create a
Terminal Strip, page 518.
Move a Terminal Strip to Another Parent Item

This option enables you to move a terminal strip with connected cables to another
parent item (panel, rack, slot, or wiring equipment). The software retains all the
connection definitions after moving a terminal strip. For more information, see
Move a Terminal Strip to Another Parent Item, page 519.
Add a Terminal to a Terminal Strip

This procedure explains how to add a single terminal to an existing terminal strip.
For more information, see Add a Terminal to a Terminal Strip, page 520.

Add a Group of Terminals to a Terminal Strip

This procedure explains how to add a new group of terminals to an existing terminal
strip. For more information, see Add a Group of Terminals to a Terminal Strip, page
521.
Select a Graphic for a Terminal Connection

This procedure explains how to replace the default screw head graphic that represents
a terminal connection of a terminal in the Connection window and various Panel-
Strip reports. You select a graphic for a particular terminal type and the number of
wires connected to the terminal connection. That is, a specific graphic represents a
connector type and whether there is no wire, a single wire, or multiple wires,
connected on that particular side of the terminal. For more information, see Select a
Graphic for a Terminal Connection, page 523.
Related Topics
• Terminal Strips: An Overview, page 511
Define a Terminal Strip Configuration

1. In the Domain Explorer or Reference Explorer, right-click a panel.
2. On the short-cut menu, click New > Terminal Strip.
3. On the Terminal Strip Configuration dialog box, click New.
4. On the Number of Terminals in Pattern dialog box, type or select a number to
define the number of terminals to be repeated in the pattern and click OK.
Tip
• This number determines the number of rows (terminals) that will
constitute the basic repeating numbering (naming) pattern.
• This numbering pattern is shown in the Terminal Numbering
Pattern data grid on the Terminal Strip Configuration dialog box.
5. Under Configuration name, type the name of the new configuration.
6. Under Configuration description, type an optional description of the new
configuration.
7. Type or select the total number of terminals required in the terminal strip.
8. Select the starting number for the first terminal in the terminal strip.
9. Select the required number of terminals per channel or segment.

10. Select the first channel.

Tip
• If the new configuration is to be used to create I/O cards, the value in
the Number of terminals per channel and First channel fields must
be larger than zero. Otherwise, the terminals on the terminal strip are
created without channels and you will not be able to create an I/O card.
11. In the Terminal Numbering Pattern data grid, click and type in the Prefix field,
click and type a value if you want to prefix the names of the terminals.
12. Select the Incremented check box if you want the terminal number to be
incremented within the pattern.
13. Select the Numbered check box if you want the number of the terminal to appear
between the prefix and the suffix.
14. In the Suffix field, click and type a value if you want a suffix for the names of the
terminals.
15. From the Orientation list, select the connection orientation to the terminal:
• Regular— a conventional terminal that functions as a single unit.
• Left— a terminal that has wires on the left side only.
• Right— a terminal that has wires on the right side only.
• Left / Right— a terminal that has wires on the left side only.
16. Click Save.
Notes
• If the required number of terminals is not exactly divisible by the
number of terminals in a pattern, the remaining terminals are labeled
SPARE.
• For examples of possible terminal strip configurations, see Terminal
Strip Configuration Examples, page 516.
Related Topics

Modify a Terminal Strip Configuration

1. In the Domain Explorer or Reference Explorer, right-click a panel.
3. On the Terminal Strip Configuration dialog box, select a configuration from the
4. Click Edit.
Tip
• The software does not allow you to change the terminal numbering
pattern of an existing configuration. Therefore, you have to define a
new configuration if you need to make such a change.
5. Under Configuration name, type the name of the new configuration.
6. Under Configuration description, type an optional description of the new
configuration.
7. Type or select the total number of terminals required in the terminal strip.
8. Select the starting number for the first terminal in the terminal strip.
9. Select the required number of terminals per channel or segment.
10. Select the first channel.
Tip
• If the new configuration is to be used to create I/O cards, the value in
the Number of terminals per channel and First channel fields must
be larger than zero. Otherwise, the terminals on the terminal strip are
created without channels and you will not be able to create an I/O card.
11. In the Terminal Numbering Pattern data grid, click and type in the Prefix field,
click and type a value if you want to prefix the names of the terminals.
12. Select the Incremented check box if you want the terminal number to be
13. Select the Numbered check box if you want the number of the terminal to appear
between the prefix and the suffix.
14. In the Suffix field, click and type a value if you want a suffix for the names of the
terminals.
15. From the Orientation list, select the connection orientation to the terminal:
• Regular— a conventional terminal that functions as a single unit.
• Left— a terminal that has wires on the left side only.
• Right— a terminal that has wires on the right side only.
• Left / Right— a terminal that has wires on the left side only.

16. Click Save.

Notes
• If the required number of terminals is not exactly divisible by the
number of terminals in a pattern, the remaining terminals are labeled
SPARE.
• For examples of possible terminal strip configurations, see Terminal
Strip Configuration Examples, page 516.
Related Topics
Terminal Strip Configuration Examples

Each of the following examples demonstrates how various features of the strip
configuration operate. In each case, the terminal strip has a repeating sequence of
three terminals, and a total of 8 terminals (the last 2 terminals are designated SPARE,
and are not shown).
Input Data and Explanation Resultant Terminal Configuration

—
No numbering
The + and - terminals are

numbered.
The numbers are incremented for
the
first terminal of each repeating
sequence.


numbered.
The numbers are incremented for
all
the numbered terminals.
—

numbered.
All the numbers are numbered and
incremented.
Note the use of the suffix.
Related Topics

Create a Terminal Strip

1. In the Domain Explorer or Reference Explorer, right-click one of the following
items:
• A panel
• A rack
• A slot
• A wiring equipment item, for example an I/O card
3. On the Terminal Strip Configuration dialog box, select a configuration from the
Tip
• If you do not have an appropriate terminal configuration, click New.
4. Click Create.
5. On the Terminal Strip Properties dialog box, on the General tab, under
Terminal strip type the name of the new terminal strip.
6. From the Type, Model, and Manufacturer lists, select appropriate values to
define the new terminal strip as you require. If any of the lists do not contain the
value that you need, click to open the relevant supporting table where you can
manage the contents of the select lists.
7. Type a value for mounting, dimensions, and rail if needed.
8. Under Sequence, enter a number to define the sequence of the current terminal
strip in its parent item (a panel, rack, slot, or wiring equipment).
9. To manage the revisions of the terminal strip, click Revisions.
10. Click the Associate Symbols tab to associate a symbol with the current terminal
strip. The software will use this symbol when generating a report in the Enhanced
11. Click OK to create the new terminal strip.
Related Topics

Move a Terminal Strip to Another Parent Item

1. In the Domain Explorer or Reference Explorer, select a terminal strip that you
want to move.
2. Expand the hierarchy of the target parent item.
Tip
• You can open another instance of the Domain Explorer or Reference
Explorer and place it beside the one that is already open to make the
drag-and-drop operation easier.
3. Drag the selected terminal strip to the desired parent item.
Important
• The following restrictions apply when trying to move a terminal strip
with connected cables:
• The terminal strip is associated with an instrument type.
• The terminal strip is used by an auto-wiring task.
• The terminal strip has connected terminals or channels that are
associated with control system tags.
• The terminal strip hasn't been claimed for a project.
• The terminal strip is associated with a local or general signal.
• The target parent item is a plug-and-socket box.
Related Topics

Add a Terminal to a Terminal Strip

1. In the Domain Explorer or Reference Explorer, select a terminal strip to which
you want to add a terminal.
2. Right-click the selected terminal strip and then on the shortcut menu, click New >
Terminal.
3. On the General tab of the Terminal Properties dialog box, accept or select the
required terminal orientation.
4. Enter the terminal number or numbers in the Left terminal or Right terminal
fields.
Tip
• Your selection of the terminal orientation determines whether the Left
terminal or Right terminal fields are available. If you select Left and
right-oriented, the software lets you enter a value for both left and
right terminals. If you select Regular, the software lets enter the
terminal number under Terminal.
5. Under Sequence, type a unique terminal sequence number.
Tip
• The sequence number designates the physical position of the terminal
on the terminal strip. The software assigns a sequence number
automatically when you add a new terminal to a terminal strip. If you
change the sequence number of a terminal, be sure to change the
sequence numbers of the other terminals on that terminal strip to avoid
duplicate values, which may interfere with the termination process.
6. Select a terminal color as needed.
7. In the Details group box, enter a channel number.
8. If the current terminal is in a channel which in turn is a wiring equipment sub-
item, enter a sequence number with in the current channel.
define the new terminal as you require. If any of the lists do not contain the value
that you need, click to open the relevant supporting table where you can
10. In the Note text box, type, if required, type a brief note or a remark about this
terminal.
11. Click the Associate Symbols tab to associate a symbol with the current terminal.

Add a Group of Terminals to a Terminal Strip

1. In the Domain Explorer or Reference Explorer, select a terminal strip to which
you want to add a group of terminals.
2. Right-click the selected terminal strip and then on the shortcut menu, click
Actions > Add Terminal Group.
3. On the Add Terminals dialog box, select an appropriate terminal configuration
from the Configuration name list. The configuration you choose determines the
labeling of the terminals you are about to create.
Tip
• If the required configuration is not available, close this dialog box and
create a new terminal configuration.
• If the selected configuration is suitable, click OK to add the terminals.
• Change the configuration according to your requirements as specified
in the steps below.
5. In the Total number of terminals spin box, enter the total number of new
terminals required.
6. In the First terminal of added group spin box, enter the number of the next
incremented terminal.
Tip
• To continue the numbered sequence of the existing terminals, you
should enter the next numerical value of the terminal, and not the
ordinal sequence. For example, if you already have 48 terminals
arranged in groups of three, where the last 3 terminal labels are +16, -
16, and SH, the value in the First terminal of added group spin box
must be 17 and not 49.
7. In the Terminal Numbering Pattern group box, do the following:
a. Type a prefix in the Prefix field if required.
b. Select the Incremented check box if you want the terminal number to be
c. Select the Numbered check box if you want the number of the terminal to
appear between the prefix and the suffix.
d. Type a suffix if required.
8. Click OK to create the new group of terminals on the terminal strip.

Note
• This dialog box does not allow you to save the changes you make to an
existing terminal strip configuration. The software applies the changes
only to the group of terminals you are currently adding.
Related Topics
Edit the Properties of a Terminal

1. In the Domain Explorer or Reference Explorer, select a terminal that you want
to edit.
2. Right-click the selected terminal and then on the shortcut menu, click Properties.
3. On the General tab of the Terminal Properties dialog box, accept or select the
required terminal orientation.
4. Enter the terminal number or numbers in the Left terminal or Right terminal
fields.
Tip
• Your selection of the terminal orientation determines whether the Left
terminal or Right terminal fields are available. If you select Left and
right-oriented, the software lets you enter a value for both left and
right terminals. If you select Regular, the software lets enter the
terminal number under Terminal.
5. Under Sequence, type a unique terminal sequence number.
Tip
• The sequence number designates the physical position of the terminal
on the terminal strip. The software assigns a sequence number
automatically when you add a new terminal to a terminal strip. If you
change the sequence number of a terminal, be sure to change the
sequence numbers of the other terminals on that terminal strip to avoid
duplicate values, which may interfere with the termination process.
6. Select a terminal color as needed.
7. In the Details group box, enter a channel number.
8. If the current terminal is in a channel which in turn is a wiring equipment sub-
item, enter a sequence number with in the current channel.
define the new terminal as you require. If any of the lists do not contain the value
that you need, click to open the relevant supporting table where you can

10. In the Note text box, type, if required, type a brief note or a remark about this
terminal.
11. Click the Associate Symbols tab to associate a symbol with the current terminal.
Related Topics
Select a Graphic for a Terminal Connection

1. On the Wiring Module window menu bar, click Tables > Terminal > Types.
2. On the Terminal Types dialog box. select a terminal type or create a new one.
3. Click in G1 box to select a graphic that will represent a terminal connection with
a single wire or without any wire.
4. Click in G2 box to select a graphic that will represent a terminal connection with
a multiple wires.
Notes
• The selected graphic appears in the G1, G2, or both boxes. The size
of the G1 and G2 boxes represents the actual size of the icons that
appear in the Connection window.
• If you do not select anything in the G1 or G2 box, SmartPlant
Instrumentation displays the default gray screw head for terminal
connections with or without single wires and the turquoise screw head
for terminal connections with multiple wires.
Related Topics

Making Connections in SmartPlant Instrumentation

SmartPlant Instrumentation employs two methods for implementing cable
terminations - direct visual connection, and a more advanced technique called
connection type. The connection concept behind these methods is based on the
simple idea of letting you work as you would in the field, meaning that if you install a
wire and connect it to a panel, for example, you can do exactly the same on the
screen.
The software enables you to make connections by using the drag-and-drop operation
in the Connection window.
You can make the following connections:
• Connect cables and cable sets to terminals in single mode — this

option allows you to connect cables one by one to the appropriate
terminals.
• Connect cables and cable sets to terminals in batch mode — this
option allows you to simultaneously connect cables to the appropriate
terminals and define their connections.
Notes
• You can keep more than one Connection window open at the same
time. This can be useful when viewing the wiring routing.
• Dragging a cable, cable set, or wire to a terminal not currently visible
in the Connection window makes the screen scroll up or down until
the required terminal is displayed.
• If the width of your computer monitor allows it, you can follow the
course of a cable from one terminal strip to the other (provided that the
cable is connected between two terminal strips). You can view the
cable continuation between two terminal strips by resizing the
Connection window and clicking (or clicking Actions > Adjacent
on the Connection window menu bar) to simultaneously display both
terminal strips.
• When connecting the right side of a DCS or PLC panel, the software
increases the signal level by one.
Related Topics
• Making Connections Common Tasks, page 525

Making Connections Common Tasks

The following tasks are used frequently when you make connections in SmartPlant
Instrumentation.
Define a Connection Type

This option allows you to select, create, or edit a connection type that facilitates rapid
cable set connections. You define a connection type that contains a connection
pattern. A connection type contains the definition of the pattern by which wires will
be connected on a terminal strip, and allows automatic creation and connection of
jumpers between successive cable sets. Once a wiring pattern has been defined, it can
be selected whenever desired and will determine how the connections are made. For
more information, see Define a Connection Type, page 527.
Connect a Cable or a Cable Set to a Terminal Strip

This procedure explains how to connect a cable or cable set to a terminal strip. The
connection is accomplished by dragging a cable or cable set to a terminal in the
Connection window. Then, you are required to define the cable connection, which
effects the connection. Note that you can connect only plant cables and panels and
not reference panels and cables. However, while the Connection window is open,
you can copy reference items from the Reference Explorer to the Domain Explorer
and then drag them to the Connection window. For more information, see Connect a
Cable or a Cable Set to a Terminal Strip, page 530.
Connect Device Cables in Batch Mode

Use this procedure to connect device cables or cable sets to a terminal strip in batch
mode. Note that these are device cables that are already connected to device panels.
For more information, see Connect Device Cables in Batch Mode, page 532.
Connect a Wire to a Terminal Strip

This procedure explains how to connect a wire to a terminal strip. For more
information, see Connect a Wire to a Terminal Strip, page 534.
Disconnect Cables, Cable Sets, and Wires

This procedure shows how to disconnect a given cable or selected cable sets and
wires from a terminal strip. For more information, see Disconnect Cables, Cable
Sets, and Wires, page 536.
Move Cables, Cable Sets, and Wires

After making initial connections to terminals, SmartPlant Instrumentation lets you
relocate cables, cable sets, and wires to another terminal on the same terminal strip.
You can move a wiring item using the drag-and-drop feature. For more information,
see Move Cables, Cable Sets, and Wires, page 535.

View Cable Connection Destination

This option enables you to view the connection destinations of a cable that you select
in the Domain Explorer. When you select this option, you see the junction boxes
and terminals that the selected cable is connected to. For more information, see View
Cable Connection Destination, page 540.
Display Adjacent Connections of a Cable

When you are working on wiring connections for a specific panel, you can follow the
wiring routing to an adjacent panel. For more information, see Display Adjacent
Connections of a Cable, page 541.
Display the Farthest Connection of a Cable

While working in the Connection window, in addition to displaying the adjacent
connection of a cable or a wire, you can also open the farthest connection. This
means that the software switches to the end of the wiring routing of the current wire
and displays the last panel on that end. If a signal exists in the direction that you
chose to switch to, SmartPlant Instrumentation follows the signal to the end. If there
is no signal, the software shows the panel that is connected at the end of the wiring
routing. For details, see Display the Farthest Connection of a Cable, page 541.
Trace a Signal in a Point-to-Point Wiring Diagram

You can follow a signal along a sequence of wires. SmartPlant Instrumentation uses
wire groups, group level and group sequence data to follow a signal along a series of
wires and check for any discontinuity. The wire group is the signal name
representing the tag number from which the signal originates. The result is displayed
in a point-to-point wiring diagram that you can print. For more information, see
Trace a Signal in a Point-to-Point Wiring Diagram, page 543.
Add Jumpers to the Existing Wiring

SmartPlant Instrumentation enables you to create and connect multiple jumpers in a
repetitive way. You can define constant gaps between the jumpered terminals if
required. Also, you can jumper the last remaining terminal in the selected terminal
pattern if required. Note that unlike regular wires, jumpers do not propagate signals.
You can assign a wire group to a jumper manually on the Terminal Connection
dialog box. For more information, see Add Jumpers to the Existing Wiring, page 537.
Remove a Jumper from the Existing Wiring

This procedure explains how to remove a jumper. For more information, see Remove
a Jumper from the Existing Wiring, page 538.

Generate a Connection Report

While in the Connection window, you can generate a connection report for the
current terminal strip. The report lists all the cables connected to the selected
terminal strip and shows all the cable-sets within each cable, the wire tags, their color,
and terminal number. This report does not show adjacent connections. For more
information, see Generate a Connection Report, page 544.
Related Topics
• Making Connections in SmartPlant Instrumentation: An Overview,
page 524
Define a Connection Type

1. Start the Wiring module and then do one of the following:
• Click Actions > Connection Types.
• Click on the Wiring module toolbar.
2. On the Connection Type dialog box, click New.
3. On the New Connection Type dialog box, configure the new connection type by
selecting the number of wires and jumpers that the new connection type will
contain.
4. Click OK to return to the Connection Type dialog box.
5. In the Connection type text field, type the name of the new connection type.
6. In the Description text field, type a short description if needed.
7. In the Skip between sets field, enter the number of terminals that will be skipped
between the first terminals of each cable set.
8. In the Wires group box, do the following:
a. Click in the Skip text field and type the number of terminals to skip before
connecting this wire in the cable set. The skip is always relative to the first
terminal to which a wire in the cable set is connected. Enter the number of
terminals to be skipped according to your needs. In most cases, this value is
incremented for successive wires. You can accept the displayed value if
suitable.
b. In the Side field, click the A – Active or O – Opposite option button to
select the terminal side to which you want to connect each wire. The side that
is currently active depends on the side you start to connect.
c. Click in the Land field to connect a wire. A screw head appears indicating
that a connection has been configured.

Tip
• The Wire field displays a specific wire in the cable set. The displayed
W00x values represent the wire names and are used to illustrate the
current connection type configuration. This field is not editable.
9. To configure a jumper connection, do the following in the Jumpers group box:
a. From the Type list, select a jumper type from this list. The values in this list
are determined in the Wire Type supporting table.
b. From the Color list, select the required jumper color.
c. Click in the End 1 and End 2 fields to connect to a jumper. A screw head
shows up indicating that a connection has been configured.
d. Click in the Skip text field and type the number of terminals to skip for the
jumper in the cable set for landing. You can accept the displayed value if
appropriate. Repeat the same procedure for the other end.
e. In the Side fields, click the A – Active or O – Opposite option button to
select the terminal side where the jumper will be connected. The side that is
currently active depends on which side you start to connect.
Tips
• The options in the Jumpers group box become available only if you
have selected jumpers to be configured on the New Connection Type
dialog box.
• The terminals to which the ends of a jumper are connected must reside
on the same strip. Both ends of a jumper must be connected for it to
appear in the display region. For an illustration, see Connection Type
Examples, page 529.
10. Click Save.
Related Topics
page 524

Connection Type Examples

Example 1: (a two-wire cable set)
The following connection type example illustrates how the connections are made for
a 2-wire cable set when the skip between cable sets is 6:
The position of the + wire in each cable set to be connected has been assigned a skip
of 0. The – wire of Set 1 has been assigned a skip of 1. The – wires of Sets 2 and 3
have each been assigned a skip of 6.
Example 2: (two wires with a jumper)
The following example illustrates how you can connect a single pair to a strip and
create a jumper on the opposite side between the first and third terminals. The next
pair will be connected to the third terminal, if the skip between sets parameter was set
to 2.

The outcome of this operation, when terminating multiple pairs, will be pairs
connected sequentially where every first wire in a set is connected by a jumper to the
one that follows, as illustrated below:
Related Topics
• Define a Connection Type, page 527
Connect a Cable or a Cable Set to a Terminal Strip

2. Expand the Cables folder or a panel hierarchy and then right-click one of the
following items:
• a cable
• a cable set
• a panel
• a terminal strip
3. On the shortcut menu, click Actions > Connection.
4. In the Connection window, from the Terminal strip list, select an appropriate
terminal strip.
Tip
• If the terminal strip that you need does not exist in the Domain
Explorer, you can copy a reference terminal strip from Reference
Explorer to the Domain Explorer while the Connection window is
open. (Press F8 to open the Reference Explorer.)
5. In the Domain Explorer, select the cable or cable set that you want to connect.
6. Drag the selected cable or cable set to the appropriate terminal in the data
window.
7. Drop the cable or cable set on the required terminal (shown as a screw head ) to
open the Cable Connection Definition dialog box.

8. On the Cable Connection Definition dialog box, do the following:

a. Select End 1 or End 2 for the side of the cable that you want to connect.
b. To change the terminal number where the first wire is to be connected, from
the Start at terminal list, select the required terminal.
c. In the Cable set connection details data window, select the cable sets that
you want to connect, or choose Select all cable sets.
d. From the Connection Type list, select the connection type for each cable set
that you are going to connect.
e. Select L (left) or R (right) for the physical side of the terminal where the cable
set enters. Note that screw head indicates that the cable set is already
connected on the selected cable end.
f. Click Connect to connect the selected cable sets and return to the Connection
window.
Notes
• SmartPlant Instrumentation connects the individual wires
automatically in accordance with the selected connection type.
• You can double-click a cable, cable set, wire, terminal, or terminal
strip header in the Connection window to edit it.
page 524

Connect Device Cables to a Terminal Strip in Batch Mode

2. Expand the Panels by Location or the Panels by Category folder to display the
existing panels and terminal strips.
3. Right-click a terminal strip to which you want to connect device cables, and then
on the shortcut menu, click Actions > Batch Connection.
4. In the Domain Explorer, select the device cables that you want to connect and
drag them to the Batch Device Cable Connection window.
Tips
• You can only drag those cables that have been connected to device
panels on one end and unconnected on the other end. Also, there
cannot be any connectors on the unconnected end.
• You can filter the display of cables in the Domain Explorer so that
you can easily find the device cables that you need. For details, see
Pre-Assign Junction Boxes to Device Panels, page 580.
• Click on the lower toolbar to open a pop-up window that displays

which terminals are connected.
• The settings displayed under Starting Terminal are determined by the
automatic implementation of connection type definitions for the cables
that you move to the data window.
• You can change the order of cables in the data window by dragging
them up or down.
5. To change the connection type for a given cable set, from the Connection Type
list, select an appropriate connection type.
6. When changing the connection type for the first cable set, in response to the `Do
you want to change the connection type for all cable sets?' prompt, do one of the
following:
• To change the connection type for all of the cable sets displayed in the
data window, click Yes. Note that this also results in automatic
renumbering of the starting terminals for all of the cable sets.
• To change the connection type for the given cable set only, click No.
Note that this results in no automatic renumbering of starting
terminals.

7. To change the cable set starting terminals, do one of the following:

• To change the starting terminal for a given cable set, select a value
from the Starting Terminal list.
• To automatically renumber starting terminals according to cable type
definitions, from the selected cable set and below, click Actions >
Reassign.
8. Under Terminal Side accept the default setting L to connect the device cables to
the left side of the panel, or select R to connect the cables to the right side.
9. Under Connect all shields to, do one of the following:
• Do not select any terminal. Use this option to connect the shields
according to the configuration of the active cable types.
• Select a common terminal to which you connect all of the shields.
10. Under Connect all overall shields to, do one of the following:
• Do not select any terminal. Use this option to connect the overall
shields according to the configuration of the active cable types.
• Select a common terminal to which you connect all of the overall
shields.
• To prepare for connection of the all of the device cables displayed in
the data window, clear Connect selected rows only.
• To prepare for connection of some of the device cables displayed in
the data window, select the rows that you want to connect and then
select Connect selected rows only.
12. To connect the devices cables to the terminal strip according to your settings, do
• Click Actions > Connect.
• On the lower toolbar, click .
Related Topics
page 524

Connect a Wire to a Terminal Strip

2. Expand the Panels by Category or Panels by Location folder.
3. Right-click a panel or a terminal strip and then on the shortcut menu, click
Actions > Connection.
4. If, in the Domain Explorer, you selected a panel and not a terminal strip, in the
Connection window, select one from the Terminal Strip list.
5. In the Domain Explorer, select a cable and expand its hierarchy to display its
wires.
6. Select a wire and drag it to a terminal (shown as a screw head ) in the
Connection window.
Tip
• Click to find a specific terminal or the next available terminal.
SmartPlant Instrumentation marks your terminals with .
7. On the Wire Connection Options dialog box, select the wire that you require and
then click OK.
Notes
• If you are connecting more than one wire in a cable or cable set to a
group of terminals on a terminal strip, make sure that the wire end that
you connect is the same for all the wires. This is important to ensure
that the connections appear correctly in reports.
• If one end of the wire is already connected, SmartPlant
Instrumentation selects the loose end by default.
Related Topics
page 524

Move Cables, Cable Sets, and Wires

1. In the Connection window, select the appropriate cables, cable sets, or wires.
2. Drag the selected items to another terminal. If you are moving a cable or a cable
set, the Cable Connection Definition dialog box opens. If you are moving a
wire, the Wire Connection Options dialog box opens.
3. Select the required definitions on the Cable Connection Definition dialog box or
on the Wire Connection Options dialog box and then click Connect or OK
respectively.
Notes
• The Connection window reopens showing the new connections.
• You should ensure that there are sufficient terminals to accept all the
wires to be relocated.
• You can connect any number of wires to a single terminal.
• If you are connecting more than one wire in a cable or cable set to a
group of terminals, make sure that the wire end that you connect is the
same for all the wires. This is important to ensure that the connections
appear correctly in reports.
Related Topics
page 524

Disconnect Cables, Cable Sets, and Wires

1. In the Connection window, select the cable, cable sets, or wires you want to
disconnect.
Tip
• SmartPlant Instrumentation automatically selects the wiring items in
the hierarchy below the item that you select.
2. In the Connection window, do one of the following:
• Right-click the selected item then click Disconnect on the shortcut
menu.
• On the menu bar, click Connection > Disconnect.
• Click on the Connection toolbar.
Notes
• If a terminal strip or terminal is connected to more than one cable, only
wires which are unique to a terminal or which belong to a cable at the
top level layer (at the front) will be disconnected by SmartPlant
Instrumentation.
• SmartPlant Instrumentation uses to represent terminals on which
multiple wires are connected.
• To ensure disconnection of the correct cables or cable sets, first move
the cable you want to disconnect to front by selecting it from the
Cable name list.
Related Topics
page 524

Add Jumpers to the Existing Wiring

2. Expand the Panels by Location or the Panels by Category folder to display the
existing panels and terminal strips.
3. Right-click a panel or a terminal strip and then on the shortcut menu, click
4. In the Connection window, select a wire connected to the terminal that will be
the first terminal connected to the first jumper.
Tip
• Do not make any selection if you want the terminal connected to the
first wire to be the connected to the first jumper.
• Right-click the selected wire and then on the shortcut menu, click
Connect Jumpers.
• Click Connection > Connect Jumpers.
• Click .
6. On the Connect Jumpers dialog box, do the following:
a. From the Terminal one - first jumper list, select a terminal and set its Left
or Right orientation.
b. From the Terminal two - first jumper list, select a terminal and set its Left
or Right orientation.
c. If you need to define a constant gap between the jumpered terminals, enter a
value in the Interval between jumpers box.
d. From the Last terminal list, select the last terminal in the pattern that you
want to jumper.
e. Select the Jumper the last terminal check box if you want to jumper the last
remaining terminal in the terminal pattern.
f. Select a jumper color.
g. In the Jumper name box, type the name of the new jumper, or accept the
default setting. By default, SmartPlant Instrumentation suggests a name for a
new jumper of the format J<first terminal name>/<second terminal name>.
You can change the preferences so as not to display a suggested jumper name.
For details, see Set Preferences for Automatic Naming of Jumpers, page 538.
7. Click OK.
Note
• Your new jumpers appears in the Connection window.

Set Preferences for Automatic Naming of Jumpers

2. Expand the Wiring hierarchy in the tree view and select Jumpers.
3. Under Automatic naming, select Name jumpers automatically.
4. Click OK.
Related Topics
• Add Jumpers to the Existing Wiring, page 537
page 524
Remove a Jumper from the Existing Wiring

1. In the Connection window, select a jumper you want to remove.
• Right-click the selected jumper and then on the shortcut menu, click
Disconnect.
• On the Connection window menu bar, click Actions > Disconnect.
• Click .
Notes
• Jumpers exist in the database as long as they are connected.
Disconnected jumpers are deleted from the database.
• You cannot move a jumper. Instead, disconnect the jumper that you
do not need and then add a new jumper as required.
Related Topics
page 524

Assigning Wire Designation

The Terminal Connection dialog box opens when you click a screw head on the
terminal in the Connection window. This dialog box shows the Wire Group, Group
Level, and Group Sequence of the wires connected to the selected terminal.
When you click on Wire Group, Group Level, or Wire Sequence data, you can
reassign the wire designation by selecting the required value from the appropriate
lists.
You can assign a new signal name to more than one terminal without having to
browse through the Wire Group list for each terminal. You use this feature only
with terminals whose Wire Group is currently undefined (that is, the Wire Group
data field displays asterisks).
First, you need to assign a new signal name to a terminal whose Wire Group is
currently undefined. After assigning the new signal to the current terminal, select
another terminal (click the up or down arrow or select a terminal in the Terminal
name list). If you now click in the Wire Group data field, the list opens with the
new signal name selected by default. Clicking the terminal name enables you to
navigate quickly.
Note
• If you want to reassign wire designations on the Terminal
Connection dialog box, it is advisable to plan your changes in advance
on paper, to avoid conflicting Wire Group, Group Level, and Group
Sequence data.
page 524

Updating Connection Data

Multiple users can work on the same module. In most cases, you may not edit data
that is being edited by another user, however, under certain circumstances, other users
may have made changes that affect the data in the Connection window. For
example, another user has added a new plant cable. This cable does not appear in the
Domain Explorer until you refresh the window display. Click to do so.
The Connection window is automatically refreshed only when you open it.
However, SmartPlant Instrumentation does not refresh the data in the Connection
window, if you have several instances of the Connection window open and you
switch from one Connection window to another.
Related Topics
page 524
View Cable Connection Destinations

1. In the Domain Explorer, double-click the Cables folder.
2. Right-click a cable.
3. On the shortcut menu, click Actions > Destination.
Notes
• The Cable Destination pop-up window displays individual
connections for the selected cable. Note that each line shows a
connection to a different panel.
Related Topics
page 524

Display Adjacent Connections of a Cable

1. In the Connection window, select a cable, cable set, or wire whose routing you
want to trace on a particular terminal side.
Tip
• If you select a cable or cable set, SmartPlant Instrumentation displays
the adjacent connection for the first wire. You can follow the routing
for the other wires by selecting other panels from the list.
• On the menu bar, click Actions > Open Adjacent Connection.
• Right-click the selected item and then on the shortcut menu, click
Open Adjacent Connection.
• Click on the lower toolbar.
Note
• The Connection window opens, showing the adjacent panel which is
the continuation of the wiring routing.
Related Topics
page 524
Display the Farthest Connection of a Cable

1. In the Connection window, select a wire whose routing you want to trace on a
particular terminal side.
• On the menu bar, click Actions > Open Farthest Connection.
• Right-click the selected item and then on the shortcut menu, click
Open Farthest Connection.
Note
• The Connection window opens, showing the farthest panel at the end
of the wiring routing. For examples, see Examples of Farthest
Connections of Cables, page 542.
Related Topics

Examples of Farthest Connections of Cables

While working in the Connection window, in addition to displaying the adjacent
connection of a cable or a wire, you can also open the farthest connection. This
means that the software switches to the end of the wiring routing of the current wire
and displays the last panel on that end. If a signal exists in the direction that you
chose to switch to, SmartPlant Instrumentation follows the signal to the end. If there
is no signal, the software shows the panel that is connected at the end of the wiring
routing.
Example 1:
In this example, you selected the left side connections of JB-2. Therefore, SmartPlant
Instrumentation will display the connection of the device panel.
Example 2:
In this example, you selected the right side connections of JB-2. Therefore, the
software will display the connection of the DCS or the I/O card.
Related Topics
page 524


1. Do one of the following to open the Point-to-Point Wiring Diagram:
• In the Domain Explorer, right-click a cable, cable set, panel, or a
terminal strip and then on the shortcut menu, click Actions >
Connection. For best results, make sure that the connection
information is complete for the items that you selected.
• In the Domain Explorer, right-click a cable, cable set, panel, or a
terminal strip and then on the shortcut menu, click Actions > I/O
Assignment. For best results, make sure that the I/O assignment
information is complete for the items that you selected.
2. In the Connection window, from the Terminal strip list, select the terminal strip
to which you want to trace the signal path.
Tip
• If you are working in the I/O Assignment window, skip steps 2 and 3.
3. From the Cable list, select the cable containing the wire for which you want to
trace the signal path.
• In the Connection window, select the wire for which you want to trace
the signal path.
• In the I/O Assignment window, under Channel Assignment, select a
channel associated with an instrument tag.
5. Click to locate a specific terminal or channel.
6. Do one of the following to generate the Point to Point Wiring Diagram report:
• On the module toolbar, click .

• On the menu bar, click Reports > Point to Point Wiring Diagram.
• In the Connection window, right-click the selected wire and on the
shortcut menu click Point to Point Wiring Diagram.
7. Do one of the following when prompted to preview the report:
• Click Yes to preview the Point to Point Wiring Diagram.
• Click No to print the report without displaying it on your computer.
Notes
• To view the point-to-point diagram legend, scroll down to the lower
part of the preview.
• To hide the default notation of level and sequence of the signals and
tags, click View > Show Level/Sequence. To display the notation,
click again.

• You can resize the fonts of the cable and cable set names in the Point
to Point Wiring Diagram. For details, see Change the Font Size of
Cable and Cable Set Names, page 544.
Related Topics
page 524
• Signal Propagation: An Overview, page 591
Change the Font Size of Cable and Cable Set Names

1. In the Point-to-Point Wiring Diagram, click View > Font Size.
2. Do one of the following on the Resize Fonts dialog box:
• In the Size field, type the required font size of the cable and cable set
names.
• Use the spinner to increase or decrease the font size.
3. Click OK to close the Resize Fonts dialog box and return to the Point to Point
Wiring Diagram print preview where you see the changes you made to the cable
and cable set name fonts.
Related Topics
page 524
Generate a Connection Report from the Connection

Window
• On the menu bar, click Reports > Connection.
• Click .
2. In the Print Preview prompt, click Yes to display the report print preview or
click No to print out the report without displaying its print preview.
Related Topics
• Generating Wiring Reports Common Tasks, page 635
page 524

I/O Assignment: An Overview

The I/O assignment in SmartPlant Instrumentation enables you to assign a channel to
a specific instrument or a fieldbus segment.
I/O assignment for an instrument is performed in two stages:

1. Associating (coupling) an instrument with a control system tag.
2. Assigning the coupled pair to a channel.
I/O assignment for a segment is also performed in two stages:
1. Associating (coupling) each virtual tag with a control system tag.
2. Assigning the coupled pairs to an I/O channel.
Note
• The software displays the available instruments according to the
current I/O type. You can change the I/O type by setting the
appropriate I/O assignment preference. For details, see Set I/O
Assignment Instrument Tag Preferences, page 549.
Related Topics
• Effecting I/O Assignment Common Tasks, page 546

Effecting I/O Assignment Common Tasks

The following tasks are used frequently when effecting I/O assignment in SmartPlant
Instrumentation.
Set I/O Assignment Instrument Tag Preferences

Prior to effecting I/O assignment, you can set your I/O assignment preferences for the
I/O types of the instrument tags. 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.
For more information, see Set I/O Assignment Instrument Tag Preferences, page 549.
Effect I/O Assignment for an Instrument

I/O assignment is essentially assigning a control system tag to a free channel. I/O
assignment for an instrument is performed in two stages:
1. Associating (coupling) an instrument with a control system tag.
2. Assigning the coupled pair to a channel.
For more information, see Effect I/O Assignment for an Instrument, page 549.
Effect I/O Assignment for a Segment

I/O assignment for a segment is performed in two stages:
1. Associating (coupling) each virtual tag with a control system tag.
2. Assigning the coupled pairs to an I/O channel.
For more information, see Effect I/O Assignment for a Segment, page 551.

Assign an Instrument to a Channel

The essence of I/O assignment is assigning an instrument to a channel. SmartPlant
Instrumentation provides several options for this purpose. You can choose one of the
following options for I/O assignment:
• Select an instrument tag coupled with a control system tag and assign
both of them to a free channel.
• Couple an instrument tag with an existing control system tag and then
assign them to a free channel.
• Assign an uncoupled control system tag to a free channel.
• Assign an uncoupled instrument tag to a free channel. You will have
to create a new control system tag in the process and the coupling will
be done automatically.
• Assign an uncoupled instrument tag to a channel to which a control
system tag has already been assigned.
For more information, see Assign an Instrument to a Channel, page 552.
Assign a Segment to a Channel

This option enables to assign a segment to a channel so that you can effect I/O
assignment for fieldbus segments. For more information, see Assign a Segment to a
Channel, page 553.
Create a Channel
This option allows you to create additional channels to the ones that the software
created in a particular I/O card or terminal strip. For more information, see Create a
Channel, page 554.
Create a Control System Tag

This option allows you to create a new control system tag. Note that control system
tag names must be unique. If you are using a DCS, the uniqueness applies per
<plant>. If you are using a PLC, the uniqueness applies per cabinet or panel. For
more information, see Create a Control System Tag, page 555.
Rename a Control System Tag

You can change the name of an existing control system tag, for example, if you
replace an existing one with a newer model. For more information, see Rename a
Control System Tag, page 556.
Couple an Instrument with a Control System Tag

One of the ways to implement I/O assignment is to assign to a free channel a control
system tag coupled with an instrument tag. For more information, see Couple an
Instrument with a Control System Tag, page 557.

Decouple an Instrument and a Control System Tag

This procedure explains how to decouple an instrument tag and a control system tag
where the instrument is no longer connected. For more information, see Decouple an
Instrument and a Control System Tag, page 557.
Filter the Display of Data in the I/O Assignment Window

This feature enables you to filter the data displayed in the I/O Assignment window.
You can instruct the software to display only assigned or unassigned instruments.
Furthermore, you can display only uncoupled instruments, uncoupled CS tags, or
both. Also, you can select a predefined Browser filter for panels. For more
information, see Filter the Display of Data in the I/O Assignment Window, page 558.
Cancel I/O Assignment

Canceling I/O assignment involves a simple procedure of removing the instrument
assignment (unassigning) an instrument from a channel. For more information, see
Cancel I/O Assignment, page 559.
Generate an I/O Tag Assignment Report

This option enables you to generate a report showing I/O assignments for an I/O card
or I/O termination that you select in the I/O Assignment window. For more
information, see Generate an I/O Tag Assignment Report, page 560.
View and Edit Channel Data

This option enables you to view the channels of a selected DCS/PLC panel or all
DCS/PLC panels in the current <plant>. You can also modify the control system tag
names if required. For more information, see View and Edit Channel Data, page
560.
Find I/O Channels for I/O Assignment

This option enables you to search DCS or PLC panels in the current <plant> for I/O
cards and individual channels according to required criteria. SmartPlant
Instrumentation then displays these channels in the I/O Assignment window, and you
can use them to effect an I/O assignment. For more information, see Find I/O
Channels for Assignment, page 562.
Related Topics

Set I/O Assignment Instrument Tag Preferences

2. Expand the Wiring hierarchy in the tree view and select I/O Assignment.
3. Under I/O assignment validation select one of the following options:
• 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.
4. Click OK.
Related Topics
Effect I/O Assignment for an Instrument

• Select a parent wiring item that contains one or more I/O card child
items and whose I/O type is Fieldbus FF.
• Select an I/O card or an I/O termination whose I/O type is Fieldbus
FF.
3. Right-click the selected items and then on the shortcut menu, click Actions > I/O
Assignment.
Tips
• The software allows you to open the I/O Assignment window without
selecting anything in the Domain Explorer. On the Wiring Module
window toolbar, click .
• You can also open the I/O Assignment window for an I/O card from
the Connection window. On the Connection menu, click I/O
Assignment.
4. On the I/O Assignment Type dialog box, select I/O Assignment.
Tip
• For fieldbus I/O assignment, select Segment I/O assignment. For
details, see Configure a Fieldbus Apparatus, page 687.

5. If you did not select a panel or an I/O card in the Domain Explorer before
opening the I/O Assignment window, do one of the following in the I/O
Assignment window:
• Click to open the Find Channel dialog box, where you find and
select channels to display in the I/O Assignment window.
• In the I/O card details pane, click beside the I/O termination list to
open the Domain Explorer where you select the required I/O cards,
then click OK to add them to the I/O card list.
6. From the I/O termination list, select an item for which you want to effect I/O
assignment.
Tip
• The I/O type of the selected I/O card or I/O termination determines the
I/O type of the initial instrument tag displayed in the I/O type list.
You can select a different I/O type from this list if required. The list of
instruments displayed in the Tag list data grid depends on the I/O type
that you select from the I/O type list. If the I/O type selection is
MIXED, instruments of all I/O types are shown. If any another I/O
type is selected, only the instruments of the selected I/O type are
shown.
7. If required, select a different I/O type, which enables you to use an instrument tag
for the I/O assignment whose I/O type is different from the I/O card I/O type. To
do this, do one of the following:
• If the I/O type selection is MIXED, select the required I/O type from
the I/O type list.
• If the I/O type selection is not MIXED, change the definitions to
make the I/O type list available at all times by selecting the All I/O
types preference on the Preferences (Wiring - I/O Assignment)
dialog box. For details, see Set I/O Assignment Instrument Tag
Preferences, page 549.
8. Drag an instrument or a control system tag to a free channel in the Channel
assignment pane to effect I/O assignment.
Note
• Several assignment options are possible. For details, see the Assign
an Instrument to a Channel section in Effecting I/O Assignment
Common Tasks, page 546.
Related Topics

Effect I/O Assignment for a Segment

FF.
Assignment.
Tips
• You can also open the Segment I/O Assignment window from the
Connection window. On the Connection menu, click I/O
Assignment.
4. On the I/O Assignment Type dialog box, select I/O Assignment.
Tip
• For fieldbus I/O assignment, select Segment I/O assignment. For
details, see Configure a Fieldbus Apparatus, page 687.
5. If the I/O Assignment Type dialog box opens, select Segment I/O Assignment
I/O assignment.
6. From the I/O termination list, select an item for which you want to effect I/O
assignment.
7. From the Segment coupling list, select a required segment type. This selection
determines which items are displayed under Segments.
8. Drag a segment to a free channel in the Channel assignment pane to effect I/O
assignment.
Note
• Several assignment options are possible. For details, see the Assign
an Instrument to a Channel section in Effecting I/O Assignment
Related Topics

Assign an Instrument to a Channel

1. Open the I/O Assignment window.
2. In the Tag coupling data grid, select one of the following:
• An instrument tag coupled with a control system tag.
• An instrument not coupled with a control system tag.
• A control system tag not coupled with an instrument.
3. Drag the selected item to a free channel in the Channel assignment pane.
4. If you selected an instrument not coupled with a control system tag, do the
following:
a. On the Control System Tag dialog box, type the name of the control system
tag that SmartPlant Instrumentation creates automatically.
b. Click OK on the Control System Tag dialog box to complete the I/O
assignment.
Note
• You can shift the assignment of an instrument to another unassigned
channel by simply pressing and holding the Ctrl key while dragging
the instrument to another unassigned channel. You cannot change the
assignment this way if the target channel has already been assigned to
another instrument. Note that when changing the assignment, the
software retains the existing control system data.
Related Topics
• Fieldbus Bricks: An Overview, page 683
• Managing Fieldbus Brick Assemblies and Apparatuses Common
Tasks, page 684

Assign a Segment to a Channel

FF.
Assignment.
4. From the Segments list, select an appropriate segment.
Tip
• The software displays only those segments that contain instruments for
which virtual tags have been created.
5. Drag the selected segment to a free channel in the Channel assignment pane.
Note
• You can shift the assignment of a segment to another unassigned
channel by simply pressing and holding the Ctrl key while dragging
the segment to another unassigned channel. You cannot change the
assignment this way if the target channel has already been assigned to
another segment. Note that when changing the assignment, the
software retains the existing control system data.
Related Topics
Tasks, page 684

Create a Channel
1. In the Domain Explorer, select an I/O card, I/O termination, or a terminal strip
with channels.
2. Right-click the item to which you want to add a channel and then on the shortcut
menu, click New > Channel.
3. On the Channel Properties dialog box, on the General tab, type a channel name,
description and sequence as you require.
4. If you are adding a channel on a terminal strip under an I/O card or I/O
termination, click the I/O Properties tab.
5. On the I/O Properties tab, select the channel type, I/O type, and signal type.
6. Type a value in the Address field as you require.
7. Type a minimum and maximum range and select a unit of measure for the range
values.
8. Select the Enable for use with external DCS interfaces (DeltaV) check box to
make these channel property values available for use with a DCS interface such as
DeltaV.
9. Click the Associate Symbols tab to associate a symbol (.sym) file with the new
channel. For details, see Associate a Symbol with an Item, page 431.
10. Click OK.
Related Topics

Create a Control System Tag

1. On the I/O Assignment window menu bar, click Actions > Control System Tag.
2. On the Control System Tag dialog box, type the name of the new control system
tag and click OK.
Tip
• You can now add an additional control system point configuration if
needed.
3. To document additional DCS/PLC data, on the SmartPlant Instrumentation
toolbar click .
Tip
• The Browser Manager opens. If you have a predefined Wiring
default browser and a default view, the Browser View opens by
default.
4. Do the following in the Browser Manager:
a. Expand the Control System browser group by clicking next to its icon or
double-clicking the icon.
b. To view the control system tag data, create a browser view for one of the
available browsers in the Control System Tag Browser group. You can
select an appropriate browser in this group and then click . Alternatively,
you can define a new view, filter, and sorting sequence as you require.
c. Click to view the selected field data in the browser view.
d. If required, you can edit the displayed data, sort, change the sequence of, and
resize the columns. For more information on how to work with browser
views, see Browser Views Common Tasks, page 316.
Related Topics

Create a Control System Tag in the Instrument Index

Standard Browser View
1. In the Instrument Index Module window, do one of the following to open the
Instrument Index Standard Browser view:
• On the menu bar, click Actions > Standard Browser View.
• Right-click, and on the shortcut menu, click Apply Profile > Create
Control System Tag.
• On the Actions menu, click Apply Profile > Create Control System
Tag.
4. In the Results dialog box, view the CS tag creation results, and then click Close.
Note
• To make this feature work, you must select the Create wiring and
Control system check boxes on the Wiring and Control System tab
in the instrument type profile of the selected tag number before you
attempt to create a new control system tag. For more details, see
Define an Instrument Type Profile, page 348
Related Topics
• Define a Standard Browser View for the Instrument Index, page 403
Rename a Control System Tag

1. In the I/O Assignment window, select the control system tag that you want to
rename.
Tip
• You can select the required control system tag in the Tag coupling
data window or in the Channel assignment pane.
• Click Actions > Rename Control System Tag.
• Click .
3. On the Control System Tag dialog box, type the new name of the control system
tag.
4. Click OK.

Couple an Instrument with a Control System Tag

1. In the I/O Assignment window, select a free instrument in the Tag Coupling
data grid.
2. Click Actions > Couple Tags.
3. Select the control system tag you want to couple with the instrument tag you have
selected.
4. Click OK.
Note
• The instrument tag and the control system tag appear coupled in the
Tag coupling data grid.
Related Topics
Decouple an Instrument and a Control System Tag

1. Open the I/O Assignment window.
2. In the Tag coupling pane, select a coupled instrument tag and control system tag.
• Click Actions > Decouple Tag No. from SC Tag.
• Click
Note
• The instrument tag and the control system tag appear separately in the
Tag coupling data grid.
Related Topics

Delete a Control System Tag

1. In the I/O Assignment window, select the control system tag that you want to
delete.
Tip
• You can select the required control system tag in the Tag coupling or
in the Channel assignment pane. If, in the Channel assignment
pane, you select a CS tag in the that is still coupled with an instrument,
the software informs you that the I/O assignment for that channel will
be canceled.
• Click .
• Click Actions > Delete Control System Tag.
3. Click Yes to confirm the deletion.
Related Topics
Filter the Display of Data in the I/O Assignment Window

1. In the I/O Assignment window, do one of the following to open the I/O
Assignment Filter dialog box:
• Click .
• Click Actions > Filter.
• From the Filter list, select a predefined filter for panels. Note that if
you select a predefined filter from this list, it overrides all the other
settings in this dialog box. If you do not have a predefined filter, open
the Browser Manager and define a filter for an appropriate view that
contains panels. For details, see View Filter Settings Common Tasks,
page 303.
• Define your filter using the options in the Filter for and Definition
group boxes.

3. Under Filter for, select the filter option to determine which instrument tags and
control system tags will be displayed in the I/O Assignment window. Select one
of the following:
• Unassigned tags coupled with control system tags— display the
instruments that have not yet been assigned to channels but have
already been coupled with control system tags. Then, you can
determine whether to display uncoupled CS tags, uncoupled
instruments, or both.
• Assigned tags coupled with control system tags— display only the
assigned instruments that have already been coupled with control
system tags. Selecting this option disables the other three options.
4. To further filter the display of unassigned instruments, uncoupled instruments, or
both, under Definition, define an appropriate filter expression. For details, see
Define a View Filter, page 305.
5. To use the current filter settings in subsequent sessions of the I/O Assignment
window, select the Apply filter settings in all sessions check box.
6. To display only the instruments that were retrieved from SmartPlant Electrical,
select the SmartPlant Electrical tags check box.
7. To limit the display of data to the current lowest plant group, select the Display
current unit data only check box.
8. Click OK.
Related Topics
Cancel I/O Assignment

1. In the I/O Assignment window, select a channel in the Channel assignment
pane.
• Click .
• Click Actions > Unassign from channel.
Note
• The selected channel becomes vacant as the instrument and its control
system tag move to the Tag list pane.
Related Topics


1. In the I/O Assignment window, under I/O assignment, select an I/O card or an
I/O termination from the list.
2. Select the required I/O card from the I/O card name list.
• Click .
• Click Reports > Tag assignment Report.
4. Click Yes to open the print preview of the report or click No to send the report to
your default printer.
Related Topics
View and Edit Channel Data

Important
• If you are editing items that must be compatible with Emerson DeltaV,
see Crucial Fields for the DeltaV Interface.
1. Do one of the following in the I/O Assignment window:
• Click Actions > Show I/O Data.
• Click .
2. To rename a control system tag, do the following:
a. Select the required row and click Edit CS Tag.
b. On the Control System Tag dialog box, type a new name as needed and click
OK.
3. To filter the display of data on the I/O Data dialog box, do the following:
a. Click Filter to open the Filter I/O Data dialog box.
b. In any data field, type the value according which to filter the channels on the
I/O Data dialog box.
Note that you can include any letter or number combination. You can include
letter or number combinations, as well as wildcards. For example, an
underscore (_) can substitute a single character and percent (%) can substitute
multiple characters. The search is not case-sensitive.
c. From the drop-down lists, select a value according which to filter the channels
on the I/O Data dialog box.

d. In the Show channels group box, choose a filtering option to determine which
channels to display on the I/O Data dialog box.
e. Select the Save check box to save the criteria specified for the next time you
open the I/O Data dialog box.
f. Click OK to accept your filter settings and return to the I/O Data dialog box.
4. To sort the displayed channels on the I/O Data dialog box, do the following:
a. Click Sort to open the Sort I/O Data dialog box.
b. In the Column Name list, select the column according which the channels
displayed on the I/O Data dialog box will be sorted.
c. Select Ascending to sort the channels displayed on the I/O Data dialog box in
ascending order; clear the check box to sort the channels in descending order.
d. To add a new sorting parameter, select an existing sorting parameter after
which you want to add the new sorting parameter and then click Insert.
e. To delete a sorting parameter, select the required sorting parameter and click
Delete.
f. Click Clear to discard all the sorting settings.
g. Select the Save check box if you want to save the current settings for the next
time you open the I/O Data dialog box. Note that deleting or clearing
parameters does not affect the sorting parameters that you have previously
saved (by selecting the Save check box).
h. Click OK to accept your settings and return to the I/O Data dialog box.
5. To print out the data on the I/O Data dialog box, click Report.
6. Click Close to return to the I/O Assignment window.
Notes
• If you open the I/O Assignment window without selecting anything in
the Domain Explorer, the I/O Data dialog box shows the control
system tags of the DCS/PLC cabinet you selected the last time you
opened the I/O Assignment window.
Related Topics

Find I/O Channels for Assignment

1. In the I/O Assignment window, do one of the following to open the Find
Channels dialog box:
• Click Actions > Find Channels.
• Click .
2. Under Search parameters, type values according to which SmartPlant
Instrumentation displays channels in the Search results data window. If you
leave a field blank, it will not limit the search. Leave all fields blank in order to
display all channels.
Tip
• You can include letter or number combinations, as well as wildcards.
For example, an underscore (_) can substitute a single character, and
percent (%) can substitute multiple characters. The search is not case-
sensitive.
3. Under Show channels, select one of the following search options:
• Spares only — show only spare channels in the Search results data
window.
• Exclude spares — do not display any spare channels in the Search
results data window.
• All — show all spare and assigned channels in the Search results
data window.
4. To save the current search parameters as the channel search default, select the
Save check box.
5. Click Find to search using the current settings.
6. In the Search results data window, select the I/O cards that you want to be
available in the I/O Assignment window, and click OK.
Tip
• If you select a channel rather than an I/O card, SmartPlant
Instrumentation displays the card to which the channel belongs in the
I/O Assignment window.
7. In the I/O Assignment window, under I/O card name, select the required card.
the software displays its channels in the Assignment details data window.
Related Topics

Control System Tag Propagation

Propagation of a signal along wires may vary according to whether a field device
exists and whether a tag number was assigned to an I/O channel. If the tag number
was assigned to an I/O device the cables connected to the I/O terminals are also
considered during the signal propagation. The method of propagating sequence
numbers (within a level) used by SmartPlant Instrumentation depends on whether a
field device is associated with that tag number, and whether the wiring routing is
complete (there is a signal continuity between the field device and the I/O channel).
Diagram key:
A — Field device without a channel.
B — Field device and Control System channel assigned without cables connected to
the Control System channel.
C — Field device and Control System channel assigned with cables. Wiring routing
is not completed.
D — Field device and Control System channel assigned. Wiring routing is

completed.
E — Control System channel assigned without a field device.

Cross Wiring
Cross wiring in SmartPlant Instrumentation allows you to connect two terminal strips
by using a cross-wiring cable. You can cross wire two terminal strips that belong to
two different panels or the same panel.
The following cross-wiring options are available:
• Manual Cross Wiring– This is the default cross wiring mode, where
you select the terminals on the strips to be cross-wired.
• Semiautomatic Cross Wiring– SmartPlant Instrumentation
automatically finds potential targets for the signal that it will
propagate. You can accept the suggested terminals and carry out the
cross wiring or select different terminals to be cross-wired.
• Automatic Cross Wiring– SmartPlant Instrumentation automatically
finds matching signals and performs the cross wiring for you.
Related Topics
• Cross Wiring Connections Common Tasks, page 564
Cross Wiring Connections Common Tasks

The following tasks are used frequently when you make cross wiring connections in
Perform Manual Cross Wiring

Manual cross wiring is the default mode for cross wiring. In this mode, you select the
terminals that you want to cross wire, select the required cross-wiring cable and then
carry out the cross wiring. For more information, see Perform Manual Cross Wiring,
page 566.
Perform Semiautomatic Cross Wiring

Semiautomatic cross wiring enables you to find matching signals between two
terminal strips (primary and secondary). That is, SmartPlant Instrumentation can find
for you a potential target for the signal that the software propagates after you perform
cross wiring. You can then use this potential target to quickly effect the required
cross wiring. The terminal that SmartPlant Instrumentation finds for you in the
secondary terminal strip is a recommendation only and you are free to accept it or
select a different terminal, as you require. For more information, see Perform
Semiautomatic Cross Wiring, page 568.

Perform Automatic Cross Wiring

Automatic cross wiring enables you to instruct SmartPlant Instrumentation to
automatically find matching signals for you and cross-wire the relevant terminals in a
single operation. Two signals match if:
• The signals are between two terminal strips belonging to the same
panel.
• Both signals are on the same signal level.
• The first signal comes to the first terminal from a device panel (the
signal sequence is less than 50) and the second signal comes from a
control system (the signal sequence is greater than 50.)
You can set the default definitions for matching signals by using the Preferences
dialog box.
For more information, see Perform Automatic Cross Wiring, page 571.
Set Cross Wiring Preferences

This procedure explains how to create a new cross-wiring cable and use it in your
current cross wiring operation. If you do not want to create your own cross-wing
cables and let SmartPlant Instrumentation create a cable for you, in the Cross Wiring
window, select CROSS WIRE from the Cross-wiring cable list. For more
information, see Set Cross Wiring Preferences, page 570.
Generate a Panel Strip Report from the Cross Wiring Window

This option enables you to generate a panel – strip report that displays the
connections and adjacent connections for the terminal strip you selected from the
Primary terminal strip list in the Cross Wiring window. For more information, see
Generate a Panel Strip Report from the Cross Wiring Window, page 574.
Related Topics
• Cross Wiring: An Overview, page 564

Perform Manual Cross Wiring

1. Press F7 open the Domain Explorer and select one or more terminal strips for
potential cross wiring. You can also select a panel or several panels if required.
2. Right-click the items you selected and then on the shortcut menu, click Actions >
Cross Wiring.
3. In the Cross Wiring window, select the required terminal strip from the Primary
terminal strip list.
Tip
• To add terminal strips that do not appear on the list, click beside the
Primary terminal strip list arrow, select the required terminal strips
in the Domain Explorer, then click OK to add them to the Primary
4. Under Primary connection side, click Left or Right to select the appropriate
side of the secondary terminal s trip that you want to connect.
Tip
• This option is not available if the current secondary terminal strip is a
terminal strip with channels (belonging to a DCS or PLC panel). In
this case, you can connect the left side only.
5. From the Secondary terminal strip list, select the required terminal strip that you
want to cross wire.
Tip
• To cross wire two terminal strips belonging to different panels where
you did not select one of the panels in Cross Wiring, click beside
the Secondary terminal strip list arrow, select the required terminal
strip in the Domain Explorer and click OK to add it to the Secondary
terminal strip list. Then, select that terminal strip from the
Secondary terminal strip list for cross wiring.
6. Under Secondary connection side, click Left or Right to select the appropriate
side of the secondary terminal strip that you want to connect.
Tip

7. From the Cross-wiring cable list, select one of the following to define a cross-
wiring cable:
• Select CROSS WIRE to cross wire the terminals with wires that the
software creates during the cross-wiring process.
• Select the required cross-wiring cable. If the cross wiring cable that
you need is not on this list, click beside the list arrow to open the
Wiring Explorer. Select a cable and click OK to add it to the list.
Note that you can also create a new cross wiring cable if the one you
need does not exist in the Domain Explorer.
8. Select the Prompt for cross operation message check box to be prompted by
SmartPlant Instrumentation to confirm the cross wiring. If you do not select this
check box, cross wiring of the selected terminals proceeds without messages and
SmartPlant Instrumentation propagates all the existing signals.
9. In the Primary Terminal Strip pane, click the required terminal to be cross-
wired.
10. In the Secondary Terminal Strip pane, click the required terminal to be cross-
wired.
11. If you selected the Prompt for cross operation message check box, click Yes to
confirm the cross wiring.
Notes
• For an example and information about the conventions used to
represent various items and connections in the Cross Wiring window,
click the Help icon on the main toolbar and then click the required link
at the bottom of the help page.
• In the Primary Terminal Strip pane, select the required cross-wired
terminal, and then click to open the Point-to-Point Wiring
Diagram.
• Click to open the Terminal Connection window. You can also
double click to get the same result.
• Click to remove the cross wiring between two terminals after
selecting the cross-wired terminals (shown connected by a solid black
line).
• Click to generate a report that shows all the wiring connections of
the primary strip on both sides.

Perform Semiautomatic Cross Wiring

2. Do one of the following to open the Cross Wiring window:
• Click Actions > Cross Wiring.
• Click
Tip
want to cross wire.
Tip
you did not select one of the panels in Domain Explorer, click
beside the Secondary terminal strip list arrow, select the required
terminal strip in the Domain Explorer and click OK to add it to the
Secondary terminal strip list. Then, select that terminal strip from
the Secondary terminal strip list for cross wiring.
Tip
wiring cable:
Domain Explorer. Select a cable and click OK to add it to the list.

8. In the Primary Terminal Strip pane, click the required terminal to be cross-
wired.
9. Do one of the following to find a matching target signal for potential cross wiring:
• Click View > Target Signal.
• Click .
SmartPlant Instrumentation searches for a matching signal in the
current <plant> and adds the terminals that it finds in the Secondary
Terminal Strip pane. SmartPlant Instrumentation indicates each of
the potential terminals by placing an arrow beside it in the
Secondary Terminal Strip pane.
10. Select the required terminal in the Secondary Terminal Strip pane to cross wire
with the selected terminal in the primary terminal strip.
Notes
Diagram.
line).
Related Topics

Set Cross Wiring Preferences

2. Expand the Wiring hierarchy in the tree view and select Cross Wiring.
3. Under Automatic cross wiring, select one of the following options:
• Different strips, same panel— Automatically cross-wires two
signals between two different strips belonging to the same panel (this
is the default selection).
• Different panels (no DCS or PLC panels)— Automatically cross-
wires 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) — Automatically cross-wires 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.
4. From the Default wire color list select the required wire color. Selecting a
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.
5. Click OK.
Related Topics

Perform Automatic Cross Wiring

Important
• You can set the default definitions for matching signals by using the
Preferences dialog box. For details, see Set Cross Wiring
Preferences, page 570.
2. Do one of the following to open the Cross Wiring window:
• Click Actions > Cross Wiring.
• Click
Tip
4. Under Primary auto cross-wiring side, click Left or Right to select the
appropriate side of the primary terminal strip that you want to connect.
want to cross wire.
Tip
you did not select one of the panels in Domain Explorer, click
beside the Secondary terminal strip list arrow, select the required
terminal strip in the Domain Explorer and click OK to add it to the
Secondary terminal strip list. Then, select that terminal strip from
the Secondary terminal strip list for cross wiring.
Tip

wiring cable:
Domain Explorer. Select a cable and click OK to add it to the list.
9. Do one of the following to find matching signals:
• Click Actions > Auto
• Click .
SmartPlant Instrumentation finds and selects the matching signals and
the terminals that it can cross-wire automatically. The Secondary
Terminal Strip pane does not appear in the Cross Wiring window.
• Click to cross wire the selected terminals. SmartPlant

Instrumentation replaces the selection with a solid black line indicating
that the cross wiring has been done.
• Click to discard the selection made by the software and return to
manual mode.

11. After the software cross wired the terminals, click to return to manual mode.
Notes
Diagram.
line).
Related Topics
Create a Cross Wiring Cable

1. In the Cross Wiring window, click beside the Cross-wiring cable list arrow
to open the Domain Explorer.
2. Right-click the Cross Cables folder, and on the shortcut menu, click New >
Cross Cable.
3. In the Cable Properties dialog box, enter the required values and then click OK.
4. Select the new cable in the Domain Explorer and click OK to add this cable to
the Cross-wiring cable list.
5. Select the new cable in the Cross-wiring cable list to be used in the cross wiring
operation.
Related Topics

Generate a Panel Strip Report from the Cross Wiring

Window
1. Do one of the following in the Cross Wiring window:
• Click Reports > Panel-Strip.
• Click on the module toolbar.
2. Click Yes to open the print preview or click No to print the report without
displaying it on your screen.
Related Topics

Auto-Wiring
Auto-wiring allows you to make automatic batch connections between specified
terminal strips. This feature facilitates faster and more efficient wiring design
especially when working on a grass-root project where the required wiring items
already exist and you need to connect them. The essence of this feature is that you
create an auto-wiring routing task where you define a cable that will connect two
designated panels.
You can define an auto-wiring task for two different kinds of connection:
• A connection between two existing panels.

• A connection between a panel and a control system that will create
cross wires or cross cables.
There are two prerequisites for auto-wiring routing tasks:
• The required panels and terminal strips must already exist.

• The required reference cables and connection types must be defined
and ready for use.
Furthermore, for cross wiring auto-wiring routing tasks, you must also ensure the
following before you start defining your task:
• The required instrument tags and their device panels already exist and
they are connected to their junction boxes.
• There are instrument tags with pre-assigned I/O points – essential for
cross-wiring tasks.
• There are defined reference wiring profiles for the required instrument
types.
Notes
• For details about various auto-wiring tasks, see Defining and
Executing Auto-Wiring Tasks: An Overview, page 576.
• You cannot create an auto-wiring task for panels that are defined as
Fieldbus or Telecom panels.
Related Topics
• Auto-Wiring Connections Common Tasks, page 579
• Defining and Executing Auto-Wiring Tasks: An Overview, page 576

Defining and Executing Auto-Wiring Tasks: An

Overview
An auto-wiring task is a list of commands that SmartPlant Instrumentation runs
according to pre-selected parameters. You define the End 1 and End 2 connections as
well as the cable that SmartPlant Instrumentation uses to make the connection. The
cable that the software uses to make the connection is automatically created by the
software. The definition of this cable is based on the reference cable that you select.
The software checks whether a cable based on the selected reference cable exists in
the Domain Explorer and whether this cable has a sufficient number of unconnected
cable sets. If not, SmartPlant Instrumentation creates a new cable based on the
selected reference cable to accommodate the required connections. You can
customize the cable name as needed or accept the suggested names. The software
proposes cable end names based on the names of the panels to be connected to End 1
and End 2. Any additional cables that the software creates have identical names with
a numeric suffix that is incremented by one for each new cable; for example XYZ.1,
XYZ.2, and so forth.
You can define the following auto-wiring tasks:
• Connecting two junction boxes or marshaling racks— When

defining an auto-wiring task for two junction boxes, you need to define
the End 1 and End 2 connections as well as the cable that SmartPlant
Instrumentation uses to connect the two panels.
• Connecting a junction box or a marshaling rack to a control
system — When defining this kind of auto-wiring task, you define
the End 1 connection and the auto-wiring cable. The End 2 connection
options are not available as SmartPlant Instrumentation checks for
available DCS or PLC panels with matching signals. This means that
you have to pre-assign the required control system tags to the tag
numbers (for details, see I/O Assignment: An Overview, page 545). At
this point, you also need to select an appropriate cross wiring option to
connect the control system. After the software executes the task, open
the Connection window for the selected junction box and display the
adjacent connection to make sure that the software has executed the
auto-wiring task correctly.
• Connecting a pre-assigned junction box to another junction box or
a control system— In this case, you need to make sure that you have
carried out the required I/O assignment for the control system you are
going to connect and that you pre-assigned the necessary junction box
and its terminal strip to the required field device. Then, you proceed
to define the End 2 connection or select to connect the pre-assigned
junction box to a control system.

Note that you define and execute auto-wiring tasks in the Auto-Wiring Browser
View window.
For detailed description of the various procedures, see Auto-Wiring Connections


Flow of Activities for Auto-Wiring

The following is a suggested flow of auto-wiring activities. The sequence in which
you perform these activities depends on your work preferences. In any case, make
sure that you perform the first four steps in the following list before proceeding
further.
1. Define a view profile for a new Auto-Wiring Routing Task browser in the
Wiring group of the Browser Manager. For details, see Define a View Profile,
page 264.
2. Add and define a new view for the Auto-Wiring Routing Task browser. For
details, see Add a New View, page 265.
3. If needed, define a view profile for the JB Pre-Assignment browser in the
Instrument Index group of the Browser Manager and then add and define a
new view for the JB Pre-Assignment browser.
4. Pre-assign the required junction boxes to tag numbers. For details, see Pre-Assign
Junction Boxes to Device Panels, page 580.
5. Connect the junction boxes to the device panels using one of the following
methods:
• Use the Device Cable Batch Connection feature. For details, see
Connect Device Cables to a Terminal Strip in Batch Mode, page 532.
• Execute the auto-wiring routing task. For details, see Defining and
Executing Auto-Wiring Tasks: An Overview, page 576.
• Connect the junction boxes manually.
6. Continue connecting the rest of the junction boxes.
7. Create and run a new auto-wiring routing task to connect the last junction box to
the control system (or another type of panel).
Related Topics
• Auto-Wiring: An Overview, page 575

Auto-Wiring Connections Common Tasks

The following tasks are used frequently when you make connections in SmartPlant
Instrumentation.

This pre-assignment makes it possible to define an Auto-Wiring routing task. For
details, see Pre-Assign Junction Boxes to Device Panels, page 580.
Auto-Wire Pre-Assigned Junction Boxes

This procedure explains how to define and execute an auto-wiring task for a pre-
assigned junction box. Note that you must pre-assign the required junction box and
make all the required preparations prior to defining and executing a task. For more
information, see Auto-Wire Pre-Assigned Junction Boxes, page 581.
Auto-Wire Two Panels

This procedure explains how to define and execute an auto-wiring task for two panels
(regardless of their signals). Note that you must make all the required preparations
prior to defining and executing a task. For more information, see Auto-Wire Two
Panels, page 583.
Auto-Wire Control Systems

You use this procedure to define and execute an auto-wiring task for a control system.
Note that prior to defining such a task, you must assign the required control system
I/O channels to specific tag numbers. For more information, see Auto-Wire Control
Systems, page 585.
Auto-Wire Control Systems Connected to Pre-Assigned Junction Boxes

This procedure explains how to define and execute an auto-wiring task for a control
system that is to be connected to a pre-assigned junction box. Note that prior to
defining such a task, you must assign the required control system to specific tag
numbers. For more information, see Auto-Wire Control Systems Connected to Pre-
Assigned Junction Boxes, page 587.
Change an Auto-Wiring Task Status

After you define an auto-wiring task, SmartPlant Instrumentation assigns it a status.
Tasks can have different statuses that are set according to the task definitions. You
can change certain task statuses if needed. For more information, see Change an
Auto-Wiring Task Status, page 590.
Related Topics
• Flow of Activities for Auto-Wiring, page 578


1. On the main toolbar, click to open the Browse Manager.
2. Expand the Instrument Index browser group.
Tip
• You can also click on the Auto-Wiring Browser View toolbar to

open the JB Pre-Assignment Browser View window.
3. Select the JB Pre-assignment browser and add a new browser view to this
browser.
Important
• Make sure that you select the Set as default view check box if you
want to use the new browser view for auto-wiring.
4. Click to open the new view.
5. In the Browser View window, highlight the required tag number to which you
want to assign a junction box.
6. Click in the Junction Box Name field and select an appropriate junction box that
will be pre-assigned to the highlighted instrument tag.
Tip
• If a junction box has already been connected to a device panel, the
Junction Box Name field displays the name of the connected junction
box and you cannot rename the junction box here.
7. Click in the Strip Name field and select the required strip in the pre-assigned
junction box.
8. Repeat steps 5 through 7 for each device panel to which you want to pre-assign a
junction box.
9. Edit the data in the Browser View window as required and close the Browser
View window. Save the data when prompted.
Notes
• You can now select the appropriate junction boxes and perform batch
connection of device cables in the Batch Device Cable Connection
window.
• You can define an Auto-Wiring routing task.
• You can filter the display of device cables in the Domain Explorer.
For details, see Define a Filter for Pre-Assigned Device Cables, page
244.
Related Topics

Auto-Wire Pre-Assigned Junction Boxes

Important
• You must pre-assign the required junction boxes and make all the
required preparations prior to defining and executing a task. For
1. Start the Wiring module.
2. On the menu bar, click Actions > Auto-Wiring.
3. In the Browser View - New Auto-Wiring Routing Task window, select the new
task and do one of the following:
• Click Actions > Edit Task.
• Click .
Tip
• The Auto-Wiring Routing Task dialog box opens where all the End
1 connection properties except for the Connection type and Overall
shield terminal connection have been defined. You can accept the
displayed values or modify them as needed.
4. On the Auto-Wiring Routing Task dialog box, complete the End 1 connection
definition as follows:
a. Select the required connection type from Connection type list.
b. If required, select the appropriate overall shield terminal connection.
5. In the End 2 connection group box, select one of the following options:
• Select the Control system check box if you want to connect the pre-
assigned junction box to a DCS or PLC cabinet.
• Do not select the Control system check box to connect the pre-
assigned junction box to another junction box or marshaling rack.
6. If you did not select the Control system check box, define the end 2 connection
of the auto-wiring cable as follows:
a. Click next to the Panel field to select the required panel.
b. In the Domain Explorer, select a panel that contains at least one terminal
strip with unconnected terminals and then click OK.
c. Select a terminal strip from the Strip list.
d. Select a terminal that will serve as the first terminal.
e. Select a terminal side.
f. Select a connection type.

g. If required, select an appropriate overall shield terminal connection.

7. Use the options in the Cable group box to define the cable that SmartPlant
Instrumentation will use to connect the two panels:
a. From the Reference cable list, select the appropriate reference cable that
SmartPlant Instrumentation will use as the source for the creation of a cable
that will connect the two panels. The software duplicates the new cable in the
Domain Explorer.
b. In the Cable name data field, accept or type the name of the cable that
SmartPlant Instrumentation will create to connect the two panels. The cable
names suggested by the software are composed of the End 1 and End 2 panel
names. Additional cables have their names incremented by one, for example
XYZ.1, XYZ.2, and so forth.
8. Click OK to complete the task definition and return to the Auto-Wiring Browser
View - New Auto-Wiring Routing Task window.
9. In the Browser View - New Auto-Wiring Routing Task window, click .
Notes
• After notifying you that the task has been executed successfully, the
task status changes to Done. For details, see Auto-Wiring Task
Statuses, page 590.
• You can open the Connection window for the selected junction box to
display the adjacent connection to make sure that the auto-wiring task
has been executed correctly.
Related Topics

Auto-Wire Two Panels

Important
• Make sure that you have made all the required preparations that are
specified in Auto-Wiring: An Overview, page 575.
• Click Actions > New.
• Click .
4. On the Auto-Wiring Routing Task dialog box, define the End 1 connection as
follows:
5. In the End 2 connection group box, do the following:

6. Use the options in the Cable group box to define the cable that SmartPlant
Instrumentation will use to connect the two panels:
a. From the Reference cable list, select the appropriate reference cable that
SmartPlant Instrumentation will use as the source for the creation of a cable
that will connect the two panels. The software duplicates the new cable in the
Domain Explorer.
b. In the Cable name data field, accept or type the name of the cable that
SmartPlant Instrumentation will create to connect the two panels. The cable
names suggested by the software are composed of the End 1 and End 2 panel
names. Additional cables have their names incremented by one, for example
XYZ.1, XYZ.2, and so forth.
7. Click OK to complete the task definition and return to the Auto-Wiring Browser
View - New Auto-Wiring Routing Task window.
8. In the Browser View - New Auto-Wiring Routing Task window, click .
Notes
Statuses, page 590.
Related Topics

Auto-Wire Control Systems

Important
• Prior to defining such an auto-wiring task for a control system, you
must assign the required control system I/O channels to specific tag
numbers. For details, see I/O Assignment: An Overview, page 545.
• For auto-wiring tasks that connect pre-assigned junction boxes to
control systems, see Auto-Wire Control Systems Connected to Pre-
Assigned Junction Boxes, page 587.
• Click Actions > New.
• Click .
4. On the Auto-Wiring Routing Task dialog box, define the End 1 connection as
follows:
5. In the End 2 connection group box, select the Control system check box.
Tip
• Selecting the Control system check box disables all the options in the
End 2 connection group box (except for Connection type) so that
SmartPlant Instrumentation can search for an available DCS or PLC
panel with a matching signal.
6. From the Connection type list, select the required End 2 connection type.

7. In the Cross wiring group box, select an appropriate cross wiring option to
connect the control system to the junction box:
• Single cross wires– connects the control system using a single wire
created by SmartPlant Instrumentation automatically during the auto-
wiring process.
• Cables created from reference – connects the control system using
a cable that SmartPlant Instrumentation creates by duplicating the
reference cable that you select from the Reference cable list in the
Cable group box. The software checks whether such a cable exists in
the Domain Explorer and if so, whether this cable is connected to the
panel selected in the End 1 connection group box. If this cable has
unconnected cable sets, the software connects them and then creates
additional cables so that all the terminals are connected. Note that in
this case, the software connects all the cable sets whether they are
required or not. Therefore, for this option to work properly, you must
create appropriate reference cables and connection types before
starting auto-wiring.
• One cable per tag – connects the control system using a separate
cable for each tag number. The software creates each cable by
duplicating the reference cable that you select from the Reference
cable list in the Cable group box. SmartPlant Instrumentation creates
the required number of cables according to the number of tag signals it
detects. The software names each cable according to the signal name.
You can add a prefix and a suffix to the cable name by typing the
required string in the Cable name prefix and Cable name suffix
fields.
8. Use the options in the Cable group box to define the cable for connecting the pre-
assigned junction box to the control system (not available if you selected the
Single cross wires option):
a. From the Reference cable list, select an appropriate reference cable that
SmartPlant Instrumentation uses as a source for the creation of a cable that
will connect the two panels. The software duplicates the new cable in the
Domain Explorer.
b. In the Cable name data field, the software suggests a cable name composed
of the End 1 and End 2 panel names. Accept this name or type a name of your
choice for the cable that SmartPlant Instrumentation will create to connect the
two panels. Any additional cables that the software creates have identical
names with a numeric suffix that is incremented by one for each new cable;
for example XYZ.1, XYZ.2, and so forth.
9. Click OK to complete the task definition and return to the Browser View - New
Auto-Wiring Routing Task window.

10. Click .
Notes
Statuses, page 590.
Related Topics
Auto-Wire Control Systems Connected to Pre-Assigned

Junction Boxes
Important
• You must pre-assign the required junction boxes and make all the
required preparations prior to defining and executing a task. For
• Assign the required control system I/O channels to specific tag
numbers. For details, see I/O Assignment: An Overview, page 545.
• For auto-wiring tasks involving a connection to a junction box that has
not been pre-assigned, see Auto-Wire Control Systems, page 585.
• Click Actions > Edit Task.
• Click .
Tip
• The Auto-Wiring Routing Task dialog box opens where all the End
1 connection properties except for the Connection type and Overall
shield terminal connection have been defined. You can accept the
displayed values or modify them as needed.

4. On the Auto-Wiring Routing Task dialog box, complete the End 1 connection
definition as follows:
a. Select the required connection type from Connection type list.
b. If required, select the appropriate overall shield terminal connection.
5. In the End 2 connection group box, select the Control system check box.
Tip
• Selecting the Control system check box disables all the options in the
End 2 connection group box (except for Connection type) so that
SmartPlant Instrumentation can search for an available DCS or PLC
panel with a matching signal.
6. From the Connection type list, select the required End 2 connection type.
7. In the Cross wiring group box, select an appropriate cross wiring option to
connect the control system to the junction box:
• Single cross wires– connects the control system using a single wire
created by SmartPlant Instrumentation automatically during the auto-
wiring process.
• Cables created from reference – connects the control system using
a cable that SmartPlant Instrumentation creates by duplicating the
reference cable that you select from the Reference cable list in the
Cable group box. The software checks whether such a cable exists in
the Domain Explorer and if so, whether this cable is connected to the
panel selected in the End 1 connection group box. If this cable has
unconnected cable sets, the software connects them and then creates
additional cables so that all the terminals are connected. Note that in
this case, the software connects all the cable sets whether they are
required or not. Therefore, for this option to work properly, you must
create appropriate reference cables and connection types before
starting auto-wiring.
• One cable per tag – connects the control system using a separate
cable for each tag number. The software creates each cable by
duplicating the reference cable that you select from the Reference
cable list in the Cable group box. SmartPlant Instrumentation creates
the required number of cables according to the number of tag signals it
detects. The software names each cable according to the signal name.
You can add a prefix and a suffix to the cable name by typing the
required string in the Cable name prefix and Cable name suffix
fields.

8. Use the options in the Cable group box to define the cable for connecting the pre-
assigned junction box to the control system (not available if you selected the
Single cross wires option):
a. From the Reference cable list, select an appropriate reference cable that
SmartPlant Instrumentation uses as a source for the creation of a cable that
will connect the two panels. The software duplicates the new cable in the
Domain Explorer.
b. In the Cable name data field, the software suggests a cable name composed
of the End 1 and End 2 panel names. Accept this name or type a name of your
choice for the cable that SmartPlant Instrumentation will create to connect the
two panels. Any additional cables that the software creates have identical
names with a numeric suffix that is incremented by one for each new cable;
for example XYZ.1, XYZ.2, and so forth.
9. Click OK to complete the task definition and return to the Browser View - New
Auto-Wiring Routing Task window.
10. Click .
Notes
Statuses, page 590.
Related Topics

Auto-Wiring Task Statuses

After you define an auto-wiring task, SmartPlant Instrumentation assigns it a status.
Tasks can have different statuses that are set according to the task definitions. You
can change certain task statuses if needed.
The following table defines the various task statuses and explains which statuses you
can change.
Status Description Can Be

Changed To
New A newly created task that has not yet been Hold
executed.
Hold A task that has been put on hold. Execute
This task cannot be executed until you change its
status to Execute.
Execute A task whose status has been changed from Hold. Cannot be
This task can be executed. changed
Done A task that has already been executed. Cannot be
Such a task cannot be executed again. changed
Related Topics
Change an Auto-Wiring Task Status

1. In the Auto-Wiring Browser View window, right-click a task.
2. On the shortcut menu, click Task Status.
3. Click the option that you require.
Related Topics

Signal Propagation
Signal propagation is a method used in SmartPlant Instrumentation to associate wires
with instruments. A signal or a tag signal is a software identifier that is associated
with a particular instrument tag, and is generated in a device panel or locally within
other types of panels. A tag signal can also be created as a result of I/O assignment.
When you connect or disconnect a cable, cable set, or wire, SmartPlant

Instrumentation automatically updates the wire tags and the signals that are carried by
the wires. Tag signal propagation takes place automatically, with consequent
updating of wire names, and signal sequences. Signal sequence values are sequential
numbers assigned consistently to all of the wires within a given wire group along the
signal path of the wire group. Automatic tag signal propagation also takes place after
you effect I/O assignment. For details of various tag signal propagation results, see
Possible Cases of Signal Propagation, page 592.
However, there may be situations in which tag signal propagation does not occur
automatically. In this case, SmartPlant Instrumentation offers you the two options for
semiautomatic propagation of a selected tag signal. You can re-propagating a tag
signal or force tag signal propagation. For details, see Tag Signal Propagation
Also, you can effect signal propagation at terminal strip level by manually entering or
changing a signal or its level at any point along the wiring path.
Tips
• Unlike wires, jumpers do not propagate signals. You can assign a wire
group to a jumper manually on the Terminal Connection dialog box.
• Tag signal propagation for a shield takes place automatically without
having to connect that shield to a device panel terminal.
• Tag signal propagation stops if it reaches a point where multiple
optional paths exist.
• You can re-propagate or force propagation of tag signals if required.
• You can intervene at any point of the wire path and change tag number
propagation manually.
You can generate a point-to-point wiring diagram and view the signal path after you
finish assigning an instrument tag to a channel in an I/O card. For information about
point-to-point diagrams, see Trace a Signal in a Point-to-Point Wiring Diagram, page
543.
Related Topics
• Tag Signal Propagation Common Tasks, page 594
• Trace a Signal in a Point-to-Point Wiring Diagram, page 543

Possible Cases of Signal Propagation

After you effect I/O assignment, the software automatically propagates the tag
signals. Four situations can exist:
Case 1
In this example, the signal sequence is from the device panel up to the PLC cabinet
with all the wiring:
Case 2
In this case the connection sequence starts from the device panel and continues to the
PLC cabinet, however, there is a discontinuity between Strip 1 and Strip 2 of the
marshaling rack:
Note that the wiring sequence can be different depending on the completeness of the
connection:
• From 1 to 8 (as in the first case) — connected from the device panel
to the PLC.
• From 1 to 4 and from 99 to 100 (as in the second case) — there is a
break in the middle of the connection.

Case 3
The signal sequence is from the device panel to the PLC cabinet however, there is a
discontinuity between the marshaling rack and the PLC cabinet.
Case 4
The connection sequence starts from the PLC cabinet and continues to the junction
box. The device panel is absent.
Related Topics

Tag Signal Propagation Common Tasks

The following tasks are used frequently when you work with signals in SmartPlant
Instrumentation.
Re-Propagate a Tag Signal

You use this feature when the software does not fully complete the automatic
propagation of a tag signal. This procedure explains how to propagate a tag signal
from a selected device panel, through all the connected cables and panels, until it
encounters a different signal. After it encounters a different signal, the software does
not make any further changes in the propagation. For details, see Re-Propagate a
Tag Signal, page 596.
Force Signal Propagation

You use this feature when the software does not fully complete the propagation of a
tag signal automatically. This procedure explains how to force the propagation of a
tag signal from a selected device panel, through all the connected cables and panels
so that the re-propagated signal overrides all the existing signals that it encounters.
For details, see Force Signal Propagation, page 596.
Propagate a Tag Signal Manually

During your wiring design, situations can arise in which the propagation of a tag
signal does not occur automatically. SmartPlant Instrumentation lets you effect
signal propagation at terminal strip level by manually entering or changing a signal or
its level at any point along the wiring path. You need to propagate tag signals
manually when:
• There is a split in the wiring path.

• There are terminal strips that emulate barriers.
• You cross-wire two terminals, one of which already receives a signal.
• You remove a signal that is stopping tag signal propagation.
• You add another signal level at an exit point of one of the terminal
strips.
For more information, see Propagate a Tag Signal Manually, page 597.

Automatically Propagate a Signal from a Non-Wiring Instrument

This feature makes it possible to associate a conventional or electrical non-wiring
instrument with a connected wire, cable set, or cable. Dragging such an instrument
from the Instruments folder of the Domain Explorer to a connected wire, cable set,
or cable in the Connection window automatically creates a signal from that
instrument and propagates this signal along the connected wiring path. Note that non-
wiring instruments are instruments that were created based on instrument type
profiles that have no wiring. For details, see Automatically Propagate a Signal from
a Non-Wiring Instrument, page 598.
Create a Local Tag Signal

A local signal is a user-defined signal that does not originate from a device panel or
an I/O channel. You create a local signal within any other kind of panel. For
example, in an instrumentation electrical interface cabinet, a local signal starts at a
terminal relay or in a junction box, it starts at a terminal strip. Note that you can
apply tag signals (level and sequence) to wires when no device panel is connected.
You can use local signals as follows:
• You can create a local tag signal by assigning a local signal to a wiring
tag that does not yet have a signal of its own.
• You can create a general signal and link it to the signals that are wired
into the terminal strip.
For more information, see Create a Local Tag Signal, page 599.
Filter the Local Signal Dialog Box

This procedure enables you to filter the data window in the Local Signal dialog box
determining the tag numbers that SmartPlant Instrumentation displays in the Tag
Number column. This makes it easier to select the tag numbers that you can assign
to local signals. For more information, see Filter the Local Signal Dialog Box, page
599.
Create a General Signal

A general signal is a user-defined signal which is not characterized by any existing
process function and which does not carry any information from an instrument. You
link a general signal with tag signals and other general signals. You can use a
general signal to treat several tag signals as a group that share common wires. You
can use general signals for the following purposes:
• Combine signals into a wire group for transmitting multiple signals

that are multiplexed or de-multiplexed through it.
• Represent the common connection for single or multiple loop power
supply.
For more information, see Create a General Signal, page 600.

Link Tag Signals to a General Signal

This procedure allows you to link tag signals to a general signal that you create on a
given strip. You need this functionality to:
• Use a power supply to power tag signal circuits.

• Multiplex tag signals into a general signal.
• Recombine tag signals that you previously multiplexed.
For more information, see Link Tag Signals to a General Signal, page 601.
Multiplex Tag Signals

SmartPlant Instrumentation enables you to multiplex tag signals. That is, you can
combine tag signals into a general signal that you propagate. Also, you can combine
signals from incoming general signals with independent tag signals into a new general
signal that you propagate. For more information, see Multiplex Tag Signals, page
602.
De-Multiplex Tag Signals

SmartPlant Instrumentation enables you to separate tag signals from a general signal.
This is called de-multiplexing. Then, you can propagate the independent signals
manually. For more information, see De-Multiplex Tag Signals, page 603.
Related Topics
• Possible Cases of Signal Propagation, page 592
Re-Propagate a Tag Signal

2. Right-click a device panel from which a signal originates.
3. On the shortcut menu, click Actions > Re-Propagate Signal.
Related Topics
Force Signal Propagation

2. Right-click a device panel from which a signal originates.
3. On the shortcut menu, click Actions > Force Signal Propagation.

Propagate a Tag Signal Manually

• In the Connection window, from the Terminal Strip list, select the
terminal strip for which you want to effect signal propagation
manually.
• In the Cross Wiring window, from the Primary terminal strip list,
select the terminal strip for which you want to effect signal
propagation manually.
2. Double-click next to the required wired terminal.
3. On the Terminal Connection dialog box, under Signal, click and then select
from the list the signal that you want to propagate.
4. Under Signal Level, click and select from the list, a value for the signal level.
Tip
• You can also select zero to indicate that a signal does not have a signal
level setting. This means that all the wires in the current wire group
are propagated on the same level.
5. Under Sequence, click and select from the list a connection sequence.
6. Click Save to propagate the signal.
7. To navigate to other terminals for which you need to change propagation settings,
• Click Next or Previous.
• Under Terminal number, select a terminal that you require.
Notes
• Repeat the above procedure for each terminal strip that requires
manual signal propagation.
• If you remove a signal at any point of the wiring path, SmartPlant
Instrumentation stops the signal propagation at that point. However, if
there is an I/O card at the other end of that signal path, the SmartPlant
Instrumentation stops the tag signal propagation at the break point and
assigns a new connection sequence (100, 99, 98 …) starting from the
I/O card.
• If you replace one signal with another at any point along the wiring
path, the software stops the propagation of the old signal at the point
where you made the change and propagates a new signal from that
point onward to the end of the signal path.
Related Topics

Automatically Propagate a Signal from a Non-Wiring

Instrument
1. In the Instruments folder of the Domain Explorer, select a conventional or
electrical non-wiring instrument.
Tip
• Non-wiring instruments are instruments that were created based on
instrument type profiles that have no wiring or control system
selections but have the Include wiring check box selected.
2. Drag the selected instrument to a connected wire, cable set or cable in the
Connection window.
Notes
• SmartPlant Instrumentation propagates a signal from the selected
instrument along the wiring path based on whether you drag the
instrument to a cable, cable set or wire:
• Dragging an instrument to a cable or a cable set — a signal will be
propagated through each of the wires of the cable or the cable set.
Each wire will get a different signal level.
• Dragging an instrument to a single wire — a signal will be
propagated only through that wire.
• If the current panel in the Connection window is a device panel, the
software associates the instrument with the target device panel.
• If the target wires already carry other signals, the software stops these
signals and propagates new ones instead.
• The software automatically updates the signal levels based on whether
you dragged the instrument to a single wire, a cable, or a cable set.
The signal will start at level one and sequence one. However, if level
one and sequence one are occupied, the software will automatically
look for the next available signal level and sequence.
Related Topics

Create a Local Tag Signal

• In the Connection window, click Actions > Local Signal.
• In the Connection window, click
• On the Terminal Connection dialog box, click Signal.
2. On the Local Signal dialog box, select a wiring tag that has not been associated
with a signal (that is, a tag that has no signal name next to it.)
3. Click Create.
4. Click Close to create and propagate the new local tag signal.
Notes
• All propagation rules apply to local tag signals.
• For cross wiring with independent wiring from the local terminal strip
and I/O card ends, create local tag signals before assigning I/O
channels.
• You can apply tag signals (level and sequence) to wires when no
device panel is connected.
Related Topics
Filter the Local Signal Dialog Box

1. On the Local Signal dialog box, click Filter to open the Signal Filter dialog box.
2. Define a conditional expression as follows:
a. From the Column Name list, select the appropriate tag number attribute
according to which you want to filter the data.
b. From the Operator list, select the required comparison operator to determine
how the tag number attribute selected in the Column Name field will relate to
the expression you enter in the Value field.
c. From the Value data list, select or type the required value to determine how
the tag number attribute selected in the Column Name field will be specified.
You can use wildcards such as % (percent) and _ (underscore) to set the value.
d. From the Logical list, select the required logical operator to determine how
the next filter expression will relate to the current one (if applicable).

3. Click New to add another data row for an additional filter expression if needed.
Make sure you select the appropriate logical operator (And, Or) at the end of the
previous row.
4. To retrieve tag numbers that were imported from SmartPlant Electrical, select
SmartPlant Electrical signals only.
5. To retrieve tag numbers that were imported from SmartPlant Electrical and that
already have an association with a specified power distribution board (PDB) in
SmartPlant Electrical, select Pre-assigned signals only. This option is available
only when you select SmartPlant Electrical signals only.
6. To save the filter condition settings so that the next time you open the Signal
dialog box SmartPlant Instrumentation filters the data accordingly, select Save
filter.
Tip
• Click Restore to revert to the filter condition that you saved the last
time.
7. Click Verify to check the correctness of your filter.
8. Click OK.
Related Topics
Create a General Signal

2. On the Local Signal dialog box, under General signal, click New in the group
box.
3. On the New General Signal dialog box, under Signal name, type a unique name.
4. To associate the new general signal with all the tag signals in the current terminal
strip, select Apply to all tag signals of the current strip.
5. Click OK to create and propagate the new general signal.

Notes
• The new general signal name appears in the Signal column with no tag
next to it. This indicates that this is a general signal that originated in
the current terminal strip.
• You can change the general signal name at any time by clicking Edit
after selecting the required general signal.
• If this general signal is used in a loop drawing, make sure that the
general signal name is changed in the loop macro definitions too.
Related Topics
Link Tag Signals to a General Signal

2. On the Local Signal dialog box, under Signal, select the general signal to which
you want to link tag signals.
3. Click Link.
4. On the Link Tag Signals to General Signal dialog box, under Link, select the
check boxes for the tag signals that you want to link to the general signal.
5. Click Close to return to the Local Signal dialog box.
Note
• Since a general signal does not directly connect to a tag, you need a
different way to find the data for the signal's tag numbers. In the
drawing block, the macros (tags / attributes) that contain the data for
these signals should start with a prefix that reflects the name of the
signal.
Related Topics

Multiplex Tag Signals

Important
• Before you manage the signals within a given terminal strip, create and
connect the cables that serve the terminal strip.
• You can only multiplex tag signals that are wired into the terminal
strip.
1. In the Domain Explorer, right-click a panel or a terminal strip.
3. In the Connection window, click next to a terminal in the wire group into
which you want to multiplex a signal.
4. On the Terminal Connection dialog box, click Signal to open the Local Signals
dialog box.
5. Create a unique general signal. For details, see Create a General Signal, page
600.
6. Link the general signal to the signals that you want to multiplex. For details, see
Link Tag Signals to a General Signal, page 601.
7. Do the following for each terminal in the wire group that you are associating with
the general signal:
a. Under Signal, select the general signal that you want to propagate.
b. Select a sequence and a signal level.
• Under Terminal number, select the terminal that you want to edit.
9. Click Save.
Related Topics

De-Multiplex Tag Signals

Important
• Before you manage the signals within a given terminal strip, create and
connect the cables that serve the terminal strip.
1. In the Domain Explorer, right-click a panel or a terminal strip.
3. In the Connection window, click next to a terminal in the wire group into
which you want to de-multiplex a signal.
4. On the Terminal Connection dialog box, do the following for each terminal in
the wire group that you are associating with one of the of the de-multiplexed
signals:
a. Under Signal, select the tag signal that you want to propagate.
b. Select a sequence as you require. Note that you should increment the
sequence according to the original tag signal, rather than according to the
general signal with which it was linked.
c. Select a signal level.
• Under Terminal number, select the terminal that you want to edit.
6. Click Save.
Related Topics
Link all tag signals — Links the current general signal with all the tag numbers in
the current terminal strip.

Intrinsic Safety Calculations Common Tasks

The following tasks are used frequently for calculating intrinsic safety in SmartPlant
Instrumentation.
Create an Intrinsically Safe Circuit Type

The first step in making an intrinsically safe calculation is to define a circuit type.
For more information, see Create an Intrinsically Safe Circuit Type, page 605.
Manage Intrinsic Safety Circuit Types

This option shows you how to maintain the contents of the IS (intrinsic safety) circuit
type supporting table from the Instrument Index module. You can also maintain this
supporting table from the Wiring module. For more information, see Manage
Intrinsic Safety Circuit Types, page 605.
Calculate Intrinsic Safety

Intrinsic safety calculation in SmartPlant Instrumentation allows you to calculate the
maximum permissible cable length between the hazardous and non-hazardous areas
based on three main criteria:
• Resistance
• Capacitance
• Inductance
The calculations are made at the domain level. For more information, see Calculate
Intrinsic Safety, page 606.
Define Tag Numbers for Intrinsic Safety Loop Calculation

When calculating intrinsic safety for a loop, you need to define the tag numbers that
belong to the relevant loop. You have to repeat this procedure for each and every tag
number in the loop For more information, see Define Tag Numbers for Intrinsic
Safety Loop Calculation, page 607.
Define Circuit Cables for Intrinsic Safety Loop Calculation

Before calculating intrinsic safety for a loop, you must perform this procedure for
each cable in the circuit.. For more information, see Define Circuit Cables for
Intrinsic Safety Loop Calculation, page 608.
Calculate Intrinsic Safety for a Loop

After you define loop tags and circuit cables as required, use this procedure to
perform the loop intrinsic safety calculation. For more information, see Calculate
Intrinsic Safety for a Loop, page 609.

Create an Intrinsically Safe Circuit Type

1. Start the Wiring module and do one of the following:
• Click Actions > Intrinsic Safety.
• Click .
2. On the Intrinsically Safe Circuit dialog box, click New.
3. Enter the following information:
a. Type the required circuit type in the Circuit Type data field and the circuit
type description in the Circuit Description data field.
b. From the I/O Type list, select the appropriate area I/O type.
c. From the Area Classification list, select the appropriate area classification.
4. Click Save.
5. On the Drawing Number dialog box, enter an appropriate drawing number name.
6. Click OK.
Note
• The new circuit type is saved and the Intrinsically Safe Circuit dialog
box opens. You can now select the newly created type from the
Circuit Type list.
Related Topics
• Intrinsic Safety Calculations Common Tasks, page 604
Manage Intrinsic Safety Circuit Types

1. Open the Instrument Index module by doing one of the following:
• Click Module > Instrument Index.
• Click .
2. Click Tables > Intrinsically Safe Circuit Types.
3. Click New, to create a new IS circuit type.
4. Under Intrinsically Safe Circuit Type, type the unique and required type name.
5. Under Intrinsically Safe Circuit Description, type the description.
6. Under Drawing Name, type the drawing name.
7. From the Area Classification list, select the area classification.
8. Click Properties.
9. On the Intrinsically Safe Data Input dialog box, under Non-hazardous area
loop components, enter the relevant data for the non-hazardous devices, such as
barrier, isolator, and so forth. You must define the R1, C2, and L2 values.

10. Under Hazardous area loop components, enter the relevant data for the
hazardous devices, such as transmitters, I/P converters, and so forth. You must
define the R1, C2, and L2 values.
11. Click OK to close the Intrinsically Safe Data Input dialog box.
12. Click OK to finish.
Related Topics
Calculate Intrinsic Safety

1. Start the Wiring module and do one of the following:
• Click Actions > Intrinsic Safety.
• Click .
2. On the Intrinsically Safe Circuit dialog box, from the Circuit type list, select
the appropriate circuit type.
Tips
• The remaining fields on the dialog box are filled in automatically with
the data for the circuit type you select.
• If the required circuit type is not on the list, create a new one or edit an
existing circuit type. For more information, see Calculate Intrinsic
Safety for a Loop, page 609.
3. Click OK.
4. On the Intrinsically Safe Data Input dialog box, under Non-hazardous area
loop components, enter the relevant data for the non-hazardous devices, such as
barrier, isolator, and so forth. Note that you must define the R1, C2, and L2
values.
5. Under Hazardous area loop components, enter the relevant data for the
hazardous devices, such as transmitters, I/P converters, and so forth. Note that
R1, C2, and L2 are required fields.
6. Define the cable parameters between the junction box and the marshaling rack.
7. Define the cable parameters between the device panel and the junction box (if the
cable exists). If the field instrument is connected directly to the marshaling rack,
specify the cable length (B) = 0.

8. Click Calculate to calculate the limit criteria (resistance, inductance, or

capacitance) and the maximum permissible cable length between the junction box
and the marshaling rack (Cable A) based on the values you entered.
Tip
• The Intrinsically Safe Calculation Results dialog box opens where
you can view the calculation results, change the units of measure, and
save the results with the different units.
• The maximum permissible length must be less than the actual length
of the cable used (Cable “A” - connecting the hazardous and non-
hazardous areas).
9. Click OK to return to the Intrinsically Safe Data Input dialog box.
10. If needed, you can do any of the following:
• View and enter revisions.
• Enter intrinsic safety notes.
• Click Print to generate and print a report that shows all the data that
you entered and the calculation results.
Related Topics
Define Tag Numbers for Intrinsic Safety Loop Calculation

1. In the Domain Explorer, right-click an instrument, and on the short-cut menu,
click Properties.
2. On the Tag Number Properties dialog box, beside the Intrinsically safe circuit
type list, click .
3. On the Intrinsically Safe Circuit Types dialog box, select the required row, and
then click Properties.
Tip
• You can also create a new intrinsically safe circuit type.
4. On the Intrinsically Safe Data Input dialog box, in both group boxes, make sure
that you express the following parameters in the following units of measure:
• Resistance — ohm
• Inductance — mH
• Capacitance — µF (microFarad)
• L/R — mH/ohm
5. Click OK to close the Intrinsically Safe Data Input dialog box.

6. Make sure that the row that you require is selected and then click OK to close the
Intrinsically Safe Circuit Types dialog box.
Related Topics
Define Circuit Cables for Intrinsic Safety Loop Calculation

1. In the Domain Explorer, right-click a cable, and on the short-cut menu, click
Properties.
2. On the Cable Properties dialog box, beside the Type list, click .
3. On the Cable Types dialog box, select the required row, and then click
Properties.
Tip
• You can also create a new intrinsically safe circuit type.
4. On the Cable Type Properties dialog box, make sure that you express the
following parameters in the following units of measure:
• Capacitance — nF (nanoFarad) /km
• Resistance — Ohm/km
• Inductance — mH/km
5. Click OK to close the Cable Type Properties dialog box.
6. Make sure that the row that you require is selected and then click OK to close the
Cable Types dialog box.
7. On the Cable Properties dialog box, under Unit of measure, select meter.
8. Under Length, define the cable length.
9. Select the Set as intrinsically safe check box, and then click OK.
Related Topics

Calculate Intrinsic Safety for a Loop

1. Start the Wiring module and click Actions > Intrinsic Safety Loop Calculation.
• Type the loop number in the data field.
• Click Find to search for a loop that requires intrinsic safety
calculation.
3. Click OK to open the Intrinsically Safe Loop Data dialog box.
Tips
• In the data window, if you select a tag for which you did not define an
intrinsically safe circuit type, nothing is displayed in the lower group
box.
• If you select a tag number for which you defined an intrinsically safe
circuit type, SmartPlant Instrumentation displays non-hazardous area
and hazardous area loop components below the data window.
4. On the Intrinsically Safe Loop Data dialog box, click Calculate.
5. In the Intrinsically Safe Calculation Results dialog box, select each tag number
for which you want to display intrinsic safety data.
6. To preview reports for all of the tags in the current loop, click Print.
Related Topics

Cable Routing: An Overview

The cable routing feature provides the ability to set up a flexible, modular model of
the cable routing in your <plant>. Cable routing sections are divided into several
categories that enable you to set up a complete cable routing sequence. These
categories match the different <plant> regions as follows:
Category Category Description and Location in the <Plant>

Trunk Standard sections that include all the cable routing that
does not pass through a built area. These sections are
actually legs passing through the <plant> junction points
that function as ports, where cables enter and exit the
routing. Trunks contain trays conveying the positions
through which the cables pass.
Building Sections that pass through a built area. Building sections
do not contain trays or positions.
Panel - Routing Distance This in fact, is not a section category but a variable
distance added to the total cable routing length. It is the
distance between an instrument and the routing starting
point.
Related Topics
• Cable Routing Common Tasks, page 612
• Cable Routing Flow of Activities, page 611

Cable Routing Flow of Activities

The cable routing feature allows you to create modular cable routing sections. The
sections convey the cables in your <plant>, and they subdivide into two main
categories:
• A Trunk is a standard section that can be utilized in all non-enclosed

plant areas. Trunks contain positions, fixed on trays.
• A Building is a section that passes through an enclosed area, and does
not contain positions
You plan your cable routing system according to the following flow of activities:
1. Set the cable routing options, such as cable length and position width units of
measure, cable spare length, and so forth. For details, see Set Cable Routing
Options, page 614.
2. Create named standard widths. You will use these later to create positions in the
trunk section. For details, see Manage Standard Widths, page 616.
3. Create standard positions. Positions convey the cables within the trunk sections.
For details, see Manage Standard Positions, page 616.
4. Define the maximum number of cables for each standard position, according to
the position width. This is how you assure that the number of cables does not
exceed the position cable capacity. For details, see Set the Maximum Number of
Cables for the Standard Positions, page 617.
5. Create the routing sections. For details, see Create a Routing Section, page 617.
6. Associate cables with sections. The association can be performed in single or
batch mode. The association includes the following activities:
• Selecting the cables to which you add the cable routing.
• Setting the order of the routing sections per cable.
• Selecting the active positions for each section.
Related Topics
• Cable Routing: An Overview, page 610

Cable Routing Common Tasks

The following tasks are used frequently when you manage the cable routing in your
plant.
Set Cable Routing Options

Use this procedure to set the options for the cable routing throughout a specific
<plant>. SmartPlant Instrumentation applies your selections to existing cables and
sections and to all future routing elements. When you change the Length unit of
measure, the software automatically recalculates values of routing elements that
currently exist in your plant and expresses them in the new units of measure. The
routing elements that SmartPlant Instrumentation recalculates after a change in the
Cable Routing Options dialog box are cable length, panel-routing distance, and
section length.
For more information, see Set Cable Routing Options, page 614.
Customize Cable Routing Terminology

Use this procedure to change cable routing terminology to terms that you define. You
can change any or all of the following terms: trunk section, building section, position,
section, and tray. Changes that you make are implemented in all relevant dialog
boxes and reports. For more information, see Customize Cable -Routing
Terminology, page 615.
Manage Standard Widths

The standard width is a value that you enter and which SmartPlant Instrumentation
uses to define the width of the routing positions that the sections comprise. This
procedure explains how to add a standard width to your current <plant>, edit, or
delete an existing one. Note that a standard width is not necessarily associated with a
position. It only provides the ability to associate the width with positions. For more
information, see Manage Standard Widths, page 616.
Manage Standard Positions

Routing positions are the wiring elements that convey the cables in your <plant> and
separate the different cable groups inside the routing sections. You associate the
standard routing positions with the trunk sections in your <plant> and adjust their
widths to fit those positions. This way you do not have to define new positions for
every new trunk that you add. For more information, see Manage Standard
Positions, page 616.

Set the Maximum Number of Cables for the Standard Positions

The maximum number of cables is a value that you define to limit the number of
cables that you can associate with a position within a trunk section. You can add
positions to trunks only if you predefined a maximum number of cables per position.
That is, you define the number of cables for a standard position and only then the
position becomes available to include in a trunk. For more information, see Set the
Maximum Number of Cables for the Standard Positions, page 617.
Create a Routing Section

Routing sections are the wiring elements that convey the cables in your <plant>.
They subdivide into two main categories:
• Trunk— a standard section that can be utilized in all non-enclosed

<plant> areas. Trunks contain positions.
• Building— a section that passes in an enclosed area and does not
contain positions.
You define a standard position with a standard width to fit the section that includes it.
For more information, see Create a Routing Section, page 617.
Edit a Routing Section

This procedure explains how to edit the properties of a routing section. For more
information, see Edit a Routing Section, page 618.
Associate a Routing Section with Cables

The last stage in setting up cable routing is associating the different sections that you
have created with the cables in your <plant>. Once the association is completed,
SmartPlant Instrumentation calculates and sets the total length of the routing, and the
cable routing of your <plant> is ready. For more information, see Associate a
Routing Section with Cables, page 619.
Edit a Cable Routing

This feature allows you to change the sections associated with a cable, change their
order, or change the panel-routing distance. For more information, see Edit a Cable
Routing, page 619.
Copy Routing Data to Another Cable

After you create a cable routing, you can copy the routing data to other cables, thus
saving redefinition time for similar cables. Note that if you copy routing data to a
cable with existing routing, the new routing overwrites the existing routing data. For
more information, see Copy Routing Data to Another Cable, page 620.

Append Routing Data to a Cable

You can append the routing properties of an existing source cable to a destination
cable or cables. This can be an efficient way of adding sections to an existing
routing.
• A source cable is a trunk cable for which you have already defined
cable routing options, created the routing sections, and associated
cables with these sections.
• A destination cable is a trunk cable to which you want to add the
routing data of the source cable.
For more information, see Append Routing Data to a Cable, page 621.
Related Topics
Set Cable Routing Options

1. In the Wiring Module window, click Actions > Cable Routing Options.
2. On the Cable Routing Options dialog box, from the Length unit of measure
list, select a unit of measure.
3. In the message box that opens, click OK to confirm calculation in the new unit of
measure.
4. From the Position width unit of measure list, select the required unit of measure.
Tip
• Set the Position width unit of measure at initialization, and do not
change it. Although changing the length unit of measure recalculates
length values in the new unit of measure, changing the position width
unit of measure changes the label without recalculating the value of
the position width.
5. In the message box that opens, click OK to confirm the position width unit of
measure.
6. In the Cable spare length group box, to calculate the spare cable length for all
the cables in the <plant>, do one of the following:
• Select Fixed length and type its value in the box to the right.
• Select Fixed percentage, and type or select a percent value in the box
to the right.
7. Under Panel to routing distance, type the distance from a junction box or
marshaling rack to the beginning of a routing section.

8. To customize cable routing terminology, next to Customize terminology, select

the check box and then click . For details, see Customize Cable Routing
Terminology, page 615.
Note
• For cable drums with status Design or Purchased, if you change cable
spare length, SmartPlant Instrumentation recalculates the cable length,
but not for drums with status Locked.
Related Topics
Customize Cable Routing Terminology

1. In the Wiring Module window, click Actions > Cable Routing Options.
2. On the Cable Routing Options dialog box, select Customize terminology and
then click .
3. On the Cable Routing Custom Terminology dialog box, for each term that you
want to customize, do the following:
a. Click under Custom Name (Singular), and type the customized name.
b. Click under Custom Name (Plural), and type the customized name.
4. Click OK to close the Cable Routing Custom Terminology dialog box.
5. Click OK to close the Cable Routing Options dialog box.
Related Topics

Manage Standard Widths

1. In the Wiring Module window, click Tables > Cable Routing > Standard
Widths.
2. On the Standard Widths dialog box, do one of the following:
• To add a new standard width, click New.
• To edit an existing standard width, click the field that you want to edit.
• To delete a standard width, highlight the required standard width or in
the Find field, type the width that you want to delete, and click Delete.
3. Type the position name and description as required.
4. Click OK to save your changes and close the dialog box.
Related Topics
Manage Standard Positions

1. In the Wiring Module window, click Tables > Cable Routing > Standard
Routing Positions.
2. On the Standard Routing Positions dialog box, do one of the following:
• To add a new standard position, click New.
• To edit an existing standard position, click the field that you want to
edit.
• To delete a standard position, highlight the required standard position
or in the Find field, type the position that you want to delete, and click
Delete.
3. Type the required standard width value.
4. Repeat steps 1-3 for all the standard widths you want to enter.
Note
• A standard width is not necessarily associated with a position. It only
provides the ability to associate the width with positions.
Related Topics

Set the Maximum Number of Cables for the Standard

Positions
1. In the Wiring Module window, click Tables > Cable Routing > Maximum
Number of Cables.
2. On the Maximum Number of Cables dialog box, click a field and type the
maximum number of cables in the width column of the required position.
Tip
• The Maximum Number of Cables dialog box comprises a grid. The
grid displays the standard positions and standard widths that you have
added to your current <plant>.
Related Topics
Create a Routing Section

1. In the Wiring Module window, click Actions > Cable Routing > Routing
Sections.
2. On the Routing Sections dialog box, do one of the following:
• To base the new routing section on an existing routing section, click
Duplicate.
• To create a new routing section not based on an existing section, click
New.
3. In the Routing Section Properties dialog box, type the new section name or
accept the default in the Routing section field.
Tip
• The initial All or Trunk default is T-1, and the initial Building default
is B-1. Defaults for succeeding entries revise the previous name in a
given category by adding a 1 or incrementing the previous suffix by 1.
4. In the Length field, type the section length. (To change the unit of measure, see
Set Cable Routing Options, page 614.
5. From the Routing category list, select Trunk or Building.

6. If you selected Trunk, SmartPlant Instrumentation displays the Position and

widths grid. Select a defined width for each active position.
Tip
• When you define a maximum number of cables for a standard position,
the position at the specific defined width becomes available for
association with sections. In the Position – Width grid of the New
Section dialog box, the available positions and widths are marked with
a check box. Although a position can have more than one available
standard width, you can select only one standard width per position.
7. Click OK to enter the new section and close the dialog box.
Related Topics
Edit a Routing Section

1. In the Wiring Module window, click Actions > Cable Routing > Routing
Sections.
2. On the Routing Sections dialog box, filter the routing sections by selecting
Trunk or Building, or accept the default All.
3. Highlight a routing section and click Properties.
4. On the Routing Section Properties dialog box, you have the following options:
• To modify the routing section name.
• To modify the length (unless the cable assigned to this section is on a
locked drum).
• To change the section category, from the Routing category list, if the
section is not in use.
• For routing category Trunk, to select a width for each position from
the Position and widths grid (unless the cable assigned to this section
is on a locked drum).
5. Click OK to save your changes and close the Routing Section Properties dialog
box.
Related Topics

Associate a Routing Section with Cables

1. In the Domain Explorer, highlight the cables with which you want to associate
cable routing sections, and do one of the following:
• Right-click the highlighted cables, and then on the shortcut menu,
click Cable Routing.
• Click Actions > Cable Routing.
2. On the Cable Routing dialog box, from the Cable list, select a cable.
3. In the Available Sections window, highlight the available sections that you want
to associate with the selected cable, and do one of the following:
• Click
• Drag the sections to the Assigned sections pane.
4. From the Routing Position list of the required section, select the position that will
hold the cable.
Tip
• Change the order of the assigned sections by highlighting an assigned
section and clicking Move Up or Move Down.
5. Type the panel-routing distance, or accept the default.
6. Repeat steps 2 through 5 for each cable in the Cable list.
Related Topics
Edit a Cable Routing

1. In the Domain Explorer, highlight the cables whose routing you want to edit, and
click Cable Routing.
• Click Actions > Cable Routing.
2. On the Cable Routing dialog box, from the Cable list, select a cable.
3. To add additional sections to the selected cable, under Available sections,
highlight the available sections that you want to associate with the cable, and do
• Click
• Drag the sections to the Assigned sections pane.

4. To remove sections from the selected cable, under Assigned sections, highlight
the sections that you want to remove, and do one of the following:
• Click
• Drag the sections from the Assigned sections pane to the Assigned
sections pane.
5. Change the position of a section, as necessary, from the Routing Position list.
6. Change the order of assigned sections, as necessary, by highlighting a section and
clicking Move Up or Move Down.
7. Edit the panel-routing distance, as necessary, by changing the value in the Panel-
routing distance box.
8. Repeating steps 3 through 7 for each cable in the Cable Name list.
Related Topics
Copy Routing Data to Another Cable

1. In the Domain Explorer, select the cables from which you want to copy routing
data.
click Copy Cable Routing.
• Click Actions > Copy Cable Routing.
3. On the Copy Cable Routing dialog box, select a cable from the Source cable
list.
Tip
• A source cable is a trunk cable for which you have already defined
cable routing options, created the routing sections, and associated
cables with these sections. SmartPlant Instrumentation displays the
routing data for the source cable you select in the Source routing data
grid.
4. In Domain Explorer, highlight target cables, and drag them to the Destination
cables group box.

5. Select the cables to which you want to copy the routing data of the source cable in
one of the following ways:
• Select the check box to the left of each cable.
• Choose Select all cables without routing. Use this option to avoid
overwriting existing routing data.
• Choose Select all to enable overwriting of existing routing data on the
destination cables.
6. Click Copy.
Note
• To copy routing data to additional cables, repeat steps 3 through 6.
Related Topics
Append Routing Data to a Cable

1. In the Domain Explorer, select the cables that will be your source for appending.
click Append Cable Routing.
• Click Actions > Append Cable Routing.
3. On the Append Cable Routing dialog box, select a cable from the Source cable
list.
Tip
• In the Source routing data group box, SmartPlant Instrumentation
displays the routing data for the selected cable.
4. In Domain Explorer, highlight target cables, and drag them to the Destination
cables group box.
5. Select the cables to which you want to append the routing data of the source cable
in one of the following ways:
• Select the check box to the left of each cable.
• Choose Select all cables without routing. Use this option to avoid
overwriting existing routing data.
• Choose Select all to enable overwriting of existing routing data on the
destination cables.

6. Click Append.
Notes
• To append routing data to additional cables, repeat steps 3 through 6.
• SmartPlant Instrumentation appends the new sections after the original
sections of the destination cable, if there were any. You can change
the order of these sections by opening the destination cable in the
Cable Routing dialog box. For details, see Edit a Cable Routing,
page 619.
Related Topics

Cable Drums
The cable drum feature allows you to efficiently use cable drums, and setup an
organized method of cable drum assignment. The cable drum feature handles both
the optimization of existing cable drum allocations (purchased drums) and the
assignment of new cable drums when necessary (Design drums). The cable drum
feature allows you to perform cable drum assignment both automatically and
manually. The cable drum feature requires that you define pulling areas in your
<plant> where the cable drums are concentrated. From these areas you perform the
assignment of cable drums for the cables.
The pulling area that you define here does not have the same functionality as the
<area> in SmartPlant Instrumentation plant hierarchy. The pulling area is
designated for cables and cable drums only.
The steps required to set up a fully functional cable drum assignment are as follows:
1. Define the pulling areas where the cable drums are placed.
2. Associate cables with the predefined pulling areas.
3. Define drum attributes for cable types.
4. Create the cable drums that will eventually be assigned to your cables. This
includes both adding the cable drums that already exist in your <plant> and
adding the cable drums that you need to purchase to complete your required cable
drum inventory. You can also perform this automatically in a cable drum
assignment.
5. Select the cables that you want to assign to the cable drums that you have created
(even if the drums have not been purchased yet).
6. The last stage is to assign cables to cable drums. At this stage the cable drum
feature automatically adds new cable drums as required.
Related Topics
• Cable Drums Common Tasks, page 624

Cable Drums Common Tasks

The following tasks are used frequently when you manage the cable drums in your
plant.
Create and Manage a Pulling Area

The pulling area is the plant area where you concentrate cable drums. This procedure
explains how to add a new pulling area to your <plant>. Use this procedure to edit
existing pulling area data. For more information, see Create and Manage a Pulling
Area, page 626.
Associate Cables with a Pulling Area

Prior to assigning cables to drums, you have to associate your cables with a pulling
area. For more information, see Associate Cables with a Pulling Area, page 626.
Define Cable Drum Attributes for Cable Types

This procedure explains how to define cable drum attributes for cable types. This is
required because each cable type has its minimum and maximum length. The cable
drums that you will create will then be based on the cable drum attributes that you
define here. For more information, see Define Cable Drum Attributes for Cable
Types, page 627.
Manage Cable Drums Manually

This procedure explains how to create cable drums manually and set their attributes.
There are three categories of cable drums:
• Design— Cable drums that you intend to purchase in the future and
you want to design to fit your cables.
• Purchased— Existing cable drums that you want to include in a
cable-drum optimization.
• Locked— Existing cable drums that you do not want to include in a
cable-drum optimization.
For more information, see Manage Cable Drums Manually, page 628.

Assign Cables to Drums Automatically (with Optimization)

When assigning cables to cable drums, SmartPlant Instrumentation creates cable
drums automatically. You can perform this assignment and optimization in single or
in batch mode. The optimization process matches cables and the cable drums that fit
them with minimum waste of cable drum length, using the following algorithm:
• The highest priority is to utilize cable drums that are purchased but not
yet locked. Optimization may assign new cables to these drums.
• The second priority is to optimize the drum cable length for drums
whose status is design. The guiding parameters are minimum drum
length and maximum. drum length.
• The third priority is to create new cable drums of a given cable type.
For more information, see Assign Cables to Drums Automatically (with
Optimization), page 630.
Assign Cables to Drums Manually (Without Optimization)

This procedure explains how to assign a cable to a cable drum manually. This action
requires that you predefine the following for this cable:
• A cable type.
• At least one pulling area.
• A cable drum associated with the cable type and with the pulling area.
The manual cable drum assignment is performed without optimization, which means
that the designated cable drum is not necessarily the optimum for the selected cable.
For more information, see Assign Cables to Drums Manually (Without Optimization),
page 630.
Related Topics
• Cable Drums: An Overview, page 623

Create and Manage a Pulling Area

1. In the Wiring Module window, click Tables > Pulling Areas.
2. On the Pulling Areas dialog box, do one of the following:
• To create a new pulling area, click New.
• To edit a pulling area, click the field that you want to edit.
• To delete a pulling area, select a row and click Delete.
3. Type the pulling area name (required) and description in the respective fields.
4. Click OK.
Note
• The pulling area that you define here does not have the same
functionality as the <area> in SmartPlant Instrumentation plant
hierarchy. The pulling area is designated for cables and cable drums
only.
Related Topics
Associate Cables with a Pulling Area

1. In the Domain Explorer window, select and right click the cable that you want to
associate with a pulling area.
3. On the Cable Properties dialog box, from the Pulling Areas list, select the
pulling area that you want the selected cable to be associated with.
Tip
• You can use the Pulling Areas dialog box to add new pulling areas or
edit existing.
4. Click OK to save your changes and close the Cable Properties dialog box.
Related Topics

Define Cable Drum Attributes for Cable Types

1. In the Wiring Module window, click Tables > Cable > Types.
2. On the Cable Types dialog box, select a cable type and click Properties.
3. On the Cable Type Properties dialog box, type the appropriate data in the
following fields:
• Maximum drum length— type the maximum cable drum length for
this cable type.
• Minimum drum length— type the minimum cable drum length for
this cable type.
• Length UOM— select the length unit of measure.
• Drum spare length percent— enter the percent of the used cable
drum length to allocate to spare cable length. (The spare and the used
length combine to the total length.)
4. Click OK to save your changes and close the Cable Type Properties dialog box.
5. Click OK to close the Cable Types dialog box.
Related Topics

Manage Cable Drums Manually

1. In the Wiring Module window, click Tables > Cable Drums.
2. On the Cable Drums dialog box, select a cable type to filter the data window.
• Click New to add a new cable drum.
• Select a cable drum row and click in the appropriate fields to edit the
data.
• Select a cable drum row and click Delete.
4. In the data window, type the data in the fields or select the data from the lists
according to the following table:
Column Name Column Description
Name Type the cable drum name.
Description Type the cable drum description if required.
Pulling Area Select the pulling area where the cable drum is located.
Length Type the total cable drum length (utilized + spare).
Utilized Length Displays the utilized cable length of the total drum length.
Length UOM Select the unit of measure used to measure the drum
length.
Drum Status Select one of the following:
• Design— cable drum in the
design stage (not purchased yet); available for
cable-drum optimizations.
• Purchased— a purchased
cable drum of defined length that you want to
include in cable-drum optimizations.
• Locked— a purchased cable
drum that is assigned to a cable and locked
against reassignment (cable drum
optimizations).
Spare Length Percent Type the percent of the used cable drum length to allocate
to spare cable length.
5. Click OK to save your changes and close the Cable Drums dialog box.

Note
• SmartPlant Instrumentation creates cable drums automatically when
you assign cables to cable drums and additional cable drums are
required.
Related Topics

Assign Cables to Drums Automatically (with Optimization)

Important
• The procedure below only works if you created a cable and assigned a
pulling area.
1. In the Wiring Module window, click Actions > Cable-Drum Assignment.
2. On the Cable-Drum Assignment dialog box, select the following filtering
criteria:
• Cable type
• Pulling area
• Select Include assigned cables to display cables that are already
assigned to cable drums, in addition to those not yet assigned.
• Clear Include assigned cables not to display assigned cables.
4. Click Find.
5. Select the cables that you want to include in the cable drum assignment.
Tip
• If you selected Include assigned cables in step 3 above, optimizing
can change existing cable assignments.
6. Click Optimize.
Related Topics
Assign Cables to Drums Manually (Without Optimization)

1. In the domain Explorer, right-click a cable and then click Properties.
2. On the Cable Properties dialog box, do the following:
a. From the Pulling area list, select the pulling area that the designated cable
drum is associated with.
b. Make sure that the cable type is selected from the Type list.
c. From the Cable Drum list, select the cable drum to which you want to assign
the selected cable. Click to add a y required items that are not on the list.
3. Click OK to save your changes and close the Cable Properties dialog box.
Related Topics

Managing Panel Locations: An Overview

Panel location is a panel property that you define when creating or editing the
properties of a panel. You can set multiple location levels, for example, building –
floor – room. You can use each level to define a panel location.
Related Topics
• Managing Panel Locations Common Tasks, page 631
218
Managing Panel Locations Common Tasks

The following tasks are used frequently when you manage the panel locations in your
plant.
Define a New Panel Location

This option allows you to define a new panel location. You can then select this
location when defining panel properties.
Note that panel location is defined per domain; therefore, all the panel location
definitions that have been made in the Administration module are available
throughout the entire current domain.
For more information, see Define a New Panel Location, page 632.
Modify Panel Location Properties

This option allows you to modify the properties of a panel location. You can rename
a location and change its description. For more information, see Modify Panel
Location Properties, page 632.
Change the Location of a Panel

You can change the location of a panel either in the Domain Explorer by dragging a
panel to another location in the Panels by Location folder or in the Location
Manager. For more information, see Change the Location of a Panel, page 633.
Dissociate a Panel from a Location

While defining panel properties, you can dissociate a panel from a location. For more
information, see Dissociate a Panel from a Location, page 633.
Delete a Panel Location

This procedure explains how to delete a panel location in the Location Manager.
For more information, see Delete a Panel Location, page 633.

Define a New Panel Location

1. Do one of the following to open the Location Manager dialog box:
• In the Wiring module, click View > Location Manager.
• Click next to the Location list arrow in any appropriate Properties
dialog box.
2. Do one of the following in the Location Manager:
• To define a location on the highest hierarchy level, right-click
Location, and then on the shortcut menu, click New.
• To define a location under an existing location definition, expand one
of the existing location levels, then right-click a location and on the
shortcut menu, click New.
3. On the Location Properties dialog box, type the location name and description as
you require.
4. Click OK.
Note
• You can define a new location on the highest hierarchy level directly
from the Domain Explorer. Right-click the Panels by Location
folder, and then on the shortcut menu, click New > Location.
Related Topics
• Managing Panel Locations: An Overview, page 631
Modify Panel Location Properties

dialog box.
2. Right-click a location and then on the shortcut menu, click Properties.
3. On the Location Properties dialog box, type the location name and description as
you require.
4. Click OK.
Related Topics

Change the Location of a Panel

1. On the Properties dialog box of a panel, click next to the Location list arrow.
2. In the Location Manager, select a location and click OK.
Tip
• To dissociate a panel from a location without assigning another
location, click Dissociate.
3. Click OK on the Panel Properties dialog box.
Note
• Also, you can change the location of a panel in the Domain Explorer
without opening the Properties dialog box for a panel. Expand the
Panels by Location folder and select a panel. Drag it to another
location, as you require.
Related Topics
Dissociate a Panel from a Location

1. In the Domain Explorer, right-click a panel.
3. Click next to the Location list arrow.
4. In the Location Manager, click Dissociate.
Delete a Panel Location

dialog box.
2. Right-click a location.
3. On the shortcut menu, click Delete.
Note
• You can delete a location directly from the Domain Explorer without
opening the Location Manager. In the Domain Explorer, expand the
Panels by Location folder. Then, right-click a location and then on
the shortcut menu, click Delete.

Location Manager
Location Manager allows you to define panel locations and set a location for a
selected panel. Panel location is a panel property that you define when creating or
editing a panel or a cabinet. You can set multiple location levels, for example,
building – floor – room. You can use each level to define a panel location.
Note that panel location is defined per domain; therefore, all the panel location
definitions that have been made in the Administration module are available
throughout the entire current domain.
Do one of the following to open the Location Manager dialog box:

• Click next to the Location select list arrow on any appropriate
Tree view — The software arranges all the location definitions in a hierarchical
structure. The number of levels that can exist in each location are determined by the
Domain Administrator in the Administration module.
All the locations are created under Location, which is the top level in the tree view.
To create a new location at the top level, right-click Location, and then on the
To create a location on a lower level, highlight a location or expand a location and

then highlight a location you need. Right-click the location you selected and then on
the shortcut menu, click New.
To rename a location, right-click a location and then on the shortcut menu, click
Properties.
To delete a location, right-click a location and then on the shortcut menu, click
Delete.
Dissociate — Dissociates the current location from the selected panel. This option
is available only after opening the Location Manager by clicking next to the
Location select list arrow.

Generating Wiring Reports Common Tasks

The following tasks are used frequently when you generate wiring reports in

You can follow a signal along a sequence of wires. SmartPlant Instrumentation uses
wire groups, group level and group sequence data to follow a signal along a series of
wires and check for any discontinuity. The wire group is the signal name
representing the tag number from which the signal originates. The result is displayed
in a point-to-point wiring diagram that you can print. For more information, see
Trace a Signal in a Point-to-Point Wiring Diagram, page 543.
Generate a Connection Report from the Connection Window

While in the Connection window, you can generate a connection report for the
current terminal strip. The report lists all the cables connected to the selected
terminal strip and shows all the cable-sets within each cable, the wire tags, their color,
and terminal number. This report does not show adjacent connections. For more
information, see Generate a Connection Report from the Connection Window, page
544.

This option enables you to generate a report showing I/O assignments for an I/O card
or I/O termination that you select in the I/O Assignment window. For more
information, see Generate an I/O Tag Assignment Report, page 560.
Generate a Panel Strip Report from the Cross Wiring Window

This option enables you to generate a panel – strip report that displays the
connections and adjacent connections for the terminal strip you selected from the
Primary terminal strip list in the Cross Wiring window. For more information, see
Generate a Panel Strip Report from the Cross Wiring Window, page 574.
Display Channels and Wiring Equipment in Panel-Strip Reports

When generating a Panel-Strip report, it is possible to specify whether or not to
display grouping of channels, wiring equipment, and I/O channels. To do so, you
need to specify a set of parameters in the Custom preferences for wiring. For more
information, see Display Channels and Wiring Equipment in Panel-Strip Reports,
page 637.
Related Topics
page 524

Generate a Connection Report from the Connection

Window
• On the menu bar, click Reports > Connection.
• Click .
2. In the Print Preview prompt, click Yes to display the report print preview or
click No to print out the report without displaying its print preview.
Related Topics
page 524
Generate a Panel Strip Report from the Cross Wiring

Window
1. Do one of the following in the Cross Wiring window:
• Click Reports > Panel-Strip.
2. Click Yes to open the print preview or click No to print the report without
displaying it on your screen.

1. In the I/O Assignment window, under I/O assignment, select an I/O card or an
I/O termination from the list.
2. Select the required I/O card from the I/O card name list.
• Click .
• Click Reports > Tag assignment Report.
4. Click Yes to open the print preview of the report or click No to send the report to
your default printer.
Related Topics

Generate Panel-Strip Reports as PDF Files

Important
• Set your .pdf generator preferences to prompt for a .pdf file
destination.
• From the Windows Start menu, click Settings > Printers, and then
define your .pdf generator as the default printer.
• Select terminal strips and I/O cards for which you want to generate
panel-strip reports.
• Select panels for which you want to generate panel-strip reports.
2. Right-click on a selected item, and then on the shortcut menu, click Panel-Strip
Reports , and then click one of the following:
• With Adjacent Connections
• Without Adjacent Connections (Style 1)
• Without Adjacent Connections (Style 2)
3. When prompted to preview the printed documents, click No.
Related Topics
Display Channels and Wiring Equipment in Panel-Strip

Reports
1. In the Wiring module, click File > Preferences.
2. On the Preferences dialog box, under Wiring, click Custom.
3. In the Custom features for the Wiring module group box, under Parameter,
type DisplayChannels.
4. Under Value, type a string that consists of three digits made up of 0 and 1, for
example, 110.
In the string, the first digit refers to grouping of channels, the second digit refers
to wiring equipment, and the third digit refers to I/O channels. The digit "1"
instructs the software to display the channels and the wiring equipment. Zero
means not to display the channels or the wiring equipment. For example, if you
type 001, the software will display the I/O channels only. If you type 110, the
software will display the grouping of channels and the wiring equipment items but
it will not display the I/O channels. Note that the default setting is 010, which
displays wiring equipment items only.

Cable Block Diagrams: An Overview

Cable Block Diagrams (CBDs) provide a graphical representation of the
interconnection of the cables and the various junction boxes, marshalling racks,
cabinets, and so forth in your project. They show the project cable flow between the
various cables and cabinets of your project.
Cable Block Diagrams are ideal for use in the preliminary planning stages of your
plant to verify the destination panels for cables as no wiring connections or
terminations are needed at this early stage of your project. A CBD is also used for
ordering made to order (MTO) cables at the feed stage of your project, and later after
completion of your project, as part of the maintenance program to show the location
of all major cables, panels, junction boxes, and so forth.
SmartPlant Instrumentation allows you to drag and drop panels from the Domain
Explorer to your drawing and position them exactly where you want. The software
creates a representation of existing cables on the fly, or you can manually connect
cables between item connection points.
Related Topics
• Cable Block Diagram Common Tasks, page 638
Cable Block Diagram Common Tasks

The following tasks are used frequently when working with cable block diagrams in
Create a New Cable Block Diagram

This procedure shows you how to create a new cable block diagram, add items, show
already connected cables, and connect cables between the items. Using symbols
supplied with the software you drag and drop items where you want to position them
within the drawing. When you connect cables between the different items of
equipment, the software checks that the connection point is valid, and makes the
connection. If no connection point is available the software does not allow the cable
to be connected. For more information, see Create a Cable Block Diagram, page
639.
View an Existing Cable Block Diagram

This procedure shows you how to view an existing cable block drawing. For more
information, see View an Existing Cable Block Diagram, page 642.

Add Cables and Objects to an Existing Cable Block Diagram

This procedure shows you how to add cables and items to an existing cable block
diagram. For more information, see Add Cables and Objects to an Existing Cable
Block Diagram, page 641.
Disconnect Cables from Items in a Cable Block Diagram

This procedure shows you how to disconnect cables from items on your drawing. For
more information, see Disconnect Cables from Items in a Cable Block Diagram, page
642.
Remove Items from a Cable Block Diagram

This procedure shows you how remove an item, such as a PDB, from your drawing.
For more information, see Remove Items from a Cable Block Diagram, page 643.
Related Topics
• Cable Block Diagrams: An Overview, page 638
Create a Cable Block Diagram

1. On the Domain Explorer, locate the Drawings folder.
2. In the Drawings folder, locate the Cable Block Diagram folder.
3. Right-click on the Cable Block Diagram folder, and from the shortcut menu
select New > Block Diagram.
4. On the Document Properties (New) dialog box, type a value for the Document
number and Description fields.
5. Click OK.
6. In the Cable Block Diagram folder, right-click your new document, and from the
shortcut menu select Reports > Generate Cable Diagram.
7. At the prompt, click Yes to preview your drawing, a new blank drawing opens in
the Enhanced Report Utility.
8. In the Enhanced Report Utility, open the Domain Explorer by doing one of the
following;
• Press F7
• Click Tools > Domain Explorer
• Click

9. From the Domain Explorer in the Enhanced Report Utility drag the panels you
require, and position them on the drawing.
Tip
• The order that you drag the panels onto the drawing will define the
sorting order that will be used in the generation process of the
connection, for example; if you drag the DCS panel first, then the JB,
and finally the device panel, the software will connect the DCS to the
JB and then the JB to the device panel.
10. Click to allow the software to automatically regenerate your drawing, and
show any cables and there connections between the physically wired items.
11. To make the connections between the items manually, do the following;
a. Select any item on the drawing and do one of the following:
• Click Activate Connection Mode .

• Click Edit > Activate Connection Mode.
b. On the Domain Explorer select the cable you want to connect between two
items.
c. Move the cursor over the drawing to view the available, valid connect points
of the items and cable category on your drawing. For more details, see Place
Point Ribbon (SPEL) in the Catalog Managers User's Guide, under Working
with Symbols, Place Point Command, Place Point Ribbon (SPEL).
d. Click the connect point of the item you want the cable to connect 'From'.
e. Click the connect point of the item you want the cable to connect 'To'.
f. Select another cable or click View > Refresh to view the drawing with the
cable attached.
Related Topics

Add Cables and Objects to an Existing Cable Block

Diagram
1. Open the CBD that you want to add items to. For further details, see View an
Existing Cable Block Diagram, page 642.
2. In the Enhanced Report Utility, open the Domain Explorer by doing one of the
following;
• Press F7
• Click Tools > Domain Explorer
• Click
3. From the Domain Explorer in the Enhanced Report Utility drag the objects you
want to add to the drawing, and position them on the drawing.
4. Click to allow the software to automatically regenerate your drawing, and
show any cables and there connections between the physically wired items.
5. To make the connections between the items manually, do the following;
a. Select any item on the drawing and do one of the following:
• Click Activate Connection Mode .

• Click Edit > Activate Connection Mode.
b. On the Domain Explorer select the cable you want to connect between two
items.
c. Move the cursor over the drawing to view the available, valid connect points
of the items and cable category on your drawing. For more details, see Place
Point Ribbon (SPEL) in the Catalog Managers User's Guide, under Working
with Symbols, Place Point Command, Place Point Ribbon (SPEL).
d. Click the connect point of the item you want the cable to connect 'From'.
e. Click the connect point of the item you want the cable to connect 'To'.
f. Select another cable or click View > Refresh to view the drawing with the
cable attached.
Related Topics

View an Existing Cable Block Diagram

1. On the Domain Explorer, locate the Drawings folder.
2. In the Drawings folder, locate the Cable Block Diagram folder.
3. In the Cable Block Diagram folder, right-click the drawing you want to view,
and from the shortcut menu select Reports > Generate Cable Diagram.
4. At the prompt, click Yes to preview your drawing, the drawing opens in the
Related Topics
Disconnect Cables from Items in a Cable Block Diagram

1. Open the CBD that you want to disconnect cables from. For further details, see
View an Existing Cable Block Diagram, page 642.
2. Select the cable you want to disconnect.
• Click .
• Click Edit > Disconnect.
• Right-click, and on the shortcut menu, click Disconnect Items.
4. At the prompt, select the required check box, and click OK.
Notes
• If the cable for disconnection is only connected to one item, no prompt
will appear and the cable is disconnected automatically.
• Disconnecting both sides of the cable results in the loss of any wiring
associated with the connection.

Remove Items from a Cable Block Diagram

1. Open the CBD that you want to disconnect cables from. For further details, see
View an Existing Cable Block Diagram, page 642.
2. On the drawing, select the item that you want to remove.
• Click .
• Click Edit > Remove.
• Press the Delete key.
Related Topics

Foundation Fieldbus Design

SmartPlant Instrumentation supports the creation and maintenance of Foundation
Fieldbus systems.
Foundation Fieldbus technology has rapidly established itself as a viable process

industry networking methodology. Of the different protocols available currently on
the market, Foundation Fieldbus is the leading product in the process industry. The
SmartPlant Instrumentation fieldbus solution is based on H1 Intrinsically Safe Low
Speed, 31.25 kb/sec Fieldbus, and supports topologies such as star, trunk/drop, and
daisy chain.
The software provides the following features for creating and managing Fieldbus
projects:
• Fieldbus device tags, which you create in the Instrument Index

module, include Fieldbus properties such as identification references,
address, electrical properties, associated function blocks, and so forth.
• The Fieldbus Tag Numbers browser, where you create and manage
fieldbus instruments and associate them with appropriate segments.
Also, you can generate a validation report for a selected segment.
• Fieldbus connection apparatus and Fieldbus bricks, which you create
in the Wiring module. You can quickly and easily create fieldbus
junction boxes and device panels using the Plug-and-Socket Box
Wizard.
• As you build segments, the software verifies that you are following
basic connection rules. Later, you can generate reports to verify that
you built the segments according to further connection rules, and
according to the segment-wide parameter profiles that you applied to
each segment.
• Segment wiring diagrams and Fieldbus Loop enhanced reports.
Note
• Note that whenever Fieldbus is mentioned in the subsequent topics of
the documentation, we refer to Foundation Fieldbus.
Related Topics

Flow of Activities for Foundation Fieldbus Design

The following is a suggested flow of activities for Foundation Fieldbus design in
SmartPlant Instrumentation. Note that you can carry out some of the procedures in a
different order, depending on your preferences or requirements.
1. Define the Segment-Wide Parameters for the current site
Segment-wide parameters allow you to define default settings that serve as design
rules and limitations for the various Foundation Fieldbus and Profibus PA
segments. These parameters affect the function and performance of your fieldbus
system in the following ways:
• If you exceed cable lengths, or hook too many devices to the same pair
of wires, this can cause attenuation and reduction in the voltage
reaching the instruments. These voltage drops can result in instrument
malfunction and bandwidth problems.
• If you create a spur cable that is too long, the signal propagated along
that spur cable can become attenuated and too weak for the DCS to
read.
• If you create a segment whose total capacitance exceeds the
maximum, you may reduce effective bandwidth.
For more information, see Define Segment-Wide Parameters, page 651.
2. Define Foundation Fieldbus instrument type profiles
• Prior to creating new fieldbus instruments, you need to customize
wiring reference items and then define appropriate instrument type
profiles in the Instrument Index module so that new tag numbers
acquire fieldbus properties. This results in automatic assignment of
the required properties to the new tag numbers. For more information,
see Define Foundation Fieldbus and Profibus Instrument Type
Profiles, page 660.
3. Add a new browser view
• In the Browser module, create a browser view with the required fields
for the Fieldbus Tag Numbers browser. This facilitates the
assignment of tag numbers to segments. You can create multiple
Browser views with different Style, Sort, and Filter functions. For
example, by using the filter function you may create independent
views for each segment, so that only tags of that segment will be
displayed in its corresponding view. For more information, see Add a
New View, page 265.

4. Create user-defined function blocks

• Since the software does not allow you to modify or delete the shipped
function blocks, you can create your own function blocks which you
can modify or delete as you see fit. The function blocks that you
define here are available for the current site. You can define function
blocks as multiple with or without execution time. Instruments can be
associated with several function blocks of the same type if that
function block is defined as Multiple. Using the Execution Time
feature allows you to set the time for the function block execution.
You set the number of function blocks and the execution time in the
Function Block – Instrument Type Association dialog box. You
can create a virtual tag and associate it with an existing function block.
Only one virtual tag can be associated with a function block. For more
information, see Create a User-Defined Function Block, page 655.
5. Associate function blocks with instrument types
• Associating function blocks with instrument types enables you to
instruct the software to create and associate a particular function block
when creating a fieldbus instruments. When you create a fieldbus
instrument tag, SmartPlant Instrumentation automatically assigns the
function blocks associated with the instrument type that you select for
the new tag. Note that you can associate a function block with as
many instrument types as required. For more information, see
Associate Function Blocks with Instrument Types, page 656.
6. Create Foundation Fieldbus instruments
• Create your fieldbus device tags based on the instrument types that
you defined, and edit the tag number properties as required, including
function block properties. The software allows you to create various
types of instruments that can be associated with the Foundation
Fieldbus system in your plant. In other words, you can create
instruments that are compatible with Foundation Fieldbus, Profibus
DP, and Profibus PA segments. You add new instruments in the
Instrument Index module, exactly the same way that you create other
tags. Once you define an instrument type for the new tag number and
associate a function block with the new tag's instrument type, the new
instrument automatically acquires all of the appropriate properties that
you set for that tag number. You can then create virtual tags for this
instrument.
For more information, see Create Foundation Fieldbus and Profibus
Instruments, page 661.

7. Associate your function blocks with fieldbus instruments

• This feature enables you to associate a function block with a particular
instrument. You use this feature if for some reason, the current tag
number has not been associated with any function block through the
tag's instrument type or if you need to change some of the associations.
Note that the association or any changes made to the association will
affect the current tag number only. For more information, see
Associate Function Blocks with Instruments, page 664.
8. Create your fieldbus segments and associate them with fieldbus instruments
• Now you are ready to create your fieldbus segments, associate the
appropriate instruments with their respective segments, and create the
necessary virtual tags. For more information, see the following:
• Create a Foundation Fieldbus Segment, page 666
• Associate an Instrument with a Segment, page 668
• Add a Virtual Tag to an Instrument, page 670
9. Design your wiring and termination equipment
• At this stage you need to create your fieldbus I/O cards and if you are
going to use the plug-and-socket communication system, create your
fieldbus plug-and-socket boxes. For more details, see the following:
• Create a Fieldbus I/O Card, page 698
10. Add your home-run cables and spurs.
• For details, see Managing Fieldbus Cables Common Tasks, page 671.
11. Make the required connections and associations
• At this stage you are ready to make the required connections and
associations. However, before you can associate a segment with a
home-run cable or connect a home-run cable to a plug-and-socket box,
you need to configure various connector types assign connector pins to
wires. For more information, see Making Connections and
Associations for Fieldbus Common Tasks, page 689.
12. Effect the I/O assignment
• For details, see Effect Fieldbus I/O Assignment, page 700.
13. Generate fieldbus validation reports
• As you build the segments, and make connections and effect I/O
assignments, the software verifies that you are following basic fieldbus
rules. Later, you can generate reports to verify that you built the
segments according to additional connection rules and according to the
segment-wide parameter profiles that you applied to each segment.
For details, see Fieldbus Validation: An Overview, page 701.

14. Generate a segment wiring report

• You can generate an enhanced segment wiring drawing to view the
completed segment. For details, see Generate a Segment Wiring
Report, page 706.
15. Generate a specification
• In the Specifications module you can associate tags with fieldbus
forms to generate specifications. For details, see Principles of
Generating Specifications, page 781.
• If you encounter difficulty in activating a library form for fieldbus, you
should restore the form. For details, see Restore Library Forms, page
830.
• Also, you can add function block custom fields to fieldbus
specifications. For details, see Add Function Block Custom Fields to a
Fieldbus Spec, page 819.
16. Generate a hook-up drawing
• You can also generate a hook-up drawing for your fieldbus
instruments just like for conventional instruments. For details see
Working with Hook-Ups: An Overview, page 1058.

Preliminary Definitions for Foundation Fieldbus

Common Tasks
The following tasks are used frequently when you make preliminary Foundation
Fieldbus definitions.
Define Segment-Wide Parameters

Segment-wide parameters allow you to define default settings that serve as design
rules and limitations for the various Foundation Fieldbus and Profibus PA segments.
These parameters affect the function and performance of your fieldbus system in the
following ways:
• If you exceed cable lengths, or hook too many devices to the same pair
of wires, this can cause attenuation and reduction in the voltage
reaching the instruments. These voltage drops can result in instrument
malfunction and bandwidth problems.
• If you create a spur cable that is too long, the signal propagated along
that spur cable can become attenuated and too weak for the DCS to
read.
• If you create a segment whose total capacitance exceeds the
maximum, you may reduce effective bandwidth.
For more information, see Define Segment-Wide Parameters, page 651.
Create a User-Defined Function Block

You use this feature to add new user-defined function blocks, delete redundant ones,
or modify the definition of existing user-defined function blocks. The function
blocks that you define here are available for the current site. You can define function
blocks as multiple with or without execution time. Instruments can be associated
with several function blocks of the same type if that function block is defined as
Multiple. Using the Execution Time feature allows you to set the time for the
function block execution. You set the number of function blocks and the execution
time in the Function Block – Instrument Type Association dialog box. You can
create a virtual tag and associate it with an existing function block. Only one virtual
tag can be associated with a function block.
For more information, see Create a User-Defined Function Block, page 655

Associate Function Blocks with Instrument Types

Associating function blocks with instrument types enables you to instruct the
software to create and associate a particular function block when creating a fieldbus
instruments. When you create a fieldbus instrument tag, SmartPlant Instrumentation
automatically assigns the function blocks associated with the instrument type that you
select for the new tag. Note that you can associate a function block with as many
instrument types as required.
For more information, see Associate Function Blocks with Instrument Types, page
656.
Manage the Functions Blocks Supporting Table

This option shows you how to use this supporting table 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. You can also enable the Multiple
and Execution Time features for any existing function block. For more information,
see Manage the Functions Blocks Supporting Table, page 657.
Related Topics

Define Segment-Wide Parameters

2. On the main menu bar, click Tables > Segment-Wide Parameter Profiles.
3. In the Segment-Wide Parameter Profiles dialog box, click New.
4. In the Segment-Wide Parameter Profiles Properties dialog box, click the
General tab, and do the following:
• Name— Type a unique name for the profile.
• Description— Type a description for the profile.
5. Select the profile as Default, or leave it unselected.
Tip
• If selected, when you add a new segment, this profile will be the
default setting associated with the new segment.
6. In the Maximum number of devices group box, do the following:
• Per spur— Type the maximum number of tag numbers that can be
connected with one spur.
• Per segment— Type the maximum number of tag numbers that can
be associated with one segment.
• Per intrinsically safe (IS) segment— Type the maximum number of
tag numbers that can be associated with one intrinsically safe segment.
7. In the Maximum number of assigned function blocks group box, do the
following:
• Per I/O card— Type the maximum number of function blocks that
can be associated with one I/O card.
• Per segment— Type the maximum number of function blocks that
can be associated with one segment.
8. In the Electrical parameters group box, do the following:
• Power supply— Type the available voltage source value, in volts.
• Minimum receiver voltage— Type the minimum receiver voltage
value that can be read by a DCS, in volts.
• Allowable current per non IS segment— Type the maximum
allowable value for the current consumption in the non-intrinsic safety
segments, in milliamperes.
• Allowable current per IS segment— Type the maximum allowable
value for the current consumption in the intrinsic safety segments, in
milliamperes.

• Maximum capacitance— Type the maximum allowable segment

capacitance in the unit of measure selected at right.
9. Click the Cable Lengths tab.
10. In the Recommended spur cable lengths group box, define the rules for spur
cables connecting instruments to home-run cables. Do the following:
• Select the required unit of measure (meters or feet).
• In the Number of devices per segment columns, type the number of
devices per segment for which you want to set the spur lengths. Make
sure that you do not exceed the number of devices that you defined in
the Maximum number of devices group box.
• In the Number of devices per spur columns, type the maximum
allowable length of the spur cables for each definition.
• You can click New to add a row, or Delete to delete the row marked
by .
See Spur Cable Lengths Example, page 653.
11. Click OK to confirm your creation of this profile and return to the Segment-
Wide Parameter Profiles dialog box.
Tip
• You can return to Step 3 to create an additional segment-wide
parameter profile.
12. Click OK to close the Segment-Wide Parameter Profiles dialog box and return
to the main window of the Wiring module.
Related Topics
• Fieldbus Validation: An Overview, page 701
• Preliminary Definitions for Foundation Fieldbus Common Tasks, page
649

Spur Cable Lengths Example

The following example shows the rules that are set for the lengths of individual spur
cables connecting a junction box to instruments in a variety of fieldbus topologies.
For example, as shown in row 3, where 15 to 18 devices are associated per segment,
and one instrument is associated per spur, the cable can be up to 60 meters long. If
we allow 2 instruments per spur with the same number of associated devices per
segment, each cable can run up to 30 meters, and so forth.
In this example, the recommended spur cable lengths are:
• 120 meters for 1 to 12 devices per segment and one device per spur;
• 90 meters for 1 to 12 devices per segment and two devices per spur;
• 60 meters for 1 to 12 devices per segment and three devices per spur;
• 30 meters for 1 to 12 devices per segment and four devices per spur;
• 90 meters for 13 to 14 devices per segment and one device per spur;
and so forth.
Related Topics
• Define Segment-Wide Parameters, page 651

Working with Function Blocks: An Overview

Function blocks are smart devices that hold control software on fieldbus instruments.
These smart devices or microprocessors enable fieldbus instruments to perform
control functions independently of a DCS. There are many types of function blocks.
Each function block has a specific purpose. SmartPlant Instrumentation provides a
set of the most common function blocks, with properties defined by Fieldbus
Foundation. You cannot delete these shipped function blocks or rename them, but
you can modify their definitions if needed. You can also create user-defined function
blocks, which you can modify and delete, as you need.
Profibus PA function blocks are shipped with the software and you cannot add, delete
or modify any of them.
Function blocks are associated with a particular instrument type. This association
then allows you to create new tag numbers that are automatically associated with
those particular function blocks. The software allows you to associate multiple
function blocks with a single instrument type. For example, a basic flow transmitter
will have one AI (analog input) block associated with it. However, a similar
instrument may be used to measure also pressure and temperature (required for gas
flow compensation), and may be further equipped with one or more alarm functions.
An AI function block is required for each additional process measurement and an AA
(analog alarm) block for each alarm function. You can also associate existing
instruments with function blocks, or modify associations as needed.
Note
• You cannot create virtual tags for an instrument that is not associated
with at least one function block.
Related Topics
• Associate Function Blocks with Instrument Types, page 656
• Associate Function Blocks with Instruments, page 664
• Create a User-Defined Function Block, page 655
• Create Foundation Fieldbus and Profibus Instruments, page 661
649

Create a User-Defined Function Block

2. On the Instrument Index module menu bar click Tables > Function Blocks.
3. In the Function Blocks dialog box, do one of the following:
• To add a new function block, click New.
• To modify the definition of a highlighted function block, click the field
that want to modify.
4. In the Function Block field, type the function block name.
5. In the Description field, type a short description as appropriate.
6. To define the function block as a multiple function block, select Multiple.
Tip
• This will enable you to associate multiple copies of a given functional
block with an instrument type or a specific instrument.
7. To enable entry of an execution time value, select Execution Time.
8. Click OK.
Related Topics
649
• Working with Function Blocks: An Overview, page 654

Associate Function Blocks with Instrument Types

2. On the Instrument Index module menu bar click Tables > Instrument Types.
3. In the Instrument Types dialog box, select a process function type and an
instrument type.
4. Click Profile.
5. In the Instrument Type Profile dialog box, on the General tab, make sure that
the Include I/O type check box is selected, and that you selected Fieldbus from
the list below.
6. In the Function Block – Instrument Type Association dialog box, to assign a
function block to an instrument type, do one of the following:
• In the Unassociated function blocks data window, select the function
block that you want to associate, and click Associate.
• Drag the required function block from the Unassociated function
blocks data window to the Associated function blocks data window.
7. If the required function block is not available in the Function Block –
Instrument Type Association dialog box, add or modify the function blocks in
the Function Blocks dialog box. (For details, see Manage the Functions Blocks
Supporting Table, page 657.)
8. If you customized a given function block in the Function Blocks dialog box, do
the following as needed:
• To set the maximum number of instruments that can be associated
with the current function block, in the Associated function blocks
data window, under Multiple, type the value.
• To set the execution time, under Execution Time, type the time value
(in milliseconds).
9. Click OK.
Related Topics
page 660
• Manage the Functions Blocks Supporting Table, page 657
649

Manage the Functions Blocks Supporting Table

1. On the Instrument Index module menu bar, click Tables > Function Blocks.
2. Click New to append a new data row or click in a field of a selected row to edit
the data.
3. Type the function block values in the appropriate fields as follows:
• Function Block– enter the required function block name.
• Description– type a description for the function block if required.
• Multiple– select the check box to define this function block as a
multiple function block. This will enable you to create multiple
function blocks of the same type when adding or editing a instrument
associated with this function block.
• Execution Time– select the check box to enable execution time
definition for the current function block. You will be able to set the
execution time when associating this function block with an
instrument type or an instrument tag.
4. Click OK.
Note
• You cannot delete or rename shipped function blocks.
Related Topics

Working with the Fieldbus Tag Numbers Browser:

An Overview
The Fieldbus Tag Numbers browser provides for the creation and management of
fieldbus instrument tags and their association with appropriate segments. Also, you
can generate a validation summary report for a selected segment.
The browser displays all the instruments that exist in your fieldbus system. The
instrument properties are displayed in various columns, such as Tag Number, Loop
Number, Service, Segment Name, and so forth. The columns, their sequence, and
row sorting in this pane depend on the Browser view currently selected in the
Browser Manager. The default display is the New Fieldbus Tag Number List view
in the Browser Manager.
To open the Fieldbus Tag Numbers browser, do the following:

1. In the Domain Explorer, expand the Fieldbus Segments folder.
2. Right-click a segment.
3. On the shortcut menu, click Actions > Fieldbus Tag Numbers Browser.
Related Topics
• Change Instrument / Segment Association, page 669
• Delete a Fieldbus Segment, page 669

Managing Fieldbus Instruments Common Tasks

The following tasks are used frequently when you manage instruments for your
Foundation Fieldbus and Profibus systems.
Define Foundation Fieldbus and Profibus Instrument Type Profiles

Prior to creating new fieldbus instruments, you need to customize wiring reference
items and then define appropriate instrument type profiles in the Instrument Index
module so that new tag numbers acquire fieldbus properties. This results in automatic
assignment of the required properties to the new tag numbers. For more information,
see Define Foundation Fieldbus and Profibus Instrument Type Profiles, page 660.
Create Foundation Fieldbus and Profibus Instruments

Create fieldbus device tags based on the instrument types that you defined, and edit
the tag number properties as required, including function block properties.
The software allows you to create various types of instruments that can be associated
with the Foundation Fieldbus or Profibus system in your plant. In other words, you
can create instruments that are compatible with Foundation Fieldbus, Profibus DP,
and Profibus PA segments. You add new instruments in the Instrument Index
module, exactly the same way that you create other tags. Once you define an
instrument type for the new tag number and associate a function block with the new
tag's instrument type, the new instrument automatically acquires all of the appropriate
properties that you set for that tag number. You can then create virtual tags for this
instrument.
For more information, see Create Foundation Fieldbus and Profibus Instruments,
page 661.
Associate Function Blocks with Instruments

This feature enables you to associate a function block with a particular instrument.
You use this feature if for some reason, the current tag number has not been
associated with any function block through the tag's instrument type or if you need to
change some of the associations. Note that the association or any changes made to
the association will affect the current tag number only. For more information, see
Associate Function Blocks with Instruments, page 664.
Related Topics

Define Foundation Fieldbus and Profibus Instrument Type

Profiles
2. In the Instrument Types dialog box, from the Process function list, select an
appropriate process function.
• Click New to create a new instrument type. For details, see Define an
Instrument Type Profile, page 348.
• In the data window, select an existing instrument type.
4. Click Profile.
5. In the Instrument Type Profile dialog box, on the General tab, under
Specification, select an appropriate fieldbus specification.
6. Select Include I/O type, and then from the list, select one of the following:
• Foundation Fieldbus
• Profibus DP
• Profibus PA
7. On the Wiring and Control System tab, select the appropriate reference device
panel and reference cable. For details, see Define a Wiring and Controls System
8. Click the Fieldbus tab.
Tip
• This tab is available only when you select Foundation Fieldbus from
the Include I/O type list. For Profibus instruments, click OK to
complete the procedure.
9. On the Fieldbus tab, select the Include fieldbus check box.
10. Type a fieldbus tag name.
11. Type a fieldbus device address.
12. Type a device identification.
13. Type a DC consumption value in milliamperes.
14. Enter a capacitance setting and select the required unit of measure.
15. Enter a minimum transmit level value.
16. Set a default operating voltage value.
17. Select the Backup link master check box to set new fieldbus instruments as
backup link masters that will take over control functions for the loop in case of
DCS failure.

18. Click Function Block to associate function blocks with instrument types. For
details, see Associate Function Blocks with Instrument Types, page 656.
19. Click OK in the Instrument Type Profile dialog box.
Related Topics
• Managing Fieldbus Instruments Common Tasks, page 659
Create Foundation Fieldbus and Profibus Instruments

1. Press F7 to open in the Domain Explorer.
the Instruments folder, and then click New > Instrument.
expand the Loops folder, right-click a loop, and then click New >
Instrument.
Tip
• To create new fieldbus tag numbers from the Fieldbus Tag Numbers
browser, right-click somewhere in the browser, and then click New
Fieldbus Tag. Continue as described below.
4. In the New Tag Number dialog box, from the Tag class list select one of the
following:
• Foundation Fieldbus— an instrument that can be associated with a
Foundation Fieldbus segment.
• Profibus DP— an instrument that can be associated with a Profibus
DP segment.
• Profibus PA— an instrument that can be associated with a Profibus
PA segment.
5. Under Tag number, type the name of the new tag number.
Tip
• If you are working with the Free naming convention, select the Select
instrument type check box to open a pop-up window that allows you
to select the appropriate instrument type.
6. Click OK.

and click OK.
Tips
• If the tag number does not correspond to an existing loop name,
the tag number you have entered. If the loop identifier already
matches an existing loop, the software will automatically associate the
new tag number with 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 reference items.
• For DeltaV compatibility, you must select an instrument type that you
associated with a DeltaV device type during the downloading process.
To display the Associate Foundation Fieldbus Device Types with
Instrument Type supporting table of associations that you built
among DeltaV device types, instrument manufacturers, and SmartPlant
Instrumentation instrument types, see Associate Foundation Fieldbus
Device Types for DCS Vendors.
• Type the loop number that the new tag is associated with.
Note that if a loop with the same name exists, the tag number is
automatically associated with it, without creating a new loop.
9. Click OK to create the loop number.
10. In the Loop Number Properties dialog box, accept the loop number properties or
modify them as you require and then click OK.
11. In the Tag Number Properties dialog box, on the General tab, enter the tag
number attributes that you require.
Tip
• For DeltaV compatibility, make sure that the value that you select
from the Manufacturer list is among the acceptable values for the
instrument type that you selected for the current tag. For details, see
Crucial Fields for the DeltaV Interface.
12. On the Fieldbus tab, to define the fieldbus properties for the new instrument, type
the fieldbus tag name.
13. Type the field device address if necessary.

14. Type the device ID if necessary.

15. If the new tag functions as a backup that takes over DCS functions in case of DCS
failure in the current segment, select Backup link master.
16. Type the manufacturer's fieldbus device revision number if necessary.
Tips
• If your DeltaV interface preferences are set for fieldbus mode, the
Fieldbus device revision field is a list, from which you must select a
revision.
• SmartPlant Instrumentation uses the values that you enter below to
validate fieldbus segments. For details, see Generate a Validation
Report for One Segment, page 704.
17. Type the DC current consumption of the current instrument, for example, 35 mA.
18. Type the capacitance and the capacitance unit of measure, for example 5 pF.
19. Type the minimum transmit level of the current instrument, for example, 2.5
volts.
20. Type the operating voltage range, for example, 9 – 35 volts.
21. To modify the function block association of the new instrument, in the Function
blocks association group box, under Unassociated function blocks, select a
function block that you want to associate with the instrument, and click
Associate.
Tips
• If your DeltaV interface preferences are set for fieldbus mode, your
selection of manufacturer and of fieldbus device revision determine
function block association for the current tag.
• The following two options are available only if you enabled them in
the Function Blocks dialog box.
22. To change the number of copies of the function block, in the Associated function
blocks data window, under Multiple, type the value.
23. To set the execution time, under Execution Time, type the time value (in
milliseconds).
24. To enter power supply properties, see Enter Power Supply Data for Panels and
Instrument Tags, page 361.
25. Click OK.
Important
• If you are creating items that must be compatible with Emerson
DeltaV, see Crucial Fields for the DeltaV Interface.
Related Topics

Associate Function Blocks with Instruments

1. In the Domain Explorer, expand the Instruments folder and then right-click a
tag number.
3. In the Tag Number Properties dialog box, click the Fieldbus tab.
4. Under Unassociated function blocks, select the function block that you want to
associate, and click Associate.
5. To set the maximum number of instruments that can be associated with the
current function block, in the Associated function blocks data window, under
Multiple, type the value. (The Multiple field is editable only if it was enabled in
the Function Blocks dialog box.)
6. To set the execution time, under Execution Time, type the time value (in
milliseconds). (The Execution Time field is editable only if it was enabled in the
Function Blocks dialog box.)
7. Click OK.
Related Topics
page 660
• Managing Fieldbus Instruments Common Tasks, page 659
Fieldbus Tag Numbers

The Fieldbus Tag Numbers browser displays all the instrument tags that exist in
your fieldbus system. The instrument properties are displayed in various columns,
such as Tag Number, Loop Number, Service, Segment Name, and so forth. The
columns, their sequence, and row sorting depend on the Browser view currently
selected in the Browser Manager. The default display is the New Fieldbus Tag
Number List view in the Browser Manager. You can create a new view and then
select it in the Fieldbus Tag Numbers browser by clicking .
The following actions are possible when you select one of the tag numbers:
Add a new instrument tag to your fieldbus system.

Click on the toolbar or right-click in the browser and then click New Fieldbus
Tag on the shortcut menu. For details, see Create Foundation Fieldbus and Profibus

Associate an instrument with a segment.

Select an instrument tag and drag it to the required segment in the Fieldbus
Segments folder of the Domain Explorer. For details, see Associating an Instrument
with a Segment, page 668.
Select another view for the instrument tags.

Click or select Change View on the Actions or the shortcut menu.
Find a value in the Fieldbus Tag Numbers browser.

Click on the column header where you want to search for an item and then click or
select Find on the Actions or the shortcut menu.
Managing Segments Common Tasks

The following tasks are used frequently when you manage segments for your
Create a Foundation Fieldbus Segment

A Foundation Fieldbus segment is a group of devices physically connected by a
single pair of wires to a host control device. This procedure explains how to add a
new segment to your fieldbus system. For more information, see Create a
Foundation Fieldbus Segment, page 666.
Edit the Properties of a Foundation Fieldbus Segment

This feature allows to edit the properties of a Foundation Fieldbus segment. You can
rename a segment, select another segment-wide parameter profile, and set the
segment as intrinsically safe. For more information, see Edit the Properties of a
Foundation Fieldbus Segment, page 667.
Delete a Fieldbus Segment

Use this feature to delete a segment. For more information, see Delete a Fieldbus
Segment, page 669.
Associate an Instrument with a Segment

This feature enables you to associate a segment with a particular instrument. You use
this feature if for some reason, the current tag number has not been associated with
any segment or if you need to change some of the associations. Note that the
association or any changes made to the association will affect the current tag number
only. For more information, see Associate an Instrument with a Segment, page 668

Dissociate an Instrument from a Segment

You use this procedure when you need to dissociate a particular instrument from its
segment. For more information, see Dissociate an Instrument from a Segment, page
668.
Change Instrument / Segment Association

You use this procedure when you need to dissociate a particular instrument from its
segment. For more information, see Change Instrument / Segment Association, page
669.
Enable a Function Block for I/O Assignment

This procedure shows how to enable a function block for I/O assignment. You can do
this after associating an instrument with a segment. Note that without enabling
function blocks, segment I/O assignment cannot be effected. For more information,
see Enable a Function Block for I/O Assignment, page 670.
Change the View in the Fieldbus Tag Numbers Browser

This option allows you to change the current view of the Fieldbus Tag Numbers
browser. The view, (that is, the available fields) depends on the current view in the
Fieldbus Tag Number List browser. For more information, see Change the View in
the Fieldbus Tag Numbers Browser, page 670.
Related Topics
Create a Foundation Fieldbus Segment

1. In the Domain Explorer, right-click the Fieldbus Segments folder.
2. On the shortcut menu, click New > Fieldbus Segment.
3. On the Foundation Fieldbus Segment Properties dialog box, under Segment,
type a unique name for the new segment.
4. Select a profile from the Segment-wide parameter profile list. If necessary,
click to open the Segment-Wide Parameter Profile dialog box to edit or
define a new segment-wide parameter profile. For details, see Define Segment-
Wide Parameters, page 651.


• Select Intrinsically safe for this segment. SmartPlant Instrumentation
warns you if any instruments currently associated with this segment
are not intrinsically safe. The software also warns you if an instrument
you try to associate with this segment in the future is not intrinsically
safe.
• Clear Intrinsically safe. SmartPlant Instrumentation warns you if any
instruments currently associated with this segment are intrinsically
safe. The software will also warn you if an instrument you try to
associate with this segment in the future is intrinsically safe.
6. Click OK to create the new segment.
Related Topics
• Connect a Home-Run Cable to a Plug-and-Socket Box, page 695
• Managing Segments Common Tasks, page 665
Edit the Properties of a Foundation Fieldbus Segment

1. In the Domain Explorer, double-click the Fieldbus Segments folder.
2. Right-click a segment and then on the shortcut menu. click Properties.
3. In the Foundation Fieldbus Segment Properties dialog box, under Segment,
type a unique name for the new segment.
4. Select a profile from the Segment-wide parameter profile list. If necessary,
click to open the Segment-Wide Parameter Profile dialog box to edit or
define a new segment-wide parameter profile. For details, see Define Segment-
Wide Parameters, page 651.
• Select Intrinsically safe for this segment. SmartPlant Instrumentation
warns you if any instruments currently associated with this segment
are not intrinsically safe. The software also warns you if an instrument
you try to associate with this segment in the future is not intrinsically
safe.
• Clear Intrinsically safe. SmartPlant Instrumentation warns you if any
instruments currently associated with this segment are intrinsically
safe. The software will also warn you if an instrument you try to
associate with this segment in the future is intrinsically safe.
Related Topics

Associate an Instrument with a Segment

1. On the Wiring module menu bar, click Actions > Fieldbus Tag Numbers
Browser.
2. In the Fieldbus Tag Numbers browser, select an appropriate tag number.
3. Drag the highlighted instrument to the required segment in the Fieldbus
Segments folder of the Domain Explorer.
Notes
• The associated instrument appears under the selected segment in the
Fieldbus Segments folder of the Domain Explorer.
• A fieldbus instrument can be associated only with one fieldbus
segment. However, you can associate multiple tag numbers with a
given fieldbus segment.
Related Topics
Dissociate an Instrument from a Segment

2. Expand the hierarchy of a segment.
3. Right-click an instrument and then on the shortcut menu, click Actions >
Dissociate Item.
Note
• The Segment Name field in the Instruments
Related Topics

Change Instrument / Segment Association
Browser.
2. In the Domain Explorer, double-click the Fieldbus Segments folder and expand
the appropriate segments.
3. Right-click an instrument tag, and then, on the shortcut menu, click Actions >
Dissociate Item from Segment.
4. In the Fieldbus Tag Numbers browser, select the dissociated tag and drag it to
the target segment in the Fieldbus Segments folder.
Notes
• You cannot change the segment association of a connected instrument
before disconnecting its wiring.
• The Segment Name field in the Fieldbus Tag Numbers
Related Topics
Delete a Fieldbus Segment

2. Select a segment you want to delete, and do one of the following:
• Press the Delete key.
• Right-click a segment and then on the shortcut menu, click Delete.
3. Click Yes to confirm the segment deletion.
Note
• After deleting a segment, the software dissociates all the associated
instruments and deletes the relevant virtual tags.
Related Topics

Enable a Function Block for I/O Assignment

1. In the Domain Explorer, under Fieldbus Segments, expand the appropriate
segment to display the associated instruments.
2. Right-click the required function block under the highlighted tag number.
3. On the shortcut menu, click Actions > Enable.
Related Topics
Change the View in the Fieldbus Tag Numbers Browser

1. Predefine the required Fieldbus Tag Number List Browser views in the Index
Browser Group of the Browser Manager.
For details, see Add a New View, page 265.
2. In the Fieldbus Tag Numbers browser, do one of the following:
• Click Actions > Select Browser View for Segments.
• Click
3. In the Segment Views dialog box, select the required view and then click OK.
Related Topics

Managing Fieldbus Cables Common Tasks

The following tasks are used frequently when you manage fieldbus cables for your
Create a Home-Run Cable

A home-run cable is the main communication highway between devices on a fieldbus
network. A home-run cable serves the spurs in a given segment, and has a terminator
at either end. For more information, see Create a Home-Run Cable, page 671.
Create a Spur Cable

A spur is a part of a segment that drops off from the main segment (home-run) trunk.
A spur may contain one or more instruments and cables that connect them to the
home-run segment. For more information, see Create a Spur Cable, page 672.
Related Topics
Create a Home-Run Cable

2. Right-click the Cables folder and then on the shortcut menu, click New > Home-
Run Cable.
3. In the Cable Configuration dialog box, do one of the following:
• From the Cable configuration list, select an appropriate cable
configuration (for example, Fieldbus cable).
• Define a new cable configuration. For details, see Define a Cable
Configuration, page 438.
4. Click Create.
5. In the Cable Properties dialog box, under Cable, type a unique name.
Tip
• In the Cable Properties dialog box, make sure that you select
Fieldbus home-run from the Cable class list.
6. Complete the creation of the home-run cable using the general procedure for
creating a new cable. For details, see Create a Cable, page 441.
Related Topics
• Associate a Segment with a Home-Run Cable, page 696
• Create a Cable, page 441
• Define a Cable Configuration, page 438

Create a Spur Cable

2. Right-click the Cables folder and then on the shortcut menu, click New > Cable.
3. In the Cable Configuration dialog box, do one of the following:
• From the Cable configuration list, select an appropriate cable
configuration (for example, Fieldbus cable).
• Define a new cable configuration. For details, see Define a Cable
Configuration, page 438.
4. Click Create.
5. In the Cable Properties dialog box, under Cable, type a unique name.
Tip
• In the Cable Properties dialog box, make sure that you select
Conventional from the Cable class list.
6. Complete the creation of the home-run cable using the general procedure for
creating a new cable. For details, see Create a Cable, page 441.
Related Topics
• Create a Cable, page 441
• Define a Cable Configuration, page 438
• Managing Fieldbus Cables Common Tasks, page 671

Fieldbus Plug-and-Socket Boxes: An Overview

You need plug-and-socket boxes to connect Foundation Fieldbus instruments to a
spur or a home-run cable that has a plug-and-socket connection.
SmartPlant Instrumentation supports active plug-and-socket junction boxes, that is,

plug-and-socket junction boxes that require power supply. You can define the current
consumption, open circuit voltage, and short-circuit protection for an active plug-and-
socket junction box. When generating a segment validation report, the software takes
these values into account when calculating the total segment current consumption and
voltage drop for a particular segment.
You use the Plug-and-Socket Box Wizard to create the required plug-and-socket
boxes or reconfigure the existing ones.
Plug-and-socket boxes can be device panels or junction boxes.
Related Topics
• Managing Fieldbus Panels (Plug-and-Socket Boxes) Common Tasks,
page 674

Managing Fieldbus Panels (Plug-and-Socket Boxes)

Common Tasks
The following tasks are used frequently when you manage panels for your Foundation
Fieldbus and Profibus systems.

This procedure explains how to create a new plug-and-socket device panel. For more
information, see Create a Plug-and-Socket Device Panel, page 675.
Edit the Properties of a Plug-and-Socket Device Panel

This procedure explains how to modify the properties of a plug-and-socket device
panel. For more information, see Edit the Properties of a Plug-and-Socket Device
Panel, page 676.
Create a Plug-and-Socket Junction Box

This feature allows to create a plug-and-socket junction box. For more information,
see Create a Plug-and-Socket Junction Box, page 676.
Edit the Properties of a Plug-and-Socket Junction Box

This feature explains how to modify the properties of a plug-and-socket junction box.
For more information, see Edit the Properties of a Plug-and-Socket Junction Box,
page 677.
Related Topics
• Connect a Home-Run Cable to a Plug-and-Socket Box, page 695


then on the shortcut menu click New > Device Panel (Plug-and-
Socket).
• Double-click the Panels by Category folder, right-click the Device
Panels folder and then on the shortcut menu click New > Device
Panel (Plug-and-Socket).
3. In the Plug-and-Socket Box wizard, follow all the instructions carefully and then
click Next until you complete the wizard.
Notes
• You can click next to a list arrow to access the appropriate
supporting table. This allows you to add, edit, or delete select list
items.
• When defining the plug-and-socket box connectors, under Connector
type definition display, SmartPlant Instrumentation displays the
connector sequence, the appropriate pin number, and the pin polarities
according to the configuration of the connector than you selected.
Related Topics
page 674

Create a Plug-and-Socket Junction Box

then on the shortcut menu click New > Device Panel (Plug-and-
Socket).
• Double-click the Panels by Category folder, right-click the Device
Panels folder and then on the shortcut menu click New > Device
Panel (Plug-and-Socket).
3. In the Plug-and-Socket Box wizard, follow all the instructions carefully and then
click Next until you complete the wizard.
Notes
items.
Related Topics
page 674
Edit the Properties of a Plug-and-Socket Device Panel

• Double-click the Panels by Location folder, right-click a device panel
and then on the shortcut menu click Properties.
• Double-click the Panels by Category folder, right-click a device panel
3. In the Plug-and-Socket Box wizard, follow all the instructions carefully and click
Next until you complete the wizard.

Notes
• The software does not allow you to modify port and connector
configurations of an existing plug-and-socket device panel.
items.
Related Topics
page 674
Edit the Properties of a Plug-and-Socket Junction Box

• Double-click the Panels by Location folder, right-click a junction box
• Double-click the Panels by Category folder, right-click a junction box
Notes
• The software does not allow you to modify port and connector
configurations of an existing plug-and-socket junction box.
items.
Related Topics

Working with Terminators: An Overview

Terminators are used to terminate and provide impedance compensation at a segment
end. Two terminators are needed for each segment — one on the DCS/PLC
terminal side (beginning of the segment) and the other on its other end.
There are two types of terminators — internal terminators (in relation to a

terminating block) and external (fitted on as a separate accessory).
You can create internal or external terminators as required, whether it is a terminal

apparatus strip or a plug-and-socket termination block.
You create internal terminators using the configuration tools when creating plug-and-
socket boxes or termination blocks. External terminators are added to the termination
block (an apparatus or a plug-and-socket box) during the wiring design phase.
Related Topics
• Managing Terminators Common Tasks, page 678
Managing Terminators Common Tasks

The following tasks are used frequently when you manage terminators for your
Create an External Terminator in a Plug-and-Socket Box

This feature enables you to create an external terminator in an existing plug-and-
socket box. For more information, see Create an External Terminator in a Plug-and-
Socket Box, page 680.
Create an External Terminator on a Terminal Strip

You can place an external terminator on a terminal in an apparatus or a conventional
terminal strip, i.e., a junction box, marshaling rack, and so forth. For more
information, see Create an External Terminator on a Terminal Strip, page 680.
Move an External Terminator to Another Port in a Plug-and-Socket Box

Usually, an external terminator is added when you create a plug-and-socket box. You
can disconnect a terminator or move it to another port in a plug-and-socket box if
required. For more information, see Move an External Terminator to Another Port in
a Plug-and-Socket Box, page 681.

Create an Internal Terminator

Internal terminators are usually added when creating plug-and-socket boxes and
termination blocks. You can also add an internal terminator to an existing plug-and-
socket box or termination block if it hasn't been done during the creation process. If a
plug-and-socket box does not contain an internal terminator, edit the properties of the
required box in the Plug-and-Socket Box wizard. For more information, see Create
an Internal Terminator, page 681.
Terminator (Plug-and-Socket Box) — Segment Association

After creating an external terminator, you need to associate it with an existing
segment. This option enables you to associate an external terminator with an existing
segment where the terminator is located in a plug-and-socket box. For more
information, see Terminator (Plug-and-Socket Box) — Segment Association, page
682.
Terminator (Terminal Strip) — Segment Association

After creating an external terminator, you need to associate it with an existing
segment. This option enables you to associate an external terminator with an existing
segment where the terminator is located on a terminal strip. For more information,
see Terminator (Terminal Strip) — Segment Association, page 682.
Related Topics
Tasks, page 684

Create an External Terminator in a Plug-and-Socket Box

1. In the Domain Explorer select a plug-and-socket box.
2. Right-click the selected plug-and-socket box and then on the shortcut menu, click
3. In the Plug-and-Socket Box Connection window, right-click the required port
and then on the shortcut menu, click New Terminator.
4. In the Plug-and-Socket Box Terminator dialog box, make sure the correct port
is displayed in the Port list. Select the required port if needed.
5. Click Create to add the new terminator and close the dialog box.
Note
• You can now associate this terminator with a segment. Right-click the
selected terminator and then on the shortcut menu, click Associate
Segment.
Related Topics
• Working with Terminators: An Overview, page 678
Create an External Terminator on a Terminal Strip

1. In the Domain Explorer, select a panel.
2. Right-click the selected panel and then on the shortcut menu, click Actions >
Connection.
3. In the Connection window, make sure that the required terminal strip is selected
in the Terminal Strip list.
4. Right-click the required terminal and then on the shortcut menu, click New
Terminator.
5. In the New Terminator dialog box, make sure the correct first terminal is
displayed in the First terminal list.
Select the required first terminal if needed.
6. Select an appropriate terminal side.
7. Enter the required number of terminals that you want to terminate.
The new terminator appears in pink next to the selected terminal. You can now
associate the terminal with a segment.
Related Topics

Create an Internal Terminator

1. In the Domain Explorer, select a plug-and-socket box.
Properties.
3. In the Plug-and-Socket Box wizard, click Next twice till you open the Modify
the Plug-and-Socket Layout page in the Plug-and-Socket Box wizard.
4. Select the Internal Terminator check box and click Next.
5. Continue configuring the plug-and-socket box as needed.
Related Topics
Move an External Terminator to Another Port in a Plug-and-

Socket Box
3. In the Plug-and-Socket Box Connection window, right-click the required port
and then on the shortcut menu, click Disconnect Selected Items.
4. Right-click the required port and on the shortcut menu, click New Terminator.
5. In the Plug-and-Socket Box Terminator dialog box, make sure the correct port
is displayed in the Port list. Select the required port if needed.
Note
• You can now associate this terminator with a segment. Right-click the
selected terminator and then on the shortcut menu, click Associate
Segment.
Related Topics

Terminator (Plug-and-Socket Box) — Segment Association

3. In the Plug-and-Socket Box Connection window, click the required connected
home-run cable to select it.
4. Right-click the highlighted home-run cable and on the shortcut menu, click
Associate Segment to open the Segment Association dialog box.
5. From the Associate segment list, select a segment with which you want to
associate the current terminator.
Tip
• If the required segment is not available on the Associate segment list,
select the Include all segments option button in the Segment filter
group box.
6. Click OK to make the association.
Related Topics
Terminator (Terminal Strip) — Segment Association

1. In the Domain Explorer, expand the hierarchy of a panel.
2. Right-click an appropriate fieldbus strip and then on the shortcut menu, click
3. In the Connection window, make sure that the required terminal strip is selected
in the Terminal strip list.
4. Right-click the required terminator and on the shortcut menu, click Associate
Segment to open the Segment Association dialog box.
5. From the Associate segment list, select a segment with which you want to
associate the current terminator.
Tip
• If the required segment is not available on the Associate segment list,
group box.
Related Topics

Fieldbus Bricks: An Overview

When designing your Foundation Fieldbus or Profibus system, you need to create a
Fieldbus brick assembly. A fieldbus brick assembly is a composite object that
consists of a wiring equipment item (fieldbus brick) and an apparatus group. An
apparatus group constitutes an apparatus strip (that is, a terminal strip) with a number
of apparatuses created according to a selected apparatus configuration.
When creating a fieldbus brick, you can define power supply requirements and
current consumption. Adding an apparatus to a fieldbus brick, entails the definition
of an apparatus configuration and the number of apparatuses that you need. Note that
the power supply requirements and current consumption values are common to all the
existing apparatuses belonging to the apparatus group that exists under a fieldbus
brick. Therefore, changing an electric property values affects all the apparatuses that
exist under that fieldbus brick. For more details about wiring equipment and
apparatuses, see Wiring Equipment: An Overview, page 485.
When generating a segment validation report, the software takes into account the
fieldbus brick electric properties and validates the total current of a segment.
We recommend that first you create your equipment in the Reference Explorer so
that you have as many typical configurations as possible. Then, you can copy these
typical configurations to the Domain Explorer and this way create numerous
fieldbus bricks on the fly.
Related Topics

Managing Fieldbus Brick Assemblies and

Apparatuses Common Tasks
The following tasks are used frequently when you manage fieldbus brick assemblies
and apparatuses for your Foundation Fieldbus and Profibus systems.
Create a Fieldbus Brick Assembly

When designing your Foundation Fieldbus or Profibus system, you need to create a
fieldbus brick assembly. A fieldbus brick assembly is a composite object that
consists of a wiring equipment item (fieldbus brick) and an apparatus group. An
apparatus group constitutes an apparatus strip (that is, a terminal strip) with a number
of apparatuses created according to a selected apparatus configuration. When
creating a fieldbus brick, you can define power supply requirements and current
consumption. Note that if there are several apparatuses under a fieldbus brick, the
power supply requirements and current consumption values are common to all the
existing apparatuses belonging to that fieldbus brick. Therefore, changing an electric
property values affects all the apparatuses that exist under that fieldbus brick.
We recommend that first you create your equipment in the Reference Explorer so
that you have as many typical configurations as possible. Then, you can copy these
typical configurations to the Domain Explorer and this way create numerous
fieldbus bricks on the fly.
For more information, see Create a Fieldbus Brick Assembly, page 685.

To create a fieldbus brick assembly, you must have a predefined apparatus group
configuration An apparatus group constitutes an apparatus strip (that is, a terminal
strip) with a number of apparatuses created according to a selected apparatus
configuration. When defining an apparatus configuration, you define the apparatus
profile (name, description, manufacturer, and model), the number of apparatuses, the
apparatus terminal configuration, and the position numbering. For more information,
see Configure a Fieldbus Apparatus, page 687.
Related Topics

Create a Fieldbus Brick Assembly

1. Press F8 to open the Reference Explorer.
2. Double-click the Panels folder, and select a panel.
3. Right-click the selected panel and then on the shortcut menu, click New > Wiring
Equipment.
4. On the New Wiring Equipment dialog box, from the Category list, select
Fieldbus brick.
5. Under Name, type the name of the new fieldbus brick and click OK.
6. In the Wiring Equipment Properties - Fieldbus Brick dialog box, on the
General tab, type the name of the new fieldbus brick.
7. Select the Double width check box if the fieldbus brick occupies a double width
slot or position.
• Type a description.
• Select a type, model, and manufacturer. If the required value is not
• Enter a sequence if you need to define the card sequence.
9. Click the Category Properties tab to enter the power supply requirement and
current consumption values for the reference fieldbus brick.
Tip
• Fieldbus brick is a wiring equipment category that is shipped with
category properties that have been shipped with the software.
However, you can add user-defined properties which you can rename
or delete as you wish. For details, see Add User-Defined Wiring
Equipment Category Properties, page 491. Note that the software uses
the Current consumption and the User-defined current
consumption values in segment validation reports.
10. Click the Associated Symbols tab to associate a symbol with this item . The
12. In the Reference Explorer, right-click the new fieldbus brick, then on the

13. In the Apparatus dialog box, select the required configuration from the
Configuration name list. Make sure that this is configuration is compatible with
fieldbus and that the Fieldbus apparatus check box is selected.
Tip
• If you do not have an appropriate apparatus configuration, create one.
(For details, see Configure a Fieldbus Apparatus, page 687).
14. Enter the number of apparatuses that you require.
15. Click Create.
Tip
• SmartPlant Instrumentation automatically assigns sequential position
numbers to each apparatus. You can edit them later if required. (For
details, see Edit Apparatus Terminal Properties, page 510).
16. In the Terminal Strip Properties dialog box, define the new apparatus strip as
required click OK. (For details, see Create a Terminal Strip, page 518).
17. Click Close in the Apparatus dialog box.
Tip
• The new apparatus appears in the Reference Explorer under the
current fieldbus brick.
18. Drag the new fieldbus brick to a panel in the Domain Explorer.
Tip
• The software copies the fieldbus brick assembly that includes the
fieldbus brick and the apparatus.
19. In the Terminal Strip Properties dialog box, rename the fieldbus brick, modify
the other properties as you require, and then click OK.
20. Connect the apparatus to the appropriate cables. Select the apparatus strip you
want to connect and click . The Connection window opens displaying the
apparatus terminals in yellow:
Related Topics
Tasks, page 684


and select a panel.
and select a panel.
a panel.
3. Right-click a panel to which you want to add a fieldbus termination block and
then on the shortcut menu, click New > Apparatus Group.
4. In the Apparatus dialog box, click New.
6. Select the Fieldbus apparatus check box.
7. Select the Internal terminator check box if you need to add an internal
terminator on the new termination block.
8. In the Description field, type a short description for the new configuration.
9. From the Manufacturer list, select the appropriate termination block
to add or edit values for this list.
10. From the Model list, select the appropriate termination block model. If the
for this list.
termination blocks to be added. This way you can have a block of more than one
termination block to a strip.
12. In the Apparatus numbering group box, type the apparatus name in the Prefix
field if required.
Tip
• Apparatus names can be 15-character long. This name will appear in
the Domain Explorer within the new strip (only the first four
characters), in the Connection window, and in the appropriate reports.

13. Select the Numbered check box to number the apparatuses.

14. In the Apparatus configuration group box, from the Orientation list, select one
of the following apparatus terminal patterns:
• Left / Right— a termination block that has two sides: input and
output (that is, left and right).
• Left— a termination block that has wires on the left side only.
• Right— a termination block that has wires on the right side only.
• Regular— a termination block that has a conventional terminal that
functions as a single unit.
15. Do the following to define the apparatus terminal name and color:
a. Click in the left and/or right terminal side text box and type the required
terminal name, for example 1A:
b. Select a color of the terminal side from the list, for example red:
16. Repeat steps 17 and 18 for the other terminal side if appropriate. Note that the
line between the two terminal list arrows represents the internal relation between
the input and output terminals.
17. Click Add Terminal to add another terminal to this apparatus configuration if
needed and then repeat steps 14 through 16.
18. Click Delete Terminal if you need to delete a selected terminal from the current
configuration.
19. Click Save and then Close. You can now add the required termination block as
needed.
Related Topics
Tasks, page 684

Making Connections and Associations for Fieldbus

Common Tasks
The following tasks are used frequently when you make connections and associations
in you fieldbus system. Before you can associate a segment with a home-run cable or
connect a home-run cable to a plug-and-socket box, you need to configure various
connector types assign connector pins to wires.

A connector type contains pin configuration and other properties for a connector
model of a specific manufacturer. When you create a connector for a specific cable,
selecting a connector type copies these properties for the cable connector. For more
information, see Define or Edit a Connector Type, page 691.

This topic explains how to define or edit a pin configuration for a connector type. For
more information, see Define or Edit a Connector Type Pin Configuration, page 691.

This topic shows how to delete a connector type. For more information, see Delete a
Connector Type, page 692.
Create a Connector


This procedure shows how to assign connector pins to cable wires. For more
information, see Assign Connector Pins to Cable Wires, page 693.


SmartPlant Instrumentation enables you to associate terminals and pins with wiring
equipment channels. Note that these terminals and the terminal strip must belong to
the same parent wiring equipment. Also, if you want to associate pins, the pins must
belong to a connector which is a child item of the parent wiring equipment.
After you drag a terminal or a pin to a wiring equipment channel, the software retains
it in its original place from which you dragged it. However, after expanding the
destination hierarchy, the software also shows the terminal or pin that you dragged.
This means that the terminal or pin is physically located in its original place but it is
For more information, see Associate a Pin or a Terminal with a Channel, page 694.
Delete a Connector
This topic shows how to delete a connector. For more information, see Delete a
Connector, page 694.
Connect a Home-Run Cable to a Plug-and-Socket Box

After creating the required plug-and-socket boxes and home-run cables with
connectors, you can start connecting the your home-run cables to plug-and socket
boxes. For more information, see Connect a Home-Run Cable to a Plug-and-Socket
Box, page 695.
Associate a Segment with a Home-Run Cable

After connecting a home-run-cable to a plug and socket box or a fieldbus brick, you
can associate the home-run cable or its cable-set with a segment. For more
information, see Associate a Segment with a Home-Run Cable, page 696.
Related Topics


1. On the Wiring module menu bar, click Tables > Connector > Types.
2. In the Connector Types dialog box, do one of the following:
• To create a new connector type, click New.
• To edit an existing connector type, click in the field that you want to
edit.
3. Under Connector Type, type a unique name.
4. To specify the connector type for a specific manufacturer, model, and part
number, do any of the following:
• Under Manufacturer, select an appropriate connector manufacturer.
• Under Model, select an appropriate model.
• Under Part Number, type the part number you require.
Note
• You can now define a pin configuration for this connector type. For
details, see Define or Edit a Connector Type Pin Configuration, page
691.
Related Topics
page 689

2. In the Connector Types dialog box, select the connection type that you want to
configure, and click Configure.
3. In the Connector Type Configuration dialog box, do one of the following for
each pin that you want to configure:
• To add a new pin, click New.
• To delete a pin, select the row that you want to delete and click Delete.
• To edit a pin field, click the field.
4. To change the displayed pin sequence, under Sequence, type the new unique
number.
5. To set the pin name, under Name, type the unique name.
6. To set the pin polarity, under Polarity, select the value that you require.


2. In the Connector Types dialog box, select the connector type that you want to
delete.
3. Click Delete.
Note
• SmartPlant Instrumentation removes the item that you delete from the
Connector Types dialog box from the Connector type list.
Create a Connector
Properties.
the End 1 tab.
the End 2 tab.
5. In the Connector Assignments dialog box, click New.
6. In the Connector Properties dialog box that opens, under Connector, type the
name of the new connector.
• From the list, select a connector type as configured.
• To modify or create a connector type, click . For details, see Define
or Edit a Connector Type, page 691.
Note
• You can now assign. For details, see Define or Edit a Connector Type
Pin Configuration, page 691.
Related Topics


Properties.
the End 1 tab.
the End 2 tab.
• To validate that pin polarities that you set for this cable end are
consistent with wire polarities, select the Polarity validation check
box.
• To skip polarity validation, clear the Polarity validation check box.
6. For each connector pin, under Wires per Pin, select the number of wires that you
want to assign to the pin.
7. Under Cable Set, select the Cable Set from which you are assigning a wire to the
current pin. (Repeat this for each connector pin.)
8. Under Wire, select the wire that you assign to the pin. (Repeat this for each
connector pin.)
Notes
• The value that you enter under Wires per Pin determines the number
of rows displayed for a given pin.
• The software does not allow you to edit pin-wire assignment properties
of a connector that is connected (in the Connection window).
Related Topics
page 689


Important
• After you drag a terminal or a pin to a wiring equipment channel, the
software retains it in its original place from which you dragged it.
However, after expanding the destination hierarchy, the software also
shows the terminal or pin that you dragged. This means that the
terminal or pin is physically located in its original place but it is
2. Expand a hierarchy to display the terminal or pin that you want to associate.
3. Drag your selection to the required wiring equipment channel.
Related Topics
page 689
Delete a Connector
1. In the Domain Explorer or Reference Explorer, right-click a cable, and on the
shortcut menu click Properties.
2. In the Cable Properties dialog box, click Connectors.
the End 1 tab.
the End 2 tab.
4. In the Connector Assignments dialog box, select the connectors that you want to
delete.
5. Click Delete.
Note
• The software does not allow you to delete a connector that is already
connected (in the Connection window).
Related Topics

Connect a Home-Run Cable to a Plug-and-Socket Box

2. Expand the Cables folder and select a home-run cable.
3. Right-click the selected cable and then on the shortcut menu, click Actions >
Connection.
4. In the Domain Explorer, expand the hierarchy of the fieldbus cable that you want
to connect to the current plug-and-socket box.
5. Drag the connectors to their ports in the current plug-and-socket box in the Plug-
and-Socket Box Connection window.
Tip
• Before you start dragging a connector, make sure that the cable
connector matches the port type on the plug-and-socket box.
6. In the Cable Connection Options dialog box, select the cable end that you want
to connect and click OK.
7. Repeat the above to connect other cables as needed.
Note
• To disconnect a home-run cable from the current plug-and-socket box,
highlight the cable that you want to disconnect and click .
Related Topics
• Create a Home-Run Cable, page 671
page 689
page 674
• Terminator (Plug-and-Socket Box) — Segment Association, page 682
• Terminator (Terminal Strip) — Segment Association, page 682

Associate a Segment with a Home-Run Cable

2. Select and then right-click a fieldbus plug-and-socket box or a fieldbus brick.
4. In the Connection or the Plug-and-Socket Box Connection window, click the
required connected home-run cable or a home-run cable-set to select it. For
example:
5. Right-click the highlighted home-run cable and on the shortcut menu, click
Associate Segment to open Segment Association dialog box.
6. From the Associate segment list, select the segment with which you want to
associate the current home-run cable.
Tip
• If the required segment is not available in the Associate segment list,
group box.
Note
• The name of segment you just associated is propagated along the
entire home-run cable.
Related Topics
• Create a Home-Run Cable, page 671
page 689

Managing Fieldbus I/O Cards and I/O Assignment

Common Tasks
The following tasks are used frequently when you manage fieldbus I/O cards and
effect I/O assignment for your Foundation Fieldbus and Profibus systems.
Create a Fieldbus I/O Card

You need to create fieldbus I/O cards so that you can associate segments and effect
I/O assignment.
You can create new I/O cards either in the Domain Explorer or the Reference
Explorer. If you are creating an I/O card that is going to have a frequently used
Reference I/O cards facilitate fast creation of plant I/O cards by copying an existing
I/O card configuration from the Reference Explorer to the Domain Explorer.
However, if you want to create an I/O card that does not have a configuration that you
intend to use frequently, we recommend that you create this card in the Domain
Explorer and in the <unit> where it is to be physically located. This is helpful when
filtering the I/O cards in the current <unit>.
For more information, see Create a Fieldbus I/O Card, page 698.
Effect Fieldbus I/O Assignment

You can effect I/O assignment after you make the required connections. For more
information, see Effect Fieldbus I/O Assignment, page 700.
Related Topics

Create a Fieldbus I/O Card

1. In the Domain Explorer or Reference Explorer, right-click a DCS or PLC panel
where you want to create a fieldbus I/O card.
2. On the shortcut menu, click New > Wiring Equipment.
3. In the New Wiring Equipment dialog box, under Category, select I/O card.
4. In the Wiring Equipment Properties - I/O Card dialog box, on the General tab,
do one of the following to name the new I/O card:
Naming Conventions.
5. Select the Double width check box if the card occupies a double width slot or
position.
6. In the Details group box, type a description as needed.
7. Select an I/O card type, model, and manufacturer. If the required value is not
8. Enter a sequence if you need to define the card sequence.
10. In the Control system details group box, under I/O type, select one of the
following I/O types to determine the actual function of the new I/O card:
• Fieldbus
• Profibus DP
• Profibus PA
11. Under Module, type the software address that the current card is assigned to.
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 Manufacturer-Specific Field
Headers, page 67.

12. 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.
Tip
• A category property is a wiring equipment category property that you
can define yourself. For details, see Add User-Defined Wiring
Equipment Category Properties, page 491.
15. Click the Associated Symbols tab to associate a symbol with this item . The
Related Topics
Tasks, page 684

Effect Fieldbus I/O Assignment

1. In the Domain Explorer, select the DCS and PLC cabinets for which you want to
effect I/O assignment.
2. Right-click the panel that you selected and then on the shortcut menu, click
Actions > I/O Assignment.
3. In the Segment I/O Assignment window, under I/O card details, do the
following for each I/O card that requires I/O assignment.
a. Under I/O card, select the required I/O card.
b. For each segment for which you want to effect I/O assignment, drag it from
the Segments data window to the appropriate channel in the data window of
the I/O card details pane.
4. To cancel fieldbus I/O assignment for a given segment, drag it from the data
window of the I/O card details pane back to the Segments data window.
Notes
• To rename a selected control system tag, click , and in the dialog
box that opens, edit the tag properties.
• To view input/output information for the current I/O card, click .
• To generate an I/O Tag Assignment report, click .
Related Topics
• Effect I/O Assignment for an Instrument, page 549

Fieldbus Validation: An Overview

SmartPlant Instrumentation validates that you design fieldbus segment according to
basic connection rules and according to parameters that you set for a given segment:
On-the-Fly Connection Validations
Upon attempting to connect, the software verifies that:
• An instrument to be connected is not associated with another segment.

• A home-run cable to be connected is not already connected to another
segment.
• You are not associating or wiring a non-intrinsically-safe instrument to
an intrinsically safe segment. In this case, SmartPlant Instrumentation
will warn, but allow.
Segment-Report Validations
You perform other validations by running a report from the Fieldbus Tag Numbers
browser. SmartPlant Instrumentation notifies you in the report of a failed validation
in the following cases:
• There are fieldbus tags that are associated with a segment but not
wired.
• There are fieldbus tags that have wiring, but are not yet connected to a
segment.
• There is a connection discontinuity between the field and a DCS or an
I/O terminal strip.
• The number of instruments in a segment exceeds the maximum
specified for that segment.
• The number of devices on a given spur exceeds the segment-wide
parameter profile.
• A spur length is exceeds the maximum set for that spur.
• Total cable length exceeds the maximum you defined for the segment
profile.
• There are less than two terminators in a segment.
• Actual voltage at instrument terminals is below the minimum
operating voltage.
• Total segment current consumption exceeds the maximum specified
value.

• Total capacitance exceeds segment maximum specified capacitance.

Notes
• To define a cable type that supports fieldbus validation, make sure that
in the Cable Type Properties dialog box, you enter the required
values for capacitance, capacitance UOM (unit of measure), cable
resistance, cable resistance UOM, length UOM, and maximum
fieldbus length (for details, see Create a Cable, page 441).
• To define an instrument tag that supports fieldbus validation, make
sure that in the Tag Number dialog box you enter valid information
under Fieldbus Tag Number Properties Create Foundation Fieldbus
and Profibus Instruments, page 661).
• SmartPlant Instrumentation validation supports basic fieldbus
networks consisting of a single segment with no parallel branches and
no repeaters.
Related Topics
• Define Segment-Wide Parameters, page 651
• Fieldbus Validation Common Tasks, page 703

Fieldbus Validation Common Tasks

The following tasks are used frequently when you generate validation reports for your
Generate a Validation Report for One Segment

This procedure shows you how to generate a validation report for one fieldbus
segment. Such a report allows you to verify that you created this segment according
to general connection rules and the specific segment-wide parameter profile
associated with each section. Note that SmartPlant Instrumentation will formulate
this type of report in the unit of measure set on the Cable Lengths tab of the
Segment-Wide Parameter Profile Properties dialog box. For more information,
see Generate a Validation Report for One Segment, page 704.
Generate a Validation Report for Multiple Segments

This procedure shows you how to generate a validation report for one of more
fieldbus segments. Such a report allows you to verify that you created fieldbus
segments according to general connection rules and the specific segment-wide
parameter profile associated with each segment. For more information, see Generate
a Validation Report for Multiple Segments, page 704.
Generate a Segment Wiring Report

Use this procedure to generate an enhanced report for a fieldbus segment. Note that
you must install the Enhanced Report Utility on your local machine to be able to
generate the communication line report. For more information, see Generate a
Segment Wiring Report, page 706.
Related Topics

Generate a Validation Report for One Segment

2. Select a segment and then on the shortcut menu, click Reports > Validation
Report.
Note
• SmartPlant Instrumentation formulates this type of report in the unit of
measure set on the Cable Lengths tab of the Segment-Wide
Parameter Profile Properties dialog box.
Related Topics
Generate a Validation Report for Multiple Segments

1. In the Domain Explorer, click the Fieldbus Segments folder.
2. In the Items pane of the Domain Explorer, select the segments that you require.
3. Right-click the selected segments and then on the shortcut menu, click Reports >
Validation Report.
Note
• You can also generate a validation report from the Fieldbus Tag
Numbers browser. For details, see Generate a Validation Report for
Multiple Segments from the Fieldbus Tag Numbers Browser, page 705.
Related Topics

Generate a Validation Report for Multiple Segments from

the Fieldbus Tag Numbers Browser
Browser.
2. Click .
3. On the Validation Reports dialog box, under Segment list, select the segments
that you require or click Select all to include all segments in the validation report.
4. Under Unit of measure for the report, select Feet or Meters.
5. Click Print.
Note
• You can also generate a validation report from the Fieldbus Tag
Numbers browser. For details, see Generate a Validation Report for
Multiple Segments, page 704.
Related Topics

Generate a Segment Wiring Report

2. Right-click on a segment, and then on the shortcut menu, click Reports >
Enhanced Segment Wiring.
3. At the print preview prompt, do one of the following:
• Click Yes to open the print preview of the generated report. Choose
this option if you want to modify or annotate the report.
• Click No to start printing the report without displaying its print
preview.
Notes
• You must install the Enhanced Report Utility on your local machine to
be able to generate the communication line report. For details, see
Enhanced Report Utility Installation Guide.
• In the General tab folder of the Preferences dialog box, you can set
SmartPlant Instrumentation to display a print preview always, never or
with your approval.
• If you select not to preview a report, and you are using Acrobat
Distiller as your default printer, make sure that Distiller is configured
to enable report generation without prompting for the output file
location. To do this, open the Distiller Preferences dialog box and
under Output Options, clear the check boxes Ask for PDF file
destination and Ask to replace existing PDF file.
Related Topics

Profibus Design: An Overview

SmartPlant Instrumentation supports the creation and maintenance of a Profibus
system.
SmartPlant Instrumentation supports Profibus technology which is based on a two-

level bus hierarchy, DP and PA Profibus segments. Each DP bus can connect
multiple addressable link hardware devices that link various types of input and output
devices. Every link device has a unique node number. The DP link devices that you
can connect to a DP bus can belong to one of the following types:
• Motor drive (connecting a VFD to a DP bus).

• PLC or DCS panel that connects a conventional I/O system of analog
and discrete field devices to a DP bus.
• DP/PA type that connects a lower PA (Process Automation) bus along
with its PA field devices to the DP bus (similar to Foundation Fieldbus
segments).
Profibus PA
Profibus PA segments and Profibus instruments have the same characteristics as

Foundation Fieldbus segments and Foundation Fieldbus instruments.
Related Topics

Flow of Activities for Profibus Design

The following is a suggested flow of activities for Profibus design in SmartPlant
Instrumentation. Note that you can carry out some of the procedures in a different
order, depending on your preferences or requirements.
1. Set the basic definitions as follows:
a. Define Profibus instrument type profiles – Prior to creating new Profibus tag
numbers, you need to customize wiring reference items and then define
appropriate instrument type profiles in the Instrument Index module so that
new tag numbers acquire Profibus properties. This results in automatic
assignment of the required properties to the new tag numbers. For details, see
Define Foundation Fieldbus and Profibus Instrument Type Profiles, page 660.
b. Add a new browser view – In the Browser module, create a browser view
with the required fields for the Fieldbus Tag Numbers browser. This
facilitates the assignment of tag numbers to segments. You can create
multiple Browser views with different Style, Sort, and Filter functions. For
example, by using the filter function you may create independent views for
each segment, so that only tags of that segment will be displayed in its
corresponding view. For more information, see Add a New View, page 265.
2. Create the required DP segments.
• For details, see Create a Profibus DP Segment, page 711..
3. Create your PLC and/or DCS panels that are compatible with Profibus.
• For details, see Create a DP-Compatible PLC or DCS Panel, page
713.
4. Associate the PLC and DCS panels with the DP segments.
• For details, see Associate a PLC or DCS Panel with a Profibus DP
Segment, page 713.
5. Create the required Profibus DP multi-input instruments.
• Create these multi-input instruments with their connected I/O's. For
example, create a motor drive and insert it in an MCC cabinet. For
details, see Create a Multi-Input Instrument with Terminal
Connections for a Fieldbus Segment, page 730 and Create a Multi-
Input Instrument with Terminal Connections for a Fieldbus Segment,
page 730.
6. Associate the DP motor drives with the DP segments.
• For more information, see Associate Profibus DP Instruments with a
DP Segment, page 712.
7. Effect the DP segment I/O assignment.

8. Create the required PA segments.

• For more information, see Create a Profibus PA Segment, page 711.
9. Create the Profibus PA instruments.
• You create these tags based on the instrument types that you defined,
and edit the tag number properties as required. For more information,
see Create Foundation Fieldbus and Profibus Instruments, page 661.
10. Associate the PA instruments with the PA segments.
• For details, see Associate Profibus PA Instruments with a PA Segment,
page 712.
11. Generate a Profibus layout report.
• For details, see Generate an Enhanced Profibus Layout Report, page
714.

Profibus Design Common Tasks

The following is a suggested flow of activities for Profibus design in SmartPlant
Instrumentation. Note that you can carry out some of the procedures in a different
order, depending on your preferences or requirements.
Create a Profibus DP Segment

You need to create a DP bus prior to creating PA segments or any instruments that are
associated with Profibus. This procedure explains how to create a DP bus.. For more
information, see Create a Profibus DP Segment, page 711.
Create a Profibus PA Segment

This procedure explains how to create a Profibus PA segment. Note that you can
create a Profibus PA segment only if you already have an existing DP bus. For more
information, see Create a Profibus PA Segment, page 711.
Associate Profibus PA Instruments with a PA Segment

This procedure outlines the steps required to associate PA instruments with a PA
segment. Note that an instrument can be associated with one segment only. For more
information, see Associate Profibus PA Instruments with a PA Segment, page 712.
Associate Profibus DP Instruments with a DP Segment

Use this procedure to associate a Profibus DP device or an instrument (for example, a
motor drive) with a DP segment. For more information, see Associate Profibus DP
Instruments with a DP Segment, page 712.
Create a DP-Compatible PLC or DCS Panel

You need DP-compatible panels for your Profibus system. For more information, see
Create a DP-Compatible PLC or DCS Panel, page 713.
Associate a PLC or DCS Panel with a Profibus DP Segment

This procedure explains how to associate a PLC or a DCS panel with a DP segment.
For more information, see Associate a PLC or DCS Panel with a Profibus DP
Segment, page 713.
Generate an Enhanced Profibus Layout Report

This report allows you to view a schematic drawing of a Profibus segment. The
report includes one page per segment and shows all the associated devices and their
node numbers. For more information, see Generate an Enhanced Profibus Layout
Report, page 714.

Create a Profibus DP Segment

1. In the Domain Explorer, right-click the Fieldbus Segments folder.
2. On the shortcut menu, click New > Profibus DP Segment.
3. In the Profibus DP Segment Properties dialog box, under Segment, type a
unique name for the new segment.
Related Topics
Create a Profibus PA Segment

2. Right-click a DP segment and then on the shortcut menu, click New > Profibus
PA Segment.
3. In the Profibus PA Segment Properties dialog box, type the segment name.
4. Select a segment-wide parameter profile if needed. You can click to define a
new segment-wide parameter profile if you need one. For details, see Define
Segment-Wide Parameters, page 651.
5. Select the Intrinsically safe check box if you want to define the new segment as
intrinsically safe.
Related Topics

Associate Profibus PA Instruments with a PA Segment

Browser.
2. In the Fieldbus Tag Numbers browser, select one or more PA instruments.
3. Drag the instruments you selected to a PA segment in the Fieldbus Segments
folder of the Domain Explorer.
Note
• To dissociate a PLC or DCS panel from a DP segment, in the Domain
Explorer, right-click a panel in the Fieldbus Segment folder, then on
the shortcut menu, click Actions > Dissociate Item from Segment.
Related Topics
Associate Profibus DP Instruments with a DP Segment

Browser.
2. Select the required instruments in the browser.
• Click on the browser toolbar, select an unassociated instrument in

the Profibus DP Instruments pop-up window and drag it to a DP
segment in the Domain Explorer.
• In the Fieldbus Tag Numbers browser, select an unassociated
instrument and drag it to a DP segment in the Domain Explorer.
Note
• To dissociate an instrument from a DP segment, in the Domain
Explorer, right-click an instrument in the Fieldbus Segments folder,
and then on the shortcut menu, click Actions > Dissociate Item from
Segment.
Related Topics

Create a DP-Compatible PLC or DCS Panel

You can connect several different types of devices to a DP segment. As DP segments
are Ethernet buses, you can connect PLC or DCS panels to a DP segment via a
special I/O card.
You create a PLC or DCS panel compatible with a DP segment exactly the same way
you create any other PLC or DCS panel. While creating such a panel, make sure that
you select the Enable DP Profibus check box so that you can associate this panel
with a DP Profibus segment.
For details, see the following:
• Create a Distributed Control System (DCS) Panel, page 461

• Create a Programmable Logic Controller (PLC) Panel, page 463
Related Topics
Associate a PLC or DCS Panel with a Profibus DP Segment

Browser.
2. In the Fieldbus Tag Numbers browser, do one of the following to open the
Profibus DP PLC/DCS Panels pop-up window:
• On the main menu, click View > Panels.
• Click on the browser toolbar.

Note
• To dissociate a PLC or DCS panel from a DP segment, in the Domain
Explorer, right-click a panel in the Fieldbus Segment folder, then on
the shortcut menu, click Actions > Dissociate Item from Segment.
Related Topics

Generate an Enhanced Profibus Layout Report

2. Right-click a Profibus segment.
3. On the shortcut menu, click Reports > Enhanced Profibus Layout.
Related Topics
Profibus DP Segment Properties

This dialog box allows you to create a new Profibus DP segment or edit the properties
of an existing Profibus DP segment.
Segment — Allows you to type or edit a unique name for the segment.

Working with HART Instruments: An Overview

HART (Highway Addressable Remote Transducer) technology is one of the first
fieldbus digital communication techniques that were implemented in instrumentation.
HART is a widely acceptable and recognized standard for digitally enhanced 4-20
milliamp smart instrumentation communication. This technology extends the 4-20
mA standard analog transmission with a superimposed digital signal that contains
process and instrument data.
The advantage of HART instruments is that they can be connected to standard 4-20
milliamperes systems and, at the same time; make use of digital communication to
collect additional data.
Related Topics
• Flow of Activities for HART Instrumentation, page 716

Flow of Activities for HART Instrumentation

The following is a suggested flow of activities for HART instrumentation in
SmartPlant Instrumentation. Note that you can carry out some of the procedures in a
different order, depending on your preferences or requirements.
1. Define the appropriate instrument types for HART instruments.
• When defining the profile for HART instrument types you must select
HART AI or HART AO as the I/O type. For more information, see
Define Instrument Type Profiles for HART Instruments, page 717.
2. Create your HART instruments.
• HART instruments can be HART transmitters, HART IP converters,
and so on. For details, see Create a HART Instrument, page 718.
3. Create a virtual digital tag.
• Each HART instrument has a different set of digital signals. The
digital signals depend on the I/O type (AI or AO) and on the
instrument manufacturer who supplies the HART instruments with a
specified variety of possible digital signals. For more information, see
Create a Virtual Digital Tag, page 720.
4. Create I/O cards compatible with HART instruments.
• For details, see Create an I/O Card Compatible with HART
5. Connect the HART instruments to the appropriate HART I/O cards.
• You make this connection by right-clicking an I/O card in the Domain
Explorer and then clicking Actions >Connection.
6. Effect I/O assignment for HART instruments.
• For details, see Effect I/O Assignment for HART Instruments, page
721.

Define Instrument Type Profiles for HART Instruments

2. In the Instrument Types dialog box, from the Process function list, select an
appropriate process function.
• Click New to create a new instrument type. For details, see Define an
• In the data window, select an existing instrument type.
4. Click Profile.
5. In the Instrument Type Profile dialog box, on the General tab, under
Specification, select an appropriate fieldbus specification.
6. Select Include I/O type, and then from the list, select one of the following:
• HART AI
• HART AO
7. On the Wiring and Control System tab, select the appropriate reference device
panel and reference cable. For details, see Define a Wiring and Controls System
8. Click OK in the Instrument Type Profile dialog box.
Related Topics
• Working with HART Instruments: An Overview, page 715

Create a HART Instrument

1. Press F7 to open in the Domain Explorer.
the Instruments folder, and then click New > Instrument.
expand the Loops folder, right-click a loop, and then click New >
Instrument.
4. In the New Tag Number dialog box, from the Tag class list, do the following:
a. From the Tag class list, select HART.
b. Type the name of the new tag number. Note that if you are working with the
Free naming conventions, click the Select instrument type check box to
open a pop-up window that allows you to select an appropriate instrument
type.
5. Click OK.
and click OK.
Tips
• Remember that you need to define appropriate instrument type profiles
for your HART instruments prior to creating them. These instrument
type profiles must include an I/O type which is either HART AI or
HART AO. For details, see Define Instrument Type Profiles for HART
• If the tag number does not correspond to an existing loop name,
the tag number you have entered. If the loop identifier already
matches an existing loop, the software will automatically associate the
new tag number with 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 reference items.
• For DeltaV compatibility, you must select an instrument type that you
associated with a DeltaV device type during the downloading process.
To display the Associate Foundation Fieldbus Device Types with

Instrument Type supporting table of associations that you built

among DeltaV device types, instrument manufacturers, and SmartPlant
Instrumentation instrument types, see Associate Foundation Fieldbus
Device Types for DCS Vendors.
• Type the loop number that the new tag is associated with.
Note that if a loop with the same name exists, the tag number is
automatically associated with it, without creating a new loop.
8. Click OK to create the loop number.
9. In the Loop Number Properties dialog box, accept the loop number properties or
modify them as you require and then click OK.
10. In the Tag Number Properties dialog box, on the General tab, enter the tag
number attributes that you require.
Tip
• For DeltaV compatibility, make sure that the value that you select
from the Manufacturer list is among the acceptable values for the
instrument type that you selected for the current tag. For details, see
Crucial Fields for the DeltaV Interface.
11. To enter power supply properties, see Enter Power Supply Data for Panels and
12. Click the HART tab to define the instrument parameters and create virtual digital
tags.
13. Select a signal type and linearity type values if needed.
14. From the Analog signal parameter list, select a parameter that is appropriate for
the analog signal of the current HART instrument.
Tip
• Note that this selection is available only if the I/O type of the current
instrument is HART AI.
15. Enter the required DC consumption, capacitance, minimum transmit level, and
operating voltage.
16. Create the required virtual digital tags. For details, see Create a Virtual Digital
Tag, page 720.
Related Topics

Create a Virtual Digital Tag

1. In the Tag Number Properties dialog box, click the HART tab.
2. From the Analog signal parameter list, select an appropriate signal parameter.
3. In the Virtual tags group box, click New.
4. Click Yes in the prompt to save the changes to the tag properties.
5. In the New Virtual HART Tag Number dialog box, select a signal parameter,
enter the tag number name.
6. Click OK.
Note
• The signal parameter depends on whether the I/O type of the current
HART instrument is HART AI or HART AO.
Related Topics
Create an I/O Card Compatible with HART Instruments

To make an I/O card compatible with a HART instrument, you must select one of the
following I/O types when defining the control system properties of a new I/O card:
• HART AI
• HART AO
• AI
• AO
• MIXED
For details on how to create an I/O card, see Create an I/O Card, page 497.
Related Topics

Effect I/O Assignment for HART Instruments

You effect I/O assignment for your HART instruments like with any other
instruments that require I/O assignment. In the Domain Explorer, right-click the
required I/O card and then click Actions > I/O Assignment. For details, see I/O
Assignment: An Overview, page 545.
Instruments Cards
AI AO H H
A A
R R
T T
A A
I O
AI Yes No Y N
es o
(s
ee
no
te
1)
AO No Yes N Y
o es
(s
ee
no
te
1)
HART AI Yes (see note 2) No Y N
es o
HART AO No Yes (see note 2) N Y
o es
Mixed Yes Yes Y Y
es es
(s (s
ee ee
no no
te te
3) 3)

Notes
• When assigning "non-HART" analog instruments to HART-
compatible I/O cards, the software assigns only the analog signals.
(DI or DO are not allowed anyway).
• You can assign HART instruments to conventional I/O cards (AI to
HART AI, AO to HART AO), but the software assigns only the analog
signals and not the virtual digital tags.
• You can assign HART instruments to I/O cards with MIXED I/O type,
but the software assigns only the analog signals and not the virtual
digital tags.
Related Topics

Fieldbus and Conventional Multi-Input Devices
Fieldbus and Conventional Multi-Input

Devices
Overview
Many modern fieldbus or conventional digital instruments support more than one
input, for example, temperature transmitters and Bentley Nevada vibration monitors.
SmartPlant Instrumentation supports various configurations for instrument tags with
multi-input device panels. Note that multi-input devices can recognize input signals
from distant device panels.
For details, see Managing Multi-Input Devices Common Tasks, page 724.
Related Topics
• Managing Multi-Input Devices Common Tasks, page 724

Managing Multi-Input Devices Common Tasks

The following tasks are used frequently when you create and mange the fieldbus and
conventional multi-input devices in your plant.
You can create new multi-input devices either in the Domain Explorer or the
Reference Explorer. If you are creating a multi-input device that is going to have a
frequently used configuration, we recommend that you create it in the Reference
Explorer. Reference multi-input devices facilitate fast creation of plant multi-input
devices that are based on the configuration of an item in the Reference Explorer.
However, if you want to create a multi-input device that does not have a
configuration that you intend to use frequently, we recommend that you create this
multi-input device in the Domain Explorer and in the <unit> where it is to be
physically located. This is helpful when filtering the panels in the current <unit>.
Create a Multi-Input Device Panel with Terminal Connections

This procedure explains how to create a multi-input device panel that has terminal
connections. For more information, see Create a Multi-Input Device Panel with
Terminal Connections, page 727.
Create a Plug-and-Socket Multi-Input Device Panel

This procedure shows you how to create a plug-and-socket multi-input device panel.
For more information, see Create a Plug-and-Socket Multi-Input Device Panel, page
726.
Create a Multi-Input Instrument with Plug-and-Socket Connections for a

Fieldbus Segment
You use this procedure to create a multi-input instrument with plug-and-socket
connections for a fieldbus segment and then assign the signals to fieldbus I/O card
channels. For more information, see Create a Multi-Input Instrument with Plug-and-
Socket Connections for a Fieldbus Segment, page 728.
Create a Multi-Input Instrument with Terminal Connections for a

Fieldbus Segment
This procedure explains how to create a multi-input instrument with terminal
connections for a fieldbus segment. Also, you can assign the signals to fieldbus I/O
card channels. For more information, see Create a Multi-Input Instrument with
Terminal Connections for a Fieldbus Segment, page 730.

Create a Multi-Input Instrument with Plug-and-Socket Connections for a

Serial Loop Interface
This procedure explains how to create a multi-input instrument with plug-and-socket
connections for a serial interface loop. Also, you can assign the signals to fieldbus
I/O card channels and generate an enhanced report for the wiring loop. For more
information, see Create a Multi-Input Instrument with Plug-and-Socket Connections
for a Serial Loop Interface, page 732.
Create a Multi-Input Instrument with Terminal Connections for a Serial

Loop Interface
This procedure explains how to create a multi-input instrument with terminal
connections for a serial interface loop. Also, you can assign the signals to fieldbus
I/O card channels and generate an enhanced report for the wiring loop. For more
information, see Create a Multi-Input Instrument with Terminal Connections for a
Serial Loop Interface, page 734.
Related Topics
723

Create a Plug-and-Socket Multi-Input Device Panel

• In the Domain Explorer, expand the Panels by Category folder.
• In the Reference Explorer, expand the Panels folder.
2. Right-click the Device Panels folder and then on the shortcut menu, click New >
Multi-Input (Plug-and-Socket).
3. In the Plug-and-Socket Box Wizard – Multi-Input Device, read the
instructions carefully and then click Next to open the Define the New Panel
page.
4. Under Panel name, type a unique device panel name.
5. Define the new panel by entering the panel type, manufacturer, model, area class,
location, mounting, dimensions, and backplane as needed.
6. To define the device panel as intrinsically safe, select Intrinsic safety.
7. Click Next, and on the Define the Plug-and-Socket Layout page, enter the
number of ports that you need on the left and on the right sides of the panel.
8. Click Next, and on the Define the Ports page, for each port that you created, type
the name and select In or Out.
Tip
• You must define one and only one out port.
9. Click Next, and on the Define the Plug-and-Socket Box Connectors page, for
each connector, do the following:
a. From the Connector type list, select the required connector, or click to
open the Connectors dialog box.
b. From the Male/female list, define the connector as Male or Female.
c. If these settings are constant for all of the connectors in the panel, select
Apply to all after you set the above.
10. Click Next and then click Finish.
Note
• You can delete the terminals that were created after completing the
wizard only when you delete the multi-input device panel.
Related Topics
723

Create a Multi-Input Device Panel with Terminal

Connections
• In the Domain Explorer, expand the Panels by Category folder.
• In the Reference Explorer, expand the Panels folder.
2. Right-click the Device Panels folder and then on the shortcut menu, click New >
Multi-Input (Conventional).
3. In the Conventional Box Wizard – Multi-Input Device, read the instructions
carefully and then click Next to open the Define the New Panel page.
4. Under Panel name, type a unique device panel name.
5. Define the new panel by entering the panel type, manufacturer, model, area class,
location, mounting, dimensions, and backplane as needed.
6. To define the device panel as intrinsically safe, select Intrinsic safety.
7. Click Next, and on the Define the Multi Input Layout page, enter the number of
inputs and outputs that you need on the left and on the right sides of the panel.
8. Click Next, and on the Define the Multi Input page, for each multi input that
you created, type the name and select In or Out.
Tip
• Only one of the input/outputs can be defined as an output.
9. Click Next, and on the Define the Input / Output Configuration page, for each
connector, do the following:
a. From the Input/Output list, select the required input or output.
b. From the Configuration list, select an appropriate configuration.
c. Under First terminal, enter the first terminal as you require.
d. If these settings are constant for all of the inputs and outputs in the panel,
select Apply to all after you set the above.
10. Click Next and then click Finish.
Note
• You can delete the terminals that were created after completing the
wizard only when you delete the multi-input device panel.
Related Topics
723

Create a Multi-Input Instrument with Plug-and-Socket

Connections for a Fieldbus Segment
1. In the Reference Explorer, create reference panels that feed into the multi-input
device panel.
2. In the Reference Explorer, create a reference multi-input device panel with plug-
and-socket connections.
3. In the Reference Explorer, create reference spur cables.
Tips
• Use the same connector type required for the device panels.
• Set the male/female property for coupling with the device panels.
• In the Cable Properties dialog box, under Cable class, select
Conventional.
4. In the Instrument Index module, create instrument type profiles for multi-input
plug-and-socket socket fieldbus instruments and instruments that feed into the
multi-input instrument.
Tips
• For each instrument type, on the Wiring and Control System tab,
select the reference device panel and reference cable that you created
for each type.
• For the instrument type upon which you base the multi-input device
panel, make sure that you select the Fieldbus I/O type in the
Instrument Type Profile dialog box and that you associate enough
function blocks for the inputs. For details, see Define Foundation
Fieldbus and Profibus Instrument Type Profiles, page 660.
5. In the Instrument Index module, create the following, based on the instrument
types that you defined:
• Create the instrument tags that feed into the multi-input instrument tag.
• Create the multi-input instrument tag. Make sure that in the New Tag
Number dialog box, you select Fieldbus from the Tag class list.
6. In the Domain Explorer, right click the multi-input device panel that was
created, and on the shortcut menu, click Actions > Connection.
7. In the Plug-and-Socket Connection window, do the following to connect the
input device cables to the multi-input device panel.
a. In the Domain Explorer, expand the device cables that feed into the multi-
input device panel.
b. Drag the appropriate cable connectors to the in-ports of the multi-input device.

8. Do the following to route the multiplexed signal through a plug-and-socket

junction box:
a. In the Domain Explorer, right click the junction box, and on the shortcut
menu, click Actions > Connection.
b. In the Domain Explorer, expand the multi-input device cable.
c. Drag the appropriate cable connector to the desired in-port of the junction box
in the Plug-and-Socket Connection window.
9. Do the following to associate the multi-input tag signal with the available function
blocks in the target fieldbus segment:
a. In the Wiring Module window, click Actions > Fieldbus Tag Numbers
Browser.
b. Drag the multi-input device tag from the Instruments pane to the target
segment in the Fieldbus Segments folder of the Domain Explorer.
c. In the Fieldbus Segments pane, right click the multi-input device tag, and on
the shortcut menu, click Associate Multi-Input Device Tag.
d. Drag each tag from the Connected tags available for association pane to the
Function Block – Tag Association pane.
e. Click Close.
10. Do the following to assign the demultiplexed signals to the segment I/O card:
a. In the Domain Explorer, right-click the desired DCS, then on the shortcut
menu click Actions > I/O Assignment.
b. If the I/O Assignment dialog box opens, select Segment I/O assignment,
and click OK.
c. In the Segment I/O Assignment window, in the Segment list pane, select the
desired segment.
d. In the I/O card details pane, select the channel to which you want to assign
the demultiplexed signals.
e. Click Actions > Assign to a Channel.
Related Topics
723

Create a Multi-Input Instrument with Terminal Connections

for a Fieldbus Segment
device panel.
2. In the Reference Explorer, create a reference multi-input device panel with
terminal connections.
Tip
• In the Cable Properties dialog box, under Cable class, select
Conventional.
plug-and-socket socket fieldbus instruments and instruments that feed into the
Tips
for each type.
panel, make sure that you select the Fieldbus I/O type in the
7. In the Plug-and-Socket Connection window, connect the input device cables to
the multi-input device panel.
8. Do the following to route the multiplexed signal through a unction box:
a. In the Domain Explorer, right click the junction box, and on the shortcut
menu, click Actions > Connection.
b. In the Connection window, connect the multi-input device cable to the
junction box.

9. Do the following to associate the multi-input tag signal with the available function
blocks in the target fieldbus segment:
a. In the Wiring Module window, click Actions > Fieldbus Tag Numbers
Browser.
b. Drag the multi-input device tag from the Instruments pane to the target
segment in the Fieldbus Segments folder of the Domain Explorer.
c. In the Fieldbus Segments pane, right click the multi-input device tag, and on
the shortcut menu, click Associate Multi-Input Device Tag.
d. Drag each tag from the Connected tags available for association pane to the
Function Block – Tag Association pane.
e. Click Close.
10. Do the following to assign the demultiplexed signals to the segment I/O card:
a. In the Domain Explorer, right-click the desired DCS, then on the shortcut
menu click Actions > I/O Assignment.
b. If the I/O Assignment dialog box opens, select Segment I/O assignment,
and click OK.
c. In the Segment I/O Assignment window, in the Segment list pane, select the
desired segment.
d. In the I/O card details pane, select the channel to which you want to assign
the demultiplexed signals.
e. Click Actions > Assign to a Channel.
Related Topics
723

Create a Multi-Input Instrument with Plug-and-Socket

Connections for a Serial Loop Interface
device panel.
2. In the Reference Explorer, create a reference multi-input device panel with plug-
and-socket connections.
Tips
• For both types, in the Cable Properties dialog box, under Cable class,
select Conventional.
• Use the same connector type required for the device panels.
• Set the male/female property for coupling with the device panels.
• For the instrument type that you will use with the multi-input device
panel, create one connector only (for the device panel end). Leave the
second end without a connector, for terminal connection to the DCS
I/O card.
4. In the Instrument Index module, create instrument type profiles for instruments
with plug-and-socket multi-input serial interface and instruments that feed into the
Tips
for each type.
panel, make sure that you select the Serial Interface I/O type in the


input device panel.
8. In the Domain Explorer, right-click the DCS panel to which you connect the
output of the multi-input device panel, then on the shortcut menu, click Actions >
Connection.
Tip
• Make sure that the I/O type of the I/O card to which you connect the
multi-input device is SI.
9. In the Connection window, connect the output cable of the multi-input device
panel to the DCS.
10. To view the I/O assignment of the signals, click Actions > I/O Assignment.
Related Topics
723

Create a Multi-Input Instrument with Terminal Connections

for a Serial Loop Interface
device panel.
2. In the Reference Explorer, create a reference multi-input device panel with
Tips
• For both types, in the Cable Properties dialog box, under Cable class,
select Conventional.
• Do not create connectors for this reference cable.
instruments with terminal connections for a serial interface and instruments that
feed into the multi-input instrument.
Tips
for each type.
panel, make sure that you select the Serial Interface I/O type in the
• Create the instrument tags that feed into the multi-input instrument.
input device panel.

8. In the Domain Explorer, right-click the DCS panel to which you connect the
output of the multi-input device panel, then on the shortcut menu, click Actions >
Connection.
Tip
• Make sure that the I/O type of the I/O card to which you connect the
multi-input device is SI.
9. In the Connection window, connect the output cable of the multi-input device
panel to the DCS.
10. To view the I/O assignment of the signals, click Actions > I/O Assignment.
Related Topics
723

Telecom Design
Telecom Design
Overview
SmartPlant Instrumentation provides the ability to efficiently define and manage most
commonly used telecommunication equipment.
Here are a few examples of telecom equipment that you can create and manage:
• Field equipment (speakers, intercoms, telephones, and so forth)

• Public announcement (PA) equipment and amplifiers
• Switchboards
• Network equipment (hubs, switches, routers, and so forth)
• Miscellaneous equipment (video and entertainment equipment)
The software provides the means to define all the connections and the internal
equipment configuration. Furthermore, you can define and create the logical
structures (for example, channels, port, and so forth) as well the physical structures,
such as racks and cards.
You can generate appropriate reports, such as telecommunication field lists,

communication line diagrams (telecom point-to-point diagrams), network class
diagrams (network area maps), and so forth.
Note
• Telecom functionality is available only if it is included in the software
license that you purchased from Intergraph.
Related Topics
• Arrangement of Telecom Items in the SmartPlant Instrumentation
Explorer, page 739
• Flow of Activities for Telecom Design, page 737
• Working with Old Equipment, page 743

Telecom Design
Flow of Activities for Telecom Design

The following is a suggested flow of activities that will help you design the
telecommunication system in your <plant>.
The first step in your telecom design is to create the reference telecommunication
equipment.
Then, in the Instrument Index module, you define telecommunication device types
(similar to instrument types for non-telecommunication devices). You can also define
telecom line numbers, field equipment (that is, equipment classification), and signal
levels. Now you can create your telecom tag numbers based on the telecom device
type that you defined. At this stage, you can generate various Instrument Index
reports as needed.
Once all the supporting table data is entered and all the telecom tags are created, you
start creating your telecom panels and telecom equipment based on the reference
equipment and reference panels you created previously. Make the required
connections among the your telecom equipment. You can then generate telecom
wiring reports as needed.
We recommend the following flow of activities:

1. In the Reference Explorer, create the following reference equipment:
• Telecom cables with appropriate configurations
• Telecom device panels
• Telecom equipment panels with or without their internal equipment
• Telecom equipment items such as amplifiers, switchboards, hubs, and
so forth that serve as the internal equipment of telecom panels
2. Start the Instrument Index module and define the following:
• A telecom device panel type and device type profile defaults for
telecom tags
• Communication line numbers
• Field equipment classification
• Signal levels
3. Generate Instrument Index telecom reports if needed (telecom devices and various
telecom table reports).

Telecom Design
4. In the Domain Explorer, do the following:

• Create the telecom tag numbers that you require.
• Create plant equipment panels with the necessary hardware shelves or
racks.
• Create the telecom equipment items that you require by copying the
reference items.
• Define network classes.
• Make all necessary connections.
5. Generate the Telecom reports in the Wiring module.
Related Topics
Explorer, page 739
• Telecom Design: An Overview, page 736

Telecom Design
Arrangement of Telecom Items in the SmartPlant

Instrumentation Explorer
You use the Domain Explorer to access telecom panels and equipment. Typical
telecom equipment, that is, telecom reference equipment, is organized in the
Reference Explorer.
Telecom equipment is organized in several different folders in the Domain Explorer

and Reference Explorer. In the Domain Explorer, the following folders hold
telecom equipment:
• Telecom Panels— contains telecom panels arranged according to

their types:
• Field Devices— holds plug-and-socket as well as conventional field
device panels.
• Junction Boxes
• Splice Panels
• Patch Panels
• Distribution Frames

Telecom Design
• Equipment Cabinets— holds PA cabinets, PABX cabinets, hub

cabinets, intercom cabinets, and miscellaneous cabinets for video and
entertainment systems)
• Old Equipment— contains telecom panels created prior to Version 7.
Note that you cannot create additional panels in this folder, but you
can add new child items, modify the properties of the existing items,
and delete the old equipment items, as you require.
• Panels by Manufacturer— arranges telecom panels according to
their manufacturers.
• Telecom Equipment— lists telecom panels and equipment classified
according to their types. Note that the items in this folder are for
viewing only.
Related Topics

Telecom Design


Telecom Device Types Allows you to create and manage telecom device
types. You define 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 Numbers Allows you to maintain the contents of the
Telecom line list when 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 Equipment Allows you to maintain the contents of the Field
equipment select list on the Tag Number
Telecom Signal Levels Allows you to maintain the contents of the Signal
level select list on the Tag Number Properties
dialog box.
Panel Sub-Systems Allows you to maintain the contents of the Sub-
system select list on the Equipment Panel
Telephone Numbers Allows you to define new telephone numbers that
you can associate with existing switch channels in
PABX cabinets.
Telephone Number Statuses Allows you to manage the contents of the
Telephone number status select list on the
Telephone Number Properties dialog box.

Telecom Design

Telephone Number Usages Allows you to manage the contents of the
Telephone number usages select list on the
Telephone Number Properties dialog box.
Intercom Numbers Allows you to define new intercom numbers that
you can later 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
Alarm Zones Allows you to manage the alarm zone definitions
which are available for selection on the Category
Properties tab of the Wiring Equipment
PABX Categories Allows you to manage the contents of the PABX
categories select list on the PABX Cabinet
Note
Related Topics

Telecom Design
Working with Old Equipment

SmartPlant Instrumentation partially supports telecom panels created prior to Version
7. These panels and their child items are organized in the Old Equipment folder.
Note that you cannot create additional panels in this folder, but you can add new child
items, modify the properties of the existing items, and delete the old equipment items,
as you require.
Related Topics
Explorer, page 739

Telecom Design
Creating and Managing Telecom Devices and

Cables Common Tasks
The following tasks are used frequently when you define and manage various
Telecom devices and cables.
Set Telecom Device Type Profile Defaults

You define a telecom device type profile for your telecom devices so that new
telecom tag numbers that you create 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 required. You can delete a telecom device type that is not
in use. However, SmartPlant Instrumentation does not let you delete a telecom
device type that you already used to create a tag number.
SmartPlant Instrumentation uses standard function identifier acronyms to identify

telecom device types. If some acronyms are not unique and are used for more than
one device type, the Select Telecom Type dialog box opens where you select the
appropriate device type.
After defining a device type, you set device type profile defaults for new telecom tag
numbers. As result, SmartPlant Instrumentation will create your new tag numbers
with certain predefined properties based on the telecom device type you select for the
new tag number. You set profiles for every telecom device type that you use.
For more information, see Set Telecom Device Type Profile Defaults, page 746.
Create a Telecom Field Tag

This procedure explains how to create new telecom tag numbers. Note that the new
tag numbers will be based on the telecom profile default that you defined. For more
information, see Create a Telecom Field Tag, page 747.
Create a Telecom Conventional Field Device

This procedure explains how to create a conventional telecom field device.
Conventional field devices are not plug-and- socket boxes. Conventional field
devices are connected to regular terminals.
You can create a new telecom field device panel in the Domain Explorer or the
Reference Explorer. If you are creating a panel that is going to have a frequently

Telecom Design
For more information, see Create a Telecom Conventional Field Device, page 749.
Create a Telecom Plug-and-Socket Field Device

You use plug-and-socket boxes to connect telecom objects that have connectors. The
Plug-and-Socket Box Wizard enables you to create plug-and-socket boxes or
reconfigure the existing ones.
You can create a new telecom plug-and-socket box field device in the Domain
Explorer or the Reference Explorer. If you are creating a plug-and-socket box that
is going to have a frequently used configuration, we recommend that you create it in
the Reference Explorer. Reference plug-and-socket boxes facilitate fast creation of
plant plug-and-socket boxes by copying required configurations from the Reference
Explorer to the Domain Explorer. However, if you want to create a plug-and-
socket box that does not have a configuration that you intend to use frequently, we
recommend that you create it in the Domain Explorer and in the <unit> where it is
to be physically located. This is helpful when filtering the panels in the current
<unit>.
For more information, see Create a Telecom Plug-and-Socket Field Device, page 750.
Duplicate a Telecom Field Tag

This procedure explains how to create a new telecom field tag by duplicating the
properties of an existing one. You can then edit the new telecom field tag properties
as required. You can create the new duplicated telecom field tag in any <unit> of the
current domain. For more information, see Duplicate a Telecom Field Tag, page 748.
Create a Telecom Cable

This procedure explains how to create a telecom cable. When creating a cable, you
select an existing cable configuration that includes a particular arrangement of cable
sets (pairs, triads, and so forth within a cable) and wires to be built with the cable.
You can then add additional cable sets and wires to that cable if required.
If you are creating a cable that is going to have a frequently used configuration, we
recommend that you create it in the Reference Explorer. Reference cables facilitate
fast creation of plant cables by copying an existing cable configuration from the
Reference Explorer to the Domain Explorer. However, if you want to create a
cable that does not have a configuration that you intend to use frequently, we
recommend that you create this cable in the Domain Explorer and in the <unit>
where it is to be physically located. This is helpful when filtering the cables in the
current <unit>.
For more information, see Create a Telecom Cable, page 751.

Telecom Design
Set Telecom Device Type Profile Defaults

1. On the Instrument Index Module window menu bar, click Tables > Telecom >
Telecom Device Types.
2. On the Telecom Device Types dialog box, do one of the following:
• Select an existing device type and click Profile.
• Click New and define a device type that you need and then click
Profile.
3. On the Telecom Device Type Profile dialog box, define the general default
settings for new telecom devices.
4. Click the Wiring tab if you need to define wiring default settings.
5. On the Wiring and Control System tab, select the Include wiring check box.
6. To define new device tags as control-system-enabled, select the Control system
check box. This enables the corresponding tag numbers for tag assignment.
7. To enable automated creation of coupled control system tags, select Automatic
CS tags.
8. 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.
9. If your reference device panel settings enable the Conventional connections
on the Conventional Connection Properties dialog box, define the
settings that you require, and click OK.
10. If your reference device panel settings enable the Plug-and-socket connections
on the Plug-and-Socket Connection Properties dialog box, define
the settings that you require, and click OK.
Related Topics
Explorer, page 739
• Creating and Managing Telecom Devices and Cables Common Tasks,
page 744

Telecom Design
Create a Telecom Field Tag

• In the Domain Explorer, right-click the Instruments folder and then
click New.
• On the Instrument Index Module window menu bar, click Edit >
Tag Number > New Tag Number.
2. On the New Tag Number dialog box, from the Tag class list, select Telecom.
3. Under Tag number, type the name of the new tag number. For details on how to
name new tag numbers, see Instrument Tag Naming Convention, page 360.
Tips
• If more than one function identifier exists for the current telecom type
acronym, select an appropriate telecom device type on the Select
Telecom Type dialog box and then click OK.
• If you are working with the Free naming conventions, choose the
Select telecom type check box to open a popup window that allows
you to select an appropriate telecom type.
4. On the Tag Number Properties dialog box, enter appropriate values on the
General tab.
5. Click the Telecom tab and enter your values as needed.
6. If the current field tag requires power supply definitions, click the Power Supply
tab and enter your values as needed. Make sure that you have selected the
Requires power supply check box on the General tab.
7. Click OK to accept all the values that you have entered and to create the field tag.
Related Topics
Explorer, page 739
page 744

Telecom Design
Duplicate a Telecom Field Tag

1. In the Domain Explorer, double-click the Instruments folder to display the
existing instruments.
2. Right-click a telecom field tag and then click Duplicate.
3. On the Duplicated Tag Number dialog box, under Tag number, type the name
of the new tag number. For details on how to name new tag numbers, see
Instrument Tag Naming Convention, page 360.
4. To create the new field tag in the another <unit> of the current domain, select the
Create in another unit check box and do the following:
a. On the Open dialog box, select the target <unit> for the new field tag.
b. Click OK.
5. Click OK to duplicate the field tag and close the Duplicated Tag Number dialog
box.
Tip
• In SmartPlant Instrumentation, a device field segment of a telecom
field tag, for example, HO, is associated with an existing device type
acronym and description, for example, HO HOODS, ACOUSTIC. If
you have changed the telecom device field segment in the telecom tag
number and the system cannot recognize its association with the
existing device field, you must select a telecom device field from the
Select Telecom Device dialog box, and then click OK.
6. On the Tag Number Properties dialog box, modify the values as you require and
click OK.
Related Topics
Explorer, page 739
page 744

Telecom Design
Create a Telecom Conventional Field Device

1. In the Domain Explorer, double-click the Panels by Category folder and expand
the Telecom Panels folder.
2. Right-click the Field Devices folder and then on the shortcut menu click New >
Field Device (Conventional).
3. On the Device Panel Properties dialog box, on the General tab, under Panel,
type a name of the new panel.
next to the relevant list arrow to open the appropriate supporting table.
6. Select the Set as intrinsically safe check box if this field device panel has
intrinsic safety certification.
8. Click OK to accept your definitions for the new field device panel and close this
dialog box.
Related Topics
Explorer, page 739
page 744

Telecom Design
Create a Telecom Plug-and-Socket Field Device

2. Right-click the Field Devices folder and then on the shortcut menu click New >
Field Device (Plug-and-Socket).
Notes
items.
• When defining plug-and-socket box connectors, under Connector
Related Topics
Explorer, page 739
page 744

Telecom Design
Create a Telecom Cable

1. In the Domain Explorer, right-click the Cables folder.
2. On the shortcut menu click New > Cable.
3. On Cable Configuration dialog box, select an existing telecom cable
configuration or create a new one. For details, see Define a Cable Configuration,
page 438.
4. Click Create.
5. On the Cable Properties dialog box, under Cable, type a unique cable name.
6. Under Cable class, select Telecom.
7. Enter the rest of the cable properties as you require and click OK.
Related Topics
Explorer, page 739
page 744

Telecom Design
Creating and Managing Telecom Panels Common

Tasks
The following tasks are used frequently when you define and manage various telecom
panels such as patch panels, junction boxes, and distribution frames.
You can create a telecom panel in the Domain Explorer or the Reference Explorer.
If you are creating a panel that is going to have a frequently used configuration, we
recommend that you create it in the Reference Explorer. Reference panels facilitate
fast creation of plant panels by copying an existing panel configuration from the
Reference Explorer to the Domain Explorer. However, if you want to create a
panel that does not have a configuration that you intend to use frequently, we
recommend that you create this panel in the Domain Explorer and in the <unit>
where it is to be physically located. This is helpful when filtering the panels in the
current <unit>.
Create a Telecom Junction Box

This procedure explains how to create a Telecom junction box. For more
information, see Create a Telecom Junction Box, page 753.
Create a Splice Panel

This procedure explains how to create a splice panel. For more information, see
Create a Splice Panel, page 754.
Create a Patch Panel

This procedure explains how to create a patch panel. For more information, see
Create a Patch Panel, page 756.
Create a Distribution Frame

This procedure explains how to create a distribution frame. For more information,
see Create a Distribution Frame, page 755.

Telecom Design
Create a Telecom Junction Box

2. Right-click the Junction Boxes folder and then on the shortcut menu click New >
Telecom Junction Box.
3. On the Telecom Junction Box Properties dialog box, on the General tab, under
Panel, type the name of the new junction box.
5. Under Dimensions, type a value for the junction box dimensions if needed.
racks that will be possible to create in this junction box.
Tip
• Type zero if you want to have an unlimited number of racks.
9. Select the Set as intrinsically safe check box if this junction box has intrinsic
10. Click the Associate Symbols tab to associate a symbol with the current junction
box. The software will use this symbol when generating a report in the Enhanced
12. Click OK to accept your definitions for the new panel and close this dialog box.
Related Topics
Explorer, page 739
• Creating and Managing Telecom Panels Common Tasks, page 752

Telecom Design
Create a Splice Panel

2. Right-click the Splice Panels folder and then on the shortcut menu click New >
Splice.
3. On the Splice Panel Properties dialog box, on the General tab, under Panel,
type the name of the new panel.
5. Under Dimensions, type a value for the splice panel dimensions if needed.
racks that will be possible to create in this splice.
Tip
9. Select the Set as intrinsically safe check box if this splice panel has intrinsic
10. Click the Associate Symbols tab to associate a symbol with the current splice.
11. Click Revisions to manage the revisions of the new splice panel if needed.
12. Click OK to accept your definitions for the new splice panel and close this dialog
box.
Related Topics
Explorer, page 739

Telecom Design
Create a Distribution Frame

2. Right-click the Distribution Frames folder and then on the shortcut menu click
New > Distribution Frame.
3. On the Patch Panel Properties dialog box, on the General tab, under Panel, type
the name of the new panel.
5. Under Dimensions, type a value for the distribution frame dimensions if needed.
racks that will be possible to create in this distribution frame.
Tip
9. Select the Set as intrinsically safe check box if this distribution frame has
intrinsic safety certification.
10. Click the Associate Symbols tab to associate a symbol with the current
distribution frame. 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 431.
12. Click OK to accept your definitions for the new distribution frame and close this
dialog box.
Related Topics
Explorer, page 739

Telecom Design
Create a Patch Panel

2. Right-click the Patch Panels folder and then on the shortcut menu click New >
Patch Panel.
3. On the Patch Panel Properties dialog box, on the General tab, under Panel, type
the name of the new panel.
5. Under Dimensions, type a value for the patch panel dimensions if needed.
racks that will be possible to create in this panel.
Tip
9. Select the Set as intrinsically safe check box if this panel has intrinsic safety
certification.
12. Click OK to accept your definitions for the new panel and close this dialog box.
Related Topics
Explorer, page 739

Telecom Design
Managing Equipment Cabinets and Equipment

Items Common Tasks
The following tasks are used frequently when you define and manage telecom
equipment cabinets in your plant.
SmartPlant Instrumentation allows you to create a number of equipment cabinets that

you can use for various purposes. Once you have created the cabinets you require,
you can create the appropriate equipment for each cabinet.
You can create an equipment cabinet in the Domain Explorer or the Reference
Explorer. If you are creating an equipment cabinet that is going to have a frequently
Reference equipment cabinets facilitate fast creation of plant equipment cabinets by
copying an existing cabinet configuration from the Reference Explorer to the
Domain Explorer. However, if you want to create an equipment cabinet that does
not have a configuration that you intend to use frequently, we recommend that you
create it in the Domain Explorer and in the <unit> where it is to be physically
located. This is helpful when filtering the panels in the current <unit>.
Create a PA Cabinet
This procedure explains how to create a PA cabinet. For more information, see
Create a PA Cabinet, page 760.
Create an Amplifier
The software allows you to add amplifiers to an existing PA cabinet. Once you have
created an amplifier, you can create strips and connectors under this amplifier. For
more information, see Create an Amplifier, page 761.
Add a Connector to an Amplifier

This procedure explains how to add a connector to an amplifier. In the SmartPlant
Instrumentation Explorer, connectors are child items of amplifiers and switches.
For more information, see Add a Connector to an Amplifier, page 762.
Create a PABX Cabinet

This procedure explains how to create a private automatic branch exchange (PABX)
cabinet. Then, you can add PABX racks and terminal strips to the new PABX
cabinet. For more information, see Create a PABX Cabinet, page 762.
Create a PABX Rack

This procedure explains how to create a rack in a private automatic branch exchange
(PABX) cabinet. For more information, see Create a PABX Rack, page 763.

Telecom Design
Create a Switch
The software allows you to create switches after adding a rack to a PABX cabinet.
Once you have created a switch, you can add a switch port and a connector. For more
information, see Create a Switch, page 764.
Add a Switch Port

This procedure explains how to add a port to an existing switch. For more
information, see Add a Switch Port, page 765.
Add a Connector to a Switch

This procedure explains how to add a connector to a switch. In the SmartPlant
Instrumentation Explorer, connectors are child items of switches and amplifiers.
For more information, see Add a Connector to a Switch, page 765.
Create a Switch Channel

After creating a switch port, you can add a channel to this port. For more
information, see Create a Switch Channel, page 766.
Create and Associate a Telephone Number

This option allows you to create a telephone number in a PABX cabinet and
automatically associate it with a switch channel. For more information, see Create
and Associate a Telephone Number, page 766.
Associate a Telephone Number with a Channel

The software allows you to associate a telephone number with a switch channel.
Note that a switch channel can be associated with many telephone numbers. For
more information, see Associate a Telephone Number with a Channel, page 768.
Create a Miscellaneous Cabinet

Miscellaneous cabinets are intended for video equipment, entertainment systems, and
so forth. After creating a miscellaneous cabinet, you can add a rack and a terminal
strip. For more information, see Create a Miscellaneous Cabinet, page 768.
Create a Hub Cabinet

This procedure explains how to create a hub cabinet. After creating a hub cabinet,
you can add hub equipment. For more information, see Create a Hub Cabinet, page
769.
Create Hub Equipment

You can add hub equipment to a hub cabinet. Hub equipment is a type of wiring
equipment. After creating hub equipment, you can add a port and a hub connector.
For more information, see Create Hub Equipment, page 770.

Telecom Design
Create a Hub Connector

This procedure explains how to add a hub connector to a hub.. For more information,
see Create a Hub Connector, page 771.
Add a Port to a Hub

This procedure explains how to add a port to a hub. For more information, see Add a
Port to a Hub, page 771.
Create an Intercom Cabinet

This procedure explains how to create an intercom cabinet. After creating an
intercom cabinet, you can add intercom equipment and a terminal strip. For more
information, see Create an Intercom Cabinet, page 772.
Add Intercom Equipment

This procedure explains how to add intercom to an intercom cabinet. For more
information, see Add Intercom Equipment, page 773.
Add an Intercom Connector

This procedure explains how to a connector to an intercom. For more information,
see Add an Intercom Connector, page 774.

Telecom Design
Create a PA Cabinet
2. Right-click the Equipment Cabinets folder and then on the shortcut menu click
New > PA Cabinet.
3. On the PA Cabinet Properties dialog box, on the General tab, under Panel, type
the name of the new cabinet.
racks that will be possible to create in this cabinet.
Tip
certification.
10. Click the Associate Symbols tab to associate a symbol with the current cabinet.
Related Topics
Explorer, page 739
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 757

Telecom Design
Create an Amplifier
2. Expand the Equipment Cabinets folder and then right-click a PA cabinet to
which you want to add an amplifier.
3. On the shortcut menu click New > Amplifier.
4. On the New Wiring Equipment dialog box, type a name for the new amplifier
and click OK.
5. On the Wiring Equipment Properties - Amplifier dialog box, on the General
tab, under Name, accept or type a name of the new amplifier.
6. Select the Double width check box if the amplifier occupies a double width slot
or position.
b. Select an amplifier type, model, and manufacturer. If the required value is not
c. Enter a sequence if you need to define the amplifier sequence.
Tip
Related Topics
Explorer, page 739
page 757

Telecom Design
Add a Connector to an Amplifier

1. In the Domain Explorer, right-click an amplifier to which you want to add a
connector.
2. On the shortcut menu click New > Connector.
3. On the Connector Properties dialog box, type a connector name.
4. Select a connector type. Click to add new connector types to this list.
5. Define the connector as male or female.
6. Select a panel side for the connector.
7. Click OK.
Related Topics
Explorer, page 739
page 757
Create a PABX Cabinet

New > PABX Cabinet.
3. On the PABX Cabinet Properties dialog box, on the General tab, under Panel,
type the name of the new cabinet.
Tip
certification.

Telecom Design
Related Topics
Explorer, page 739
page 757
Create a PABX Rack

1. In the Domain Explorer, expand the Telecom Panels folder, which is located
within the Panels by Category folder.
2. Expand the Equipment Cabinets folder and then right-click a PABX cabinet
where you want on create a rack.
3. On the shortcut menu click New > PABX Rack.
4. On the Rack Properties dialog box, on the General tab, under Rack, type the
name of the new rack
5. Type a brief description as you require.
6. Enter the rack sequence in its parent cabinet.
7. Click Slots to add slots to the current rack.
8. On the Batch Slot Creation dialog box, type the number of new slots that you
want to add in the new rack.
9. Do the following to define the slot numbering:
a. Type a prefix for the slot name.
b. Enter a value in the Start from number and Increment by fields.
10. Click OK to add the new slots and to return to the Rack Properties dialog box.
Tip
• On the Rack Properties dialog box, the software now displays the
number of slots that you added.
11. Click the Associate Symbols tab to associate a symbol with the current rack. The
12. Click OK to accept your definitions for the new rack and close this dialog box.

Telecom Design
Create a Switch
2. Expand the Equipment Cabinets folder to display the existing PABX cabinets.
3. Double-click a PABX cabinet to display the existing PABX racks.
4. Right-click a PABX rack to which you want to add a new switch and then on the
shortcut menu, click New > Switch.
5. On the New Wiring Equipment dialog box, type a name for the new switch and
click OK.
6. On the Wiring Equipment Properties - Switch dialog box, on the General tab,
under Name, accept or type a name of the new switch.
7. Select the Double width check box if the amplifier occupies a double width slot
or position.
b. Select an amplifier type, model, and manufacturer. If the required value is not
c. Enter a sequence if you need to define the switch sequence.
Tip
Related Topics
Explorer, page 739
page 757

Telecom Design
Add a Connector to a Switch

3. Double-click a PABX cabinet and then a PABX rack to display the existing
switches.
4. Right-click a switch to which you want to add a new connector and then on the
shortcut menu, click New > Connector.
7. Define the connector as male or female.
9. Click OK.
Related Topics
Explorer, page 739
page 757
Add a Switch Port

3. Double-click a PABX cabinet and then a PABX rack to display the existing
switches.
4. Right-click a switch to which you want to add a new port and then on the shortcut
menu, click New > Switch Port.
5. On the General tab of the Switch Port Properties dialog box, type a name for
the new switch port.
6. Click the Associate Symbols tab to associate a symbol with the current switch
port. The software will use this symbol when generating a report in the Enhanced
7. Click OK.

Telecom Design
Create a Switch Channel

3. Expand the hierarchy of a PABX cabinet and then double-click a PABX rack,
switch, and then a switch port.
4. Right-click a switch port to which you want to add a new channel and then on the
shortcut menu, click New > Switch Channel.
5. On the General tab of the Channel Properties dialog box, type a name for the
new channel.
6. Type a brief description if required.
7. Enter an appropriate sequence of the current channel in its parent switch port.
8. Click the Associate Symbols tab to associate a symbol with the current channel.
9. Click OK to accept your settings and close this dialog box.
Related Topics
Explorer, page 739
page 757
Create and Associate a Telephone Number

3. Expand the hierarchy of a PABX cabinet and then double-click a PABX rack,
switch, and then a switch channel.
4. Right-click a switch channel and create a terminal if there is there is no terminal
under the current switch channel.
5. Right-click the Telephone folder and then on the shortcut menu, click New >
Telephone.
6. On the Telephone Properties dialog box, type a telephone number and
description as you require.

Telecom Design
7. Select an appropriate telephone state and usage. If the values that you need do not
exist on the Telephone state and Telephone usage lists, you can add them in the
Telecom supporting tables in the Wiring module. To do this, in the Wiring
module, click Tables > Telecom > Telephone State or Telephone Usage.
8. Click OK.
Related Topics
Explorer, page 739
page 757
Create an Unassociated Telephone Number

1. In the Wiring module, click Tables > Telecom Telephone Numbers.
2. On the Telephone Numbers dialog box, click New.
3. Type an appropriate number, description, telephone state, and telephone usage as
you require.
4. Click OK.
Related Topics
Explorer, page 739
page 757

Telecom Design
Associate a Telephone Number with a Channel

1. In the Domain Explorer, expand the hierarchy of a PABX panel to display the
existing racks, switches, switch ports, and terminals.
2. Right-click a channel, then on the shortcut menu, click Actions > Associate
Telephone Numbers.
3. On the Associate Telephone Numbers dialog box, select an available telephone
number and click Associate.
4. Click Close when done.
Related Topics
Explorer, page 739
page 757
Create a Miscellaneous Cabinet

New > Miscellaneous Cabinet.
3. On the Miscellaneous Cabinet Properties dialog box, on the General tab, under
Panel, type the name of the new cabinet.
Tip
certification.

Telecom Design
Related Topics
Explorer, page 739
page 757
Create a Hub Cabinet

New > Hub Cabinet.
3. On the Hub Cabinet Properties dialog box, on the General tab, under Panel,
type the name of the new cabinet.
Tip
certification.

Telecom Design
Create Hub Equipment

1. In the Reference Explorer or Domain Explorer, expand the Telecom Panels
folder.
2. Expand the Equipment Cabinets folder to display the existing hub cabinets.
3. Right-click a hub cabinet and then on the shortcut menu, click New > Hub
Equipment.
4. On the New Wiring Equipment dialog box, type a name for the new hub
equipment and then click OK.
5. On the General tab of the Wiring Equipment Properties - Hub dialog box, type
the name of the new hub.
6. Select the Double width check box if the hub occupies a double width slot or
position.
b. Select a hub type, model, and manufacturer. If the required value is not
c. Enter a sequence if you need to define the hub sequence.
Tip
Related Topics
Explorer, page 739
page 757

Telecom Design
Create a Hub Connector

1. In the Domain Explorer or Reference Explorer, expand a hub cabinet hierarchy
to display the existing hub equipment and hub ports.
• Right-click a port to which you want to add a hub connector.
• Right-click the Hub Connectors folder.
3. On the shortcut menu, click New > Hub Connector.
6. Set whether the connector is male or female.
8. Click OK.
Related Topics
Explorer, page 739
page 757
Add a Port to a Hub

1. In the Domain Explorer or Reference Explorer, navigate to a hub cabinet.
2. Double-click a hub cabinet to display the existing hub equipment.
3. Right-click a hub equipment item and then on the shortcut menu, click New >
Port.
4. On the General tab of the Port Properties dialog box, type a name for the new
port.
5. Type a brief description if necessary.
6. Enter the port sequence in the hub if needed.
7. Click the Associate Symbols tab to associate a symbol with the current port. The
8. Click OK.

Telecom Design
Create an Intercom Cabinet

New > Intercom Cabinet.
3. On the Intercom Cabinet Properties dialog box, on the General tab, under
Panel, type the name of the new cabinet.
Tip
certification.
Related Topics
Explorer, page 739
page 757

Telecom Design
Add Intercom Equipment

1. In the Reference Explorer or Domain Explorer, expand the Telecom Panels
folder.
2. Expand the Equipment Cabinets folder to display the existing intercom cabinets.
3. Right-click an intercom cabinet and then on the shortcut menu, click New >
Intercom Equipment.
4. On the New Wiring Equipment dialog box, type a name for the new intercom
equipment and then click OK.
5. On the General tab of the Wiring Equipment Properties - Intercom dialog box,
type the name of the new intercom.
6. Select the Double width check box if the hub occupies a double width slot or
position.
b. Select a intercom type, model, and manufacturer. If the required value is not
c. Enter a sequence if you need to define the intercom sequence in the cabinet.
Tip
Related Topics
Explorer, page 739
page 757

Telecom Design
Add an Intercom Connector

1. In the Domain Explorer or Reference Explorer, expand a hub cabinet hierarchy
to display the existing intercom equipment.
3. Right-click an intercom to which you want to add a connector.
4. On the shortcut menu, click New > Connector.
7. Set whether the connector is male or female.
9. Click OK.
Related Topics
Explorer, page 739
page 757

Telecom Design
Generating Telecom Reports Common Tasks

The following tasks are used frequently when you generate telecom reports.
Generate a Telecommunication Device List

This option enables you to generate a report that lists all the existing
telecommunication devices in the current <unit> or all the <units> in the current
<plant>. The report lists all tag numbers (telecom devices), their service, device
types and line numbers, location layouts, field equipment and signal levels,
manufacturers and models, as well as the fire areas and load data. You generate this
report in the Instrument Index module. For more information, see Generate a
Telecommunication Device List, page 777.
Generate a Communication Line Report

You can generate a report that displays the connection path of all field device panels
on a selected communication line. The connection path includes all the connected
panels, their terminals and ports. For more information, see Generate a
Communication Line Report, page 776.
Generate a Speaker Load Report

This option allows you to generate a report that displays all the field device panels
connected to a specific channel in a selected equipment card. For more information,
see Generate a Speaker Load Report, page 777.
Generate a Telecom Device Type Report

This option allows you to generate a report that lists the existing telecom device
types. You can generate a standard list report or a detailed list report depending on
your needs. The standard report lists all the existing telecom device type acronyms
and their definitions. The detailed report provides additional information for every
telecom device type such as specification form number, reference panel and cable,
connection type, and so forth. For more information, see Generate a Telecom Device
Type Report, page 778.
Generate a Telecom Line Number Report

Telecom Line Numbers report lists all the existing line numbers, their descriptions,
origins and destinations, their types, and so forth. For more information, see
Generate a Telecom Line Number Report, page 778.
Generate a Telecom Field Equipment Report

This option enables you to generate a list of all the existing telecom field equipment.
The report lists the equipment ex-code, IS code gas group, temp. class, frequency
code, effect, and the telecom ID number. For more information, see Generate a
Telecom Field Equipment Report, page 778.

Telecom Design
Generate a Telecom Signal Level Report

Signal level report lists all the existing telecom signals, their descriptions, and
capacity. For more information, see Generate a Telecom Signal Level Report, page
779.
Generate an Actual Load Report

This option enables you to generate an actual load report per channel for a selected
equipment card. This report includes the sum of all field device panels connected to a
specific channel. For more information, see Generate an Actual Load Report, page
779.
Generate a Communication Line Report

Important
• You must install the Enhanced Report Utility on your local machine to
be able to generate the communication line report. For details, see
Enhanced Report Utility Installation Guide.
1. In the Wiring Module window, click Reports > Telecom > Communication
Line Report.
2. On the Communication Line Selection dialog box, select a communication line
Click OK.
3. At the print preview prompt, do one of the following:
• Click Yes to open the print preview of the generated report. Choose
this option if you want to modify or annotate the report.
• Click No to start printing the report without displaying its print
preview.
Note
• On the General tab of the Preferences dialog box, you can set
SmartPlant Instrumentation to display a print preview always, never or
with your approval.
• If you select not to preview a report, and you are using Acrobat
Distiller as your default printer, make sure that Distiller is configured
enable report generation without prompting for the output file location.
To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination
and Ask to replace existing PDF file.
Related Topics
• Generating Telecom Reports Common Tasks, page 775

Telecom Design
Generate a Speaker Load Report

1. In the Wiring Module window, click Reports > Telecom > Speaker Load
Report.
2. On the Panel – Strip Selection dialog box, click Find.
3. Select a card and click Print.
4. On the Print Preview Request, click Yes to display the report before printing it
or click No to print out the report without displaying it first.
Note
• You can also generate this report from the Domain Explorer. Expand
the hierarchy of a PA panel. Then, after right-clicking an amplifier,
click Reports > Speaker Load Report.
Related Topics
Generate a Telecommunication Device List

1. Switch to the Instrument Index module.
2. In the Instrument Index window, click Reports > Telecom Devices.
3. On the Report Selection Options, select one of the following options:
• Current <Unit> — include the telecom devices belonging to the
current <plant> only.
• Current <Area> — include the telecom devices belonging to the
current <area> only.
• All <Units> — include the telecom devices belonging to all the
<unit> in the current <plant>.
4. When prompted to preview the new report, click Yes. Click No to print out the
report without opening its print preview.
Related Topics

Telecom Design
Generate a Telecom Device Type Report

2. In the Instrument Index window, do one of the following:
• Click Reports > Telecom Tables > Standard Telecom Type List.
• Click Reports > Telecom Tables > Detailed Telecom Type List.
Related Topics
Generate a Telecom Line Number Report

2. In the Instrument Index window, click Reports > Telecom Tables > Telecom
Line Numbers.
Related Topics
Generate a Telecom Field Equipment Report

Field Equipment.
Related Topics

Telecom Design
Generate a Telecom Signal Level Report

Signal Level.
Related Topics
Generate an Actual Load Report

1. In the Wiring Module window, click Reports > Telecom > Actual Load
Report.
2. On the Panel – Strip Selection dialog box, click Find.
3. Select a card and click Print.
4. On the Print Preview Request, click Yes to display the report before printing it
or click No to print out the report without displaying it first.
Note
• You can also generate this report from the Domain Explorer. Expand
the hierarchy of a PA panel. Then, after right-clicking an amplifier,
click Reports > Actual Load Report.
Related Topics

Specifications
Specifications
Overview
The Specifications module provides the means to efficiently generate detailed
specification documents (often referred to as specs). This is helpful for engineering
and ordering procedures and provides a useful permanent record for checking
installed instruments. The Specifications module also incorporates data from the
Instrument Index, Process Data, and Calculation modules into generated documents.
You can only generate specifications in the Specifications module. A generated

specification automatically appears in the Domain Explorer, under the items for
which you generated the specification. You can open an existing spec either from the
Domain Explorer, Specifications module, or Instrument Index Standard Browser
view.
When printing a specification, we recommend that the print sheet size be either A4 or
Letter.
Related Topics
• Composite Specifications: An Overview, page 869
• Copying Specification Data Common Tasks, page 886
• Managing Spec Pages Common Tasks, page 790
• Multi-Tag Specs Common Tasks, page 847
• Non-Instrument Specs Common Tasks, page 865
• Principles of Generating Specifications, page 781
• Printing Specifications and Reports Common Tasks, page 933
• Save, Export, and Import Options Common Tasks, page 901
• Single-Tag Specs Common Tasks, page 836
• Spec Forms Common Tasks, page 822
• Spec Title Block Common Tasks, page 880
• Specification General Operations Common Tasks, page 783

Specifications
Principles of Generating Specifications

SmartPlant Instrumentation generates a specification based on a pre-defined spec
form that you associate with the source item. Each form consists of one or more spec
pages, which, in turn can contain one or more sections. A spec page that does not
include sections you define in the Section Editor is considered a single-section page.
A spec page that contains sections you define in the Section Editor is referred to as
composite.
When you first create a specification for an item, you have to specify the form
number to create the item-form association. On subsequent occasions, you only need
to specify the item number to display the specification. It is only possible to generate
a spec in the Specifications module. On generating a spec, the software automatically
creates a unique document number for the spec.
Each specification is made up of data portions. For example: general data, process
data, construction data, purchase data, a note field, and a specification header, which
is the title block. The General Data portion of the spec includes details that were
entered in the Instrument Index module. The Process Conditions portion values are
derived from the Process Data module (if available) along with calculation results
from the Calculation module (if available). If you defined multiple cases for a given
tag, the specification displays the process data from the governing case.
You can generate the following types of specifications:
• Single-item specification — a document with details about a single

item, or a specific process data case of an instrument. The source
form for such a document can only contain single-section pages.
• Multi-tag instrument specification — a document with details about
two or more instruments. A multi-tag instrument specification
includes common pages with fields that are identical for all of the
instruments, and a SEE LIST page with values that differ from
instrument to instrument. A multi-tag specification is only available
when the item type is instrument. The source form for such a
document can only contain single-section pages.
• Loop composite specification — a document with details about a
loop and its instrument tags. The source form for such a document
must contain sections you define in the Section Editor: one loop
section and one or more instrument sections.
• Instrument composite specification — a document that integrates data
about several instruments or process data cases of an instrument. In
contrast to multi-tag instrument specifications, an instrument
composite specification does not have common pages and can include
tags whose process functions are not identical. The source form for
such a document must contain sections you define in the Section

Specifications
Editor. Each section in a composite spec page contains data pertinent

to a specific instrument tag or process data case.
It is possible to generate specs either in the Specifications module, or in the Domain
Explorer. In the Specifications module, you can generate one spec at a time, and
open this spec on completing the generation. In the Domain Explorer, you can only
generate instrument specs but you can generate specs in batch mode, provided that
you defined the instrument type profile for the instruments you select in the Domain
Explorer.
Notes
• If you want to generate a non-instrument spec, for example, a panel
spec, a hook-up item spec, and so forth, you must first restore the
appropriate library forms.
• You cannot generate specifications for virtual tags.
• It is only possible to generate one spec at a time.
Related Topics
• Multi-Tag Specs: An Overview, page 846
• Non-Instrument Specs: An Overview, page 864
• Process Data Case Specs: An Overview, page 842
• Single-Tag Specs: An Overview, page 835
• Specifications: An Overview, page 780

Specifications
Specification General Operations Common Tasks

The following tasks deal with such operations as batch generation and deletion of
specs, describes the ways of defining spec document numbers and opening existing
specs, and also addresses other miscellaneous operations you can perform with specs
Generate Instrument Specs in Batch Mode

Use this procedure to generate specs for instruments you select in the Domain
Explorer, or Instrument Index Standard Browser view. For more information, see
Generate Instrument Specs in Batch Mode, page 784.
Open a Spec from the Instrument Index Standard Browser View

You can open an existing specification from an Instrument Index Standard Browser
view. To open a spec, you must make sure that on the Preferences dialog box, under
Browser view, the Open specification sheet setting is either Always or Ask User.
For more information, see Open a Spec from the Instrument Index Standard Browser
View, page 785.
Open a Spec from the Specifications Module

Use this procedure to find an item and the form number on which the item
specification is based and open it the Specifications module. For details, see Open a
Spec from the Specifications Module, page 785.
Create a Tag Number in the Specifications Module

Use this procedure to create an instrument tag in the Specifications module. This
allows you to generate an instrument specification without having to create a new
instrument tag first in the Instrument Index module or the Domain Explorer. For
more information, see Create a Tag Number in the Specifications Module, page 786.
Delete Specs in Batch Mode

This procedure allows you to delete a batch of specifications. You can use the same
procedure if you need to delete only one specification. Using this procedure, you can
delete single-tag specs and multi-tag specs. It is only possible to delete specs from
the Specifications module. The software does not allow you to delete a spec that is
currently assigned to a Specification Binder package or revised in the Document
Binder module. For more information, see Delete Specs in Batch Mode, page 787.
Add Expanded Notes and Remarks

Use this procedure to add text in the Note tab of a specification if the space in the
note box in the specification data sheet is insufficient to enter all the text string. For
more information, see Add Expanded Notes and Remarks, page 787.

Specifications
Ways of Defining a Spec Document Number

This topics lists the Specifications module options that allow you to define a
document number for a spec. If the Domain Administrator has set the document
number naming convention for specs, the software automatically creates a default
document number on generating a specification. You can either accept this number or
modify it as you require. For more information, see Ways of Defining a Spec
Document Number, page 788.
Related Topics
Generate Instrument Specs in Batch Mode

• In the Instrument Index module, open the Instrument Index Standard
Browser view, and then, select one or more instruments.
Press F7 to open the Domain Explorer and then, in the Items pane,
•
select the instruments you require.
2. Right-click the selected instruments, and then, on the shortcut menu, click
Actions > Generate a Specification.
Tip
The software generates specs according to the profile settings defined
•
for the instrument type to which the selected instrument tags belong.
For example, if you want to add certain instruments to a see list of a
multi-tag spec, make sure that on the Instrument Type Profile dialog
box, you specified both the spec form number and the see list format.
For more details, see Define an Instrument Type Profile, page 348.
3. On the Results dialog box, view the spec generation results, and then click Close.
Tip
• The software does not open the generated specs automatically because
you cannot open several specs at a time. If you want to open a spec,
select a specific instrument and then, on the shortcut menu, click
Reports > Specification.
Related Topics

Specifications
Open a Spec from the Instrument Index Standard Browser

View
1. In the Instrument Index Standard Browser View, select an instrument.
2. On the main toolbar, click .
Note
• You can only perform this procedure if you have already generated a
spec for the selected tag in the Specifications module. Also, to open a
spec, you must make sure that on the Preferences dialog box, under
Browser view, the Open specification sheet setting is either Always
or Ask User
Related Topics
• Open a Spec from the Instrument Index Standard Browser View, page
785
Open a Spec from the Specifications Module

• On the Modules menu, click Specifications.
2. On the Actions menu, click Open Specification.
3. On the Open Specification dialog box, from the Item type list select the type of
the item whose spec you want to open.
4. If the item type is Instrument, from the Tag class list, select the appropriate tag
class.
5. With the mouse pointer in the Item number box, do the following:
a. Click Find to open the Find Items dialog box.
b. In the boxes in the upper part of the dialog box, type or select the parameters
for the properties that you want to find.
c. Click Find to display a list of items according to the search parameters that
you have selected.
d. Select the required item from the retrieved list.
e. Click OK to accept your choice and return to the Open Specification dialog
box.
6. With the mouse pointer in the Form number box, do the following:
a. Click Find to open the Select Specification Form dialog box.

Specifications
b. Select the required form and click OK.

7. On the Open Specification dialog box, click OK to open the spec associated with
the item that you selected.
Related Topics
• Open a Spec from the Instrument Index Standard Browser View, page
785
Create a Tag Number in the Specifications Module

1. Click File > Preferences > Specifications, and on the General tab, under Tag
creation, select Allowed.
2. On the Specifications Module window menu bar, click Actions > Open
Specification.
3. On the Open Specification dialog box, from the Item type list, select
Instrument.
4. On the Item number box, type the number of the instrument that you want to
create and click Yes when prompted to create a new tag number.
5. If the Select Instrument Type dialog box opens, select the appropriate
instrument type and click OK.
6. On the Loop Number dialog box, accept the displayed loop number or type a
new one as required, and then click OK.
7. On the Tag Number Properties dialog box, define the tag properties as you
require, and then click OK.
Tip
• At this stage, you can define the spec form number and generate a
specification for the instrument tag that you have created.
Related Topics
• Open a Spec from the Specifications Module, page 785

Specifications
Add Expanded Notes and Remarks

• In a given specification, do the one of the following:
• Click Actions > Expand Notes.
• Click the Notes tab in the specification.
Tip
• On SQL Server, the Note sheet can accept up to 255 characters; on
Oracle or Sybase Adaptive Server Anywhere, you can type up to 2000
characters.
Related Topics
Delete Specs in Batch Mode

1. With the Specifications window open, on the Actions menu, click Delete
Specifications.
2. In the Select Items dialog box, find and select the items whose specs you want to
delete.
Tips
• If you created instrument specifications per tag case, you can delete
specifications on a per-case basis. For example, if you applied three
process data cases to a tag, three records appear in the Search results
data window. The Case column values indicate whether instrument
tags have tag process data cases.
• If the tag number selection includes a master tag, the software prompts
whether you want to perform or cancel the deletion of the
specifications. You have an option to cancel the deletion because
when you delete a master tag, the software dissociates all the other
tags from the multi-tag specification to which the master tag belongs.
3. In the Delete Specifications dialog box, click Run.
Tips
• If the software could not delete a specification, the source item appears
in the Items skipped during deletion data window. You can print out
the item list, if needed. These records are not saved after you close the
Delete Specifications dialog box.
• When you delete a specification, the software automatically deletes all
the associated revisions as well, whether you saved them to the

Specifications
database, or as files. The software removes revisions that were saved

as files form the Manage Spec Revisions dialog box, and also from
the folders to which they have been saved.
Note
• Deleting a spec does not affect process data. The software only
deletes the specification document, together with the document
number and associated revisions, whether you saved them to the
database, or as files. The software removes revisions that were saved
as files form the Manage Spec Revisions dialog box, and also from
the folders to which they have been saved.
Related Topics
Ways of Defining a Spec Document Number

In the Specifications module, you have the following ways of defining a spec
document number:
• When generating a new spec — On the New Specification dialog

box, in the Document number box, you can modify the default
document number as you require. The software always generates
automatically a document number for a specification, regardless of
whether the document number naming convention exists. If the
domain Administrator has not defined a naming convention for spec
document numbers, the software creates the document number using
the item tag name as a source, and append the – SP suffix.
• In the spec title block — You can open a spec and define the
document number in the Doc No. field of the title block.
• In the Revisions dialog box — With a spec displayed, you open the
Revisions dialog box and, in the Document number box, define the
document number.
Notes
• The document number string can contain up to 50 alpha-numeric
characters, including spaces.
• The document number must be unique.
• If you remove the document number, the current spec document does
not appear in the Document Explorer.
Related Topics

Specifications
Specification Pages: An Overview

Specification pages are the primary templates for spec forms, on which you base
specs. Spec pages enable you to categorize data within a specification form. For
example, a specification form can contain a thermowell specification page, a control
valve specification page, and a large note page.
SmartPlant Instrumentation provides a default library of spec pages you can use in
spec forms. A spec is always associated with a specific process function. If needed,
you can select a different process function for a page, provided that this page is not in
use in specs. A spec page contains a number of data fields, which correspond to table
columns in the database, and also contains field headers, which correspond to column
headers in the database. You can customize the data fields and fields headers to fit
specific requirements. You cannot, however, create new pages in SmartPlant
Instrumentation. All spec pages are based on the A4 print sheet size.
You open and manage spec pages in the Page Editor of the Specifications module.
Then you can use the Edit Fields and Headers floating toolbar options to modify the
spec page field layout without having to use a third-party interface, such as
InfoMaker.
Changes that you make on the page automatically take effect in all existing specs that
include this page, and also in the spec printout. These changes do not take effect in
specs saved as files. For example, if you change thickness of a specific line on a
page, and then save the page to the database, the software updates the line display in
all specs based on the form containing this page.
Important
• If you do want to edit a library page in InfoMaker, do not add items to
select lists, as this is liable to corrupt your database.
Related Topics
• Customizing Pages Common Tasks, page 809
• Maintenance Event Records: An Overview, page 1127

Specifications
Managing Spec Pages Common Tasks

These tasks deal with managing spec pages using the options available in the
Specifications module of SmartPlant Instrumentation. These tasks include opening
and saving spec pages, regeneration, process function selection, large note page
creation, and so forth.
Open a Page
Use this procedure to open a spec page in the Page Editor. You can open one page at
a time. For more information, see Open a Page, page 792.
Open a Page from an External File

Use this procedure to open in the Page Editor a spec page from a .psr file. For more
information, see Open a Page from an External File, page 793.
Display Data Field Names

Use this procedure to display the names of the data fields that a particular page
contains. For more information, see Display Data Field Names, page 793.
Display a List of Forms that Include the Current Page

You can use this procedure to check whether there are any spec forms that already
include a specific page that you open in the Page Editor. If you make any changes in
this page and save it, the software automatically updates all the forms that include this
page. For more information, see Display a List of Forms that Include the Current
Page, page 794.
Regenerate Pages
This procedure enables you to correct discrepancies that can occur on a page, and to
influence the display of various tables and table columns in the Table Column List
pop-up window in the Page Editor. When you implement this procedure, SmartPlant
Instrumentation automatically eliminates duplicate data fields on the current page and
updates the definition of the data fields included in the current page according to their
current table column definitions in the database. For more information, see
Regenerate Pages, page 794.
Save a Page to the Database

Use this procedure to save a page to the SmartPlant Instrumentation database. You
can save to the database any page, whether this is a page you open from an external
file, or a library page you modified. For more information, see Save a Page to the
Database, page 794.
Save a Page as an External File

Use this procedure if you need to save a page as an external file so that it can be used
with a third-party application, such as InfoMaker. You can save a page either as a

Specifications
.psr (PowerSoft Report) file or a .wmf (Windows METAFILE) graphic. For more
information, see Save a Page as an External File, page 795.
Delete a Page
Use this procedure to delete a specific spec page that are not associated with forms,
that is, a page you opened from a file, or a new page that you created on the basis of
an existing page. Also, you can delete a page that was previously associated with a
library form but you decided to retain this page after deleting the form. After deleting
such a page, you can restore is automatically when restoring the library form that is
based on this page. If you want delete a page you saved to the database from an
external file, we recommend that you first save this page as a file. After deleting such
a page, you can restore it by opening it from the external file. For more information,
see Delete a Page, page 795.
Create a Large Note Page

Use this procedure to create a large note page on the basis of any existing page. A
large note page is a page that consists of a text area and a title block. A large note can
appear on a separate page. To create a large note on a separate page, you must use
only the spec_note_large column of the add_spec9 table. When creating or
modifying a specification form, you can add a large note page to display large note
text in the appropriate specifications.
SmartPlant Instrumentation provides a default page, Large Note, which you can add
to the required specification forms. The default large note page does not contain any
data apart from the title block. When adding a new page to a designated specification
form, you can use either the default Large Note page or create a new large note page
on the basis of any existing page.
In a print preview for a specification that contains a large note, the software displays a
large note on a separate page in which you can scroll up and down to view the note
text. When printing a specification with a large note page, the software automatically
counts the total number of sheets and divides the large note page into separate sheets,
depending on the note text length. For more information, see Create a Large Note
Page, page 796.
Select a Different Process Function for a Page

You can select a different process function for an existing page. In this way you can
use the same page for instrument tags with different process function types. You
cannot change the process function of a page that is already in use in specs. For more
information, see Select a Different Process Function for a Page, page 798.
Set the Tab Order of the Fields on a Page

You can set the sequence in which you move the cursor in the page you are editing.
This way you determine which fields the cursor moves to when you press the Tab
key. For more information, see Set the Tab Order of the Fields on a Page, page 799.

Specifications
Switch to the Default Tab Order

You can switch from the tab order in the page you are currently editing to the default
tab order. For more information, see Switch to the Default Tab Order, page 799.
Retrieve Custom Pages as PSR Files

Use this procedure to retrieve one or more custom pages from the database as .psr
files. In the target folder that you specify, the software saves each page as a separate
.psr file with the name PAGE<page ID number>.psr. You can use this procedure if
you need to back up pages before editing them in the Page Editor, or if you need to
share pages with users outside of a given SmartPlant Instrumentation network. For
more information, see Retrieve Custom Pages as PSR Files, page 800.
Related Topics
• Specification Pages: An Overview, page 789
Open a Page
1. In the Specifications Module window, do one of the following to open the Page
Editor:
• Click Edit > Page Editor.
On the toolbar, click
• .
• On the menu bar, click Actions > Open Page.
On the toolbar, click .
•
3. On the Select Specification Page dialog box, select a page.

Tips
• On the Select Specification Page dialog box, selected Custom check
boxes indicate pages that you have customized.
•You can click Properties to change the name and description of the
page you want to open.
4. Click OK to open the page in the Page Editor.
Related Topics

Specifications
Open a Page from an External File

Editor:
• Click Actions > Open File.
3. Click Actions > Change Process Function.
4. On the Open File dialog box, navigate to the folder where your .psr file is located
and select the file.
5. Click OK to open the page in the Page Editor.
Related Topics
Display Data Field Names

1. Open a spec page in the Page Editor.
2. Do one of the following to display the Edit Fields and Headers floating toolbar:
• Click Actions > Edit Fields and Headers.
• On the Page Editor toolbar, click .
3. On the Edit Fields and Headers toolbar, click to display in the Field
Selection area all the field names which are used in the currently open page.
4. Click again to hide the display of the field names.
Related Topics

Specifications
Display a List of Forms that Include the Current Page

1. In the Specifications Module window, do one of the following:
•
2. On the Page Editor menu bar, click Actions > Form List.
Related Topics
Regenerate Pages
2. On the menu bar, click Actions > Regenerate Page.
3. On the Regenerate Page dialog box, under Select tables and views, select a
check box for each table or view from which you want to display additional
columns in the Table Column List pop-up window.
4. Under Show Columns, click Show for each required table or view.
5. Under Select columns, select all or specific columns that you want to display in
the Table Column List pop-up window.
6. Click OK.
Related Topics
Save a Page to the Database

2. To save the page to the database under a new name, or to save a page opened
from an external file, click Actions > Save as Page.
3. On the Save as Page dialog box, click New.
4. On a dialog box that opens, type a unique name and an optional description, and
then click OK.
Tips
• Clicking Actions > Save also saves the page to the database (under the
same name as the currently open page). You cannot use the Actions >
Save option to save a page opened from an external file.
• After you save a library page whose data fields you modified, it is
considered a custom page.

Specifications
Save a Page as an External File

• Click Actions > Save as File.
3. On the Save As dialog box, navigate to the required folder and type the target file
name.
Tip
• You can save the page as a .psr (PowerSoft Report) file or a .wmf
(Windows METAFILE) graphic.
4. Click OK to save the file.
Related Topics
Delete a Page
1. On the Page Editor menu bar, click Actions > Delete Page.
2. On the Select Specification Page dialog box, select the page you want to delete
and click OK.
Tips
• In the Page Editor, you can only delete a specific page, provided that
it is not in use in a spec form. If you want to delete all pages included
in a particular form, you need to delete the entire form. If this form is
a library form, you can restore the deleted pages automatically when
restoring this form. Note, however, that when restoring the form, the
software only restores the library pages, not pages you opened from an
external file and then included in this form.
Related Topics
• Delete a Form, page 829
• Restore Library Forms, page 830

Specifications
Create a Large Note Page

Note
•Creating a large note page by starting with a page that contains field
values can be time-consuming. On a data page, you will have to delete
all the field values one by one. Therefore, we recommend that you use
the default page Large Note in the specification forms. The default
large note page does not contain any data apart from the title block.
Also, if needed, you can create a large note page in InfoMaker, and
then open the page from appropriate external .psr file in the Page
Editor.
Editor:
On the toolbar, click
• .
• On the menu bar, click Actions > Open Page.
Tip
We recommend that you use a page with the General process function.
•
You need to perform a separate procedure to change the page process
function to General. For details, see Select a Different Process
Function for a Page, page 798.
• On the menu bar, click Actions > Regenerate Page.
•On the toolbar, click .
4. On the Regenerate Page dialog box, under Select tables, views, and columns,
select the check box for the add_spec9 table.
5. In the cell adjacent to the add_spec9 table cell, click Columns to display the
spec_note_large column in the Column Name data window.
6. Click OK to regenerate the page.

Specifications
Important
• Before adding the spec_note_large column to the current page as a
data field, make sure that the page does not contain any other data
fields apart from the title block. If the page is not empty, you must
delete all of the data fields. For details, see Delete Data Fields, page
818.
8. On the Edit Fields and Headers floating toolbar, click .
9. In the Table Column List pop-up window, select spec_note_large.
10. Drag the spec_note_large column from the Table Column List pop-up window
and drop it anywhere on the page.
11. Click to close the Table Column List pop-up window.
12. For your convenience, if needed, resize the spec_note_large data field as follows:
a. Point to the spec_note_large field border so that the cursor changes to a
double-headed arrow.
b. Resize the spec_note_large field by dragging the field borders to either side so
that the field occupies the entire page area, apart from the title block
Tip
• You do not have to resize the spec_note_large data field exactly.
When printing a form that with a large note page the software resizes
the spec_note_large data field automatically so that the
spec_note_large data field occupies the entire area of the printed
specifications.
13. On the Actions menu, click Edit Fields and Headers to close the floating
toolbar.
14. Save the large note page to the database.
Note
• If required, you can use the spec_note_large field on a data page. By
default, a data page in SmartPlant Instrumentation is the first page in a
specification form and contains various field values.
Related Topics
• Regenerate Pages, page 794
• Save a Page to the Database, page 794

Specifications
Select a Different Process Function for a Page

2. Click Actions > Change Process Function.
3. Select the target process function and click OK.
Tips
• You cannot change the process function of a page that is already in use
in specs. In this case you are prompted to save the page under a
different name.
• When changing the page process function, the software automatically
eliminates duplicate data field names in the current page, and also
updates the definition of the data fields included in the current page
according to their current table column definition in the database.
• Changing the page process function may prompt a warning, preceded
by SQL command error messages. These messages inform you that
the page for which you are changing the process function contains
undefined values, for example, specification custom fields.
The data fields that caused SQL command errors are not available in
•
the page after the process function change takes effect.
4. On the Regenerate Page dialog box, select a check box for each table or view
from which you want to change the display of table columns in the Table
Column List pop-up window.
Tip
When you changed the process function, the software automatically
•
updated the table columns available to you in the Table Column List
pop-up window.
5. Under Show Columns, click Show for each required table or view.
6. Under Select columns, select all or specific columns that you want to display in
the Table Column List pop-up window.
7. Click OK.
Related Topics

Specifications
Set the Tab Order of the Fields on a Page

2. Click Actions > Tab Order to display the tab numbers on the page.
3. Set the field order by typing in sequence numbers (20, 30, 40, and so forth) in the
fields that you want to sequence.
Tip
• Assigning a zero (0) to a field means that it will not be editable (read-
only). Some fields are read-only by default and not available for
editing even if you assign a tab sequence to them. For example, the
zero number applies to all fields you added in the page using
InfoMaker.
4. When done, click Actions > Tab Order once again, to clear the tab number
display.
Related Topics
Switch to the Default Tab Order

Important
• This action overwrites the tab order in the currently open page with the
default tab order. After performing this procedure and saving the
page, it is not possible to revert to the original tab order.
1. With the specification page open for editing, click Actions > Tab Order to
display the tab numbers on the page according to the current tab order.
2. Click Actions > Default Tab Order.
3. Click Actions > Tab Order to clear the tab number display.
4. Save the spec page.
Related Topics

Specifications
Retrieve Custom Pages as PSR Files

1. On the Specifications Module window menu bar, click Actions > Retrieve
Custom Pages as PSR Files.
2. Select one or more custom pages.
3. Under Target folder, accept the displayed folder path, or click Browse do specify
a target folder for saving the selected custom pages as .psr files.
Tip
The path displayed in the Target folder box is the path set for the PSR
folder option on the Specifications > General page of the Preferences dialog
box.
4. Click OK.
Related Topics

Specifications
Working with Page Graphics Common Tasks

These tasks deal with adding graphic objects in a spec page and modifying their
properties. These graphic objects include data fields, text boxes, computed fields,
grid lines, and so forth.
Add a Line to a Page

Use this procedure to add a graphic line to a specification page. For more
information, see Add a Line to a Page, page 802.
Modify Line Position and Length Using Arrow Keys

Use this procedure to modify the position and length of a single line on a page using
the arrow keys on the keyboard. For more information, see Modify Line Position and
Length Using Arrow Keys, page 803.
Modify Line Position and Length Using the Mouse

Use this procedure to modify the position and length of a single line on a page using
the mouse. For more information, see Modify Line Position and Length Using the
Mouse, page 804.
Set Precise Position and Length of a Line

Use this procedure to set the X and Y coordinates of a single line. For more
information, see Set Precise Position and Length of a Line, page 803.
Change Line Properties

Use this procedure to change color, style, and thickness properties of a single line you
select in a spec page. For more information, see Change Line Properties, page 804.
Duplicate Page Lines

This procedure enables you to duplicate a graphic line on a page. For more
information, see Duplicate Page Lines, page 805.
Add Graphics to a Page

Use this procedure to add graphic images to your specification pages. The graphic
files that you include in your pages must be in .bmp format. For more information,
see Add Graphics to a Page, page 806.
Set Precise Position and Size of Page Objects

Use this procedure to set the X and Y coordinates of a page object. You can set
precise size and position of data fields, text boxes, computed fields, and graphic
elements, for example, lines. For more information, see Set Precise Position and Size
of Page Objects, page 807.

Specifications
Modify Position and Size of Page Objects Using Arrow Keys

Use this procedure to modify the position and size of a page object using the arrow
keys on the keyboard. You can modify size and position of data fields, text boxes,
computed fields, and graphic elements, for example, lines. For more information, see
Modify Position and Size of Page Objects Using Arrow Keys, page 808.
Modify Position and Size of Page Objects Using the Mouse

Use this procedure to modify the position and size of a page object using the mouse.
You can modify size and position of data fields, text boxes, computed fields, and
graphic elements, for example, lines. For more information, see Modify Position and
Size of Page Objects Using the Mouse, page 808.
Related Topics
Add a Line to a Page

On the Page Editor toolbar, click .
•
3. On the Edit Fields and Headers toolbar, click .

4. In the Page Editor working area, do one of the following:
• For a horizontal line, click the location of the left end of the line that
you want to create.
To prepare for a vertical line, click to the left of the location.
•
5. On the Line dialog box, under Line ID, accept the default ID or type a different
unique line ID number.
6. Accept the displayed line end coordinates or enter new coordinates as you require.
7. Under Line color, select the color that you need.
8. Under Line style, select the line display style that you need.
9. Under Line thickness, type the new value or use the spinners to set a value using
PowerBuilder units from one to five.
10. Click OK to display the new line on the page (the software displays small white
dots at the ends of the line that you just created).
Related Topics
• Working with Page Graphics Common Tasks, page 801

Specifications
Set Precise Position and Length of a Line

3. In the Page Editor working area, double-click a line to open the Line dialog box.
4. Under Line end coordinates, enter type the appropriate values or use the
spinners.
Tip
• You enter the X and Y values using PowerBuilder units.
5. Click OK.
Related Topics
• Change Line Properties, page 804
• Modify Line Position and Length Using Arrow Keys, page 803
• Modify Line Position and Length Using the Mouse, page 804
Modify Line Position and Length Using Arrow Keys

2. In the Page Editor working area, click the line that you want to modify.
Tip
• The software displays small white dots at the ends of the line that you
select.
3. Using the keyboard arrows, move the line until you place it correctly.
4. Size the line as follows:
• To make the line shorter, press Shift + Left Arrow.
• To make the line longer, press Shift + Right Arrow.
• To change the line position from horizontal to diagonal or vertical,
press Shift + Up Arrow until you position the line correctly.
Related Topics
• Modify Line Position and Length Using the Mouse, page 804
• Set Precise Position and Length of a Line, page 803

Specifications
Modify Line Position and Length Using the Mouse

•On the Page Editor toolbar, click .
3. In the Page Editor working area, select a line.
Tip
The software displays small white dots at the ends of the line that you
•
selected.
• To move the line, place the cursor over a line end so that the cursor
changes to cross-hairs, and then drag this end to a new location. The
other end of the line remains anchored.
• To move the line from one location to another, without changing
orientation or length, drag the line from the middle.
Related Topics
• Modify Line Position and Length Using Arrow Keys, page 803
Change Line Properties

•

4. In the Page Editor working area, click the line whose properties you want to
change.
Tip
The software displays small white dots at the ends of the line that you
•
selected.
5. Double-click the selected line to open the Line dialog box.
6. Under Line ID, accept or modify the line ID as you require.

Specifications
Tip
• You need to define the line ID if you intend to save the current page in
.psr format and then customize it in InfoMaker. The line ID must be
unique.
7. Under Line color, select the color that you need.
8. Under Line style, select the option that you need.
9. Under Line thickness, type the new value or use the spinners to set a value using
PowerBuilder units from one to five.
10. Click OK to update the line properties on the page.
Related Topics
Duplicate Page Lines

4. In the Page Editor working area, click the line that you want to duplicate.
Tip
• The software displays small white dots at the ends of the line that you
selected.
Tip
• The software displays the duplicated field a bit lower and towards the
right of the original line.
6. Select the duplicate line, and drag it to the location that you need.
Related Topics

Specifications
Add Graphics to a Page

•

4. In the Page Editor working area, do one of the following:
• Click a free area of the page.
•Click a specific location on the page where you want to insert the
graphic.
5. On the Picture dialog box that opens, under Picture ID, accept the default value
or type a different unique picture ID number.
6. Under File name, do one of the following:
• Type the path and name of the .bmp file that you want to use for the
picture.
• Click and navigate to the .bmp file that you want to insert.
Tip
•You can only insert graphic files with the .bmp extension.
7. Click OK.
8. To move the graphic within the page, click on the graphic and do one of the
following:
• Use the arrow keys.
Drag the graphic using the cursor.
•
9. To resize the selected graphic, do the following:

a. Move the cursor to the edge or to the corner that you want to resize, until a
two-headed arrow appears.
b. Drag the corner or the edge of the graphic to its new location.
10. To delete the selected graphic, on the Edit Fields and Headers toolbar, click .
11. When you are satisfied with the appearance of the graphic, on the Actions menu,
click Edit Fields and Headers to close this toolbar.
12. On the Actions menu, click the Save option that you require.

Specifications
Tip
• You can save the page under the current or different name, or as an
external file. For more details, see Save a Page to the Database, page
794, and Save a Page as an External File, page 795.
Related Topics
Set Precise Position and Size of Page Objects

3. In the Page Editor working area, click the object whose X and Y coordinates you
want to set.
6. In the Field or Header Position pop-up window, enter the X and Y values as you
require.
Tip
• The X and Y values are PowerBuilder unit coordinates of the upper
left corner of the object.
7. In the Width and Height boxes, enter the appropriate values.
Related Topics
• Modify Position and Size of Page Objects Using Arrow Keys, page 808
• Modify Position and Size of Page Objects Using the Mouse, page 808

Specifications
Modify Position and Size of Page Objects Using the Mouse

3. In the Page Editor working area, click the object whose X and Y coordinates you
want to set.
4. To move the object, place the cursor in the center of the object so that the cursor
changes to cross-hairs, and then drag the object to its new location.
5. To resize the object, place the cursor in an object edge or corner so that the cursor
changes to a double-headed resize arrow, and then drag the edge or corner to its
new location.
Related Topics
• Modify Position and Size of Page Objects Using Arrow Keys, page 808
• Set Precise Position and Size of Page Objects, page 807
Modify Position and Size of Page Objects Using Arrow Keys

2. In the Page Editor working area, click the object that you want to modify.
3. Using the keyboard arrows, move the page object until the upper left corner is
correctly placed.
4. Size the object as follows:
• To make the object narrower, press Shift + Left Arrow.
• To make the object wider, press Shift + Right Arrow.
• To make the object shorter, press Shift + Up Arrow.
• To make the object taller, press Shirt + Down Arrow.
Related Topics
• Modify Position and Size of Page Objects Using the Mouse, page 808
• Set Precise Position and Size of Page Objects, page 807

Specifications
Customizing Pages Common Tasks

These tasks deal with customizing the display of the data fields and their headers
using SmartPlant Instrumentation or InfoMaker. Note that on a spec, you cannot
select more than one field or header at a time for customization.
Edit Field Headers

Use this procedure to modify the text that appears in the field headers. You can
change the text itself, change the font characteristics: bold or not bold, italic, rotated
(determine angle), text box size, text alignment, text color, and background color.
For more information, see Edit Field Headers, page 812.
Display Invisible Fields

This procedure enables you to display fields whose table column status in the
database is set as status invisible. You can then modify these table columns using a
PowerSoft editor, such as InfoMaker. For more information, see Display Invisible
Fields, page 813.
Define Fields with Computed Values

This procedure allows you to define and modify an InfoMaker eligible expression for
a data field in the current form. Such an expression is referred to as a computed
value. The field containing such an expression is referred to as a computed field. For
more information, see Define Fields with Computed Values, page 813.
Display Revision Changes for Spec Properties

When you create a new revision for a specification sheet, you can show the revision
number next to properties for which the values were changed at the last revision. To
do this, you add a computed field for the property for which you want to indicate the
change. For more information, see Display Revision Changes for Spec Properties,
page 814.
Format Field Values

Use this procedure to format values of data fields. The format that you set for the
data field names is used by SmartPlant Instrumentation to display the field values in
the specs based on a form containing this page. To differentiate among various data
fields, you set left, center or right alignment, set font style and size, and set
combinations of text and background colors. For more information, see Format Field
Values, page 815.

Specifications
Add Data Fields to a Page

Use this procedure to add data fields to a specification page that you open in the Page
Editor. The fields that you can add belong to one of the following types:
• Standard (non-custom) fields appropriate to the process function of the

open page (displayed by default in the Table Column List pop-up
window)
• Process data custom fields (displayed in the Table Column List pop-
up window after you regenerate the page)
• Specification custom fields (some displayed by default in the Table
Column List pop-up window, with option to select additional fields
from the Regenerate Page dialog box)
• Standard fields available for all process functions (displayed on the
Regenerate Page dialog box, with option to select additional fields for
display in the Table Column List pop-up window)
For more information, see Add Data Fields to a Page, page 816.
Associate User-Defined Views

This option enables you to associate a SmartPlant Instrumentation database view that
you created in an external application such as InfoMaker. After associating an
appropriate database view, you can use the data it contains in specifications. When
creating a user-defined database view, you can include in this view any combination
of SmartPlant Instrumentation table columns, with each column belonging to a
different SmartPlant Instrumentation table. Using database views, you can retrieve
data from the required tables and display this data in specification documents. For
example, a certain instrument is assembled on a line. You use your database view to
automatically retrieve data related to that line, for example, line process data, pipe
related material, and so forth. For more information, see Associate User-Defined
Views, page 817.
Duplicate Data Fields in a Page

This procedure enables you to duplicate a data field in a spec page. This way you
need enter data only once for several identical fields in a page. For more information,
see Duplicate Data Fields in a Page, page 818.
Delete Data Fields

Use this procedure to delete an existing data field from a particular page. You can
delete one data field at a time. Data fields that you delete reappear in the Table
Column List pop-up window. For more information, see Delete Data Fields, page
818.

Specifications
Add Custom Fields of Wiring Equipment Items

This procedure allows you to add custom fields of wiring equipment items in a spec
page. Custom fields of wiring equipment items appear in the table APPARATUS.
You can use up to 30 fields in a specification. The custom fields in the
APPARATUS table are designated by column names from APPAR_UDF_C01 to
APPAR_UDF_C30. The custom fields that you add in a specification page hold
view-only values in an item specification that you create using this page as a source.
Each custom field holds a user-defined property value of a customized wiring
equipment category. For more information, see Add Custom Fields of Wiring
Equipment Items, page 819.
Add Function Block Custom Fields to a Fieldbus Spec

Use this procedure to add function blocks in spec pages of the forms that you can use
as a basis for fieldbus spec generation. Three specification forms are available for
fieldbus data: form 72 for instrument with the General process function, 73 for flow
instruments, and 74 for pressure instruments. These forms contain a fieldbus page
that includes data for shipped function blocks. In addition to these function blocks,
you can create your own function blocks and add data for them to the form page.
Before adding custom function blocks in the specification page, you have to define
them in the Instrument Index module. The order in which you define them
determines the sequence number that they are mapped to when dragging the table
columns onto the specification page. The shipped function blocks correspond to
sequence numbers 1 to 21. Sequence numbers 22 to 40 are available for custom
function block parameters. For more information, see Add Function Block Custom
Fields to a Fieldbus Spec, page 819.
Related Topics
• Guidelines for Customizing Pages for Save as Excel, page 912

Specifications
Edit Field Headers

3. In the Page Editor working area, double-click a field header to open the Edit
Text dialog box.
4. On the Edit Text dialog box, do the following:
a. In the Name box, edit the field header text.
b. Select the text alignment option within the field text box.
c. Select Transparent if you want to display the current Windows background
color in the text box, or clear Transparent and then select the background
color that you need.
d. From the Text color list, select the text color that you need.
e. Under Font style, select Bold or Italic.
f. From the Rotate list, select an angle to rotate the text inside the text box.
Tip
•If you want to display an ampersand character & in the field header
text, in the Name box, enter &&. For example, to display the P&ID
header on the spec page, in the Name box, type P&&ID.
5. Click OK.
Related Topics

Specifications
Display Invisible Fields

3. On the Edit Fields and Headers toolbar, click to display the invisible data
fields of the current page.
Tip
• If several data fields are positioned at the same spot (one on top of the
other), you can only see the top data field. You can display the data
fields underneath the top field simply by moving the fields aside.
Related Topics
Define Fields with Computed Values

You can enter any of the following data types, provided that they comply with the
conventions used in InfoMaker:
Data Type Example

Number 2210
String of characters 'AA' or "AA"
Field name cmpnt_name
Function upper(cmpnt_name)
Conditional if expression (pd_fluid_phase='S','Steam','Water')
1. Open a page in the Page Editor.

3. With the Edit Fields and Headers toolbar displayed, do one of the following to
open the Computed Field dialog box:
• On the Edit Fields and Headers toolbar, click and then click a
field in the Page Editor.

Specifications
•In the Page Editor, select and double-click a field to open the
Computed Field dialog box showing the current computed value of
that field.
4. In the Name box, do one of the following:
• Type a new name to add a field with this name to the current page
•Type a field name which already exists in the current page or leave the
current value if you selected this field in the current page.
5. In the Expression box, type a value, function, or any other appropriate
expression.
6. Click Verify to verify that the expression you entered is a valid InfoMaker
expression.
7. Click OK.
Notes
• If you make changes to a field in the currently opened page, the
software displays the computed results automatically, using the
settings you entered on the Computed Field.
• See your InfoMaker User Guide for additional information about the
data types you can use as valid expressions for this procedure.
Related Topics
Display Revision Changes for Spec Properties

1. Open a page in the Page Editor.
3. On the Edit Fields and Headers toolbar, click and then click the page at the
position where you want to place the computed field.
4. On the Computed Field dialog box, type a name for the computed field.
5. In the Expression box, type the following expression:
f_changevalue(cmpnt_id,rev_id,dwg_id,"<field name>")
Tip
•For example, to show changes for the maximum pressure, the
expression is written as follows:
f_changevalue(cmpnt_id,rev_id,dwg_id,"pd_press_max")
6. Click Verify to verify that the expression you entered is a valid InfoMaker
expression.

Specifications
7. Click OK.
8. To show the change in the specification, do the following:
a. Modify an existing value of a property for which you added a computed field
to display changes for the last revision.
b. Close the specification sheet and re-open it the following day.
c. Add a revision to the specification sheet and refresh the display.
Tips
• The indication appears only after the day advances on your computer's
clock.
• The indication appears only for existing values that were changed at
the last revision. If you enter a new value for a property that
previously did not have a value, no change is indicated.
Related Topics
Format Field Values

3. On the Edit Fields and Headers toolbar, click to display the data field names
in the page.
4. In the page, double-click a field name to open the Edit Field dialog box.
5. Under Alignment, accept the default alignment (left), or select the appropriate
alignment option.
6. Under Font style, select the font style (the available styles are bold and italic).
7. Under Font size, enter a font size between 3 and 24.
8. Select Transparent if you want to display the current Windows background color
in the text box, or clear Transparent and then select the background color that
you need.
9. Click OK.
Related Topics

Specifications
Add Data Fields to a Page

2. On the menu bar, click Actions > Regenerate Page.
3. On the Regenerate Page dialog box, under Select tables and views, select a
check box for each table or view from which you want to display additional table
columns in the Table Column List pop-up window, from which you can add data
fields to your page.
Tip
If you want to add a user-defined view to a spec page, you must first
•
add this view in the Specification Views dialog box. For details, see
Associate User-Defined Views, page 817.
4. Under Show columns, click Show for each required table or view.
5. Under Select columns, select all or specific table columns that you want to
display in the Table Column List pop-up window.
6. Click OK to return to the Page Editor.
7. On the menu bar, click Actions > Edit Fields and Headers.
8. On the Edit Fields and Headers toolbar, click to open the Table Column
List pop-up window.
9. From the Table Column List pop-up window, drag table columns to the
appropriate location on the page.
• To save the page under the current name, on the menu bar, click
Actions > Save.
• To save the page under a different name, on the menu bar, click
Actions > Save as Page.
Related Topics

Specifications
Associate User-Defined Views

Important
• Before using this procedure, make backups of all your user-defined
views. When upgrading your SmartPlant Instrumentation version,
note that in the new version, some tables or columns might have been
modified. If you have upgraded your database after associating user-
defined views, you cannot use the views in which the table records do
not match the new table records of the new database. To enable the
use of these views, you must run a set of SQL commands to recreate
the user-defined views.
1. On the Specifications Module window menu bar, click Actions > Specification
Views.
2. On the Specification Views dialog box, click New.
3. In the new row, type the appropriate view name.
Tip
• The name of the new view must be exactly the same as the name
defined in your external application (the name is not case-sensitive).
The software validates the name and checks whether the view
complies with the SmartPlant Instrumentation-specific conditions.
4. Under Item Type, from the list, select the item type you want to associate with
the current view.
Tip
• For a user-defined view, you can select an item type from a list. For
the default views, the item type is fixed. The displayed item type
indicates that you can only use the current view in a specific item
specification. For example, you can only use the default view
cable_type_view in a cable specification.
5. Click OK.
Note
• When associating a user-defined view with SmartPlant
Instrumentation, the system recognizes the view under the following
conditions:
• The view must contain the CMPNT_ID column.
• The CMPNT_ID value must be unique.
• The number of rows in the created view must match the number of
rows in the COMPONENT table of SmartPlant Instrumentation. The

Specifications
COMPONENT table contains the appropriate instrument tags that

must appear in the view.
Related Topics
Duplicate Data Fields in a Page

3. On the Edit Headers and Fields toolbar, click to display the data field names
in the page.
4. In the Page Editor working area, click the data field that you want to duplicate.
Tip
The software displays the duplicated data field as superimposed on the
•
original field and skewed downwards to the right.
6. Drag the new field to the location that you need.
Related Topics
Delete Data Fields

3. With the Edit Fields and Headers toolbar displayed, in the page, click the data
field that you want to delete.
5. Repeat this procedure top delete another data field.
Related Topics

Specifications
Add Custom Fields of Wiring Equipment Items

1. Create a wiring equipment item in the Reference Explorer.
2. In the Specifications module, restore a form associated with the Wiring
Equipment item type.
3. In the Page Editor, open a spec page based on the form that you restored.
4. Regenerate the page, and from the APPARATUS table, add the appropriate
APPAR_UDF columns as data fields in the page.
5. In the page, name the column headers to match the headers that you defined for
wiring equipment properties in the Wiring module.
Tips
• To display a list of headers, you need to open an external .psr file
WIRING_EQUIPMENT_UDF.PSR, which is located in the path
<SmartPlant Instrumentation home folder> \PSR. You can open the
file WIRING_EQUIPMENT_UDF.PSR using InfoMaker, or from the
Browser module.
• After adding custom fields in a spec page, you have to change the
column headers in the page so that they match the user-defined
property names in the Wiring Equipment Category Properties
dialog box, which you access for the Wiring module (with the Wiring
module main window open, click Tables > Wiring Equipment >
Categories).
Related Topics
• Regenerate Pages, page 794
Add Function Block Custom Fields to a Fieldbus Spec

1. In the Instrument Index module, create a new function block.
2. In the Specifications module, open the Page Editor.
3. On the Page Editor toolbar, click .
4. On the Select Specification Page dialog box, select Fieldbus Page.
6. On the Edit Fields and Headers floating toolbar, click to view the names of
the data field on the specification page.
7. On the Edit Fields and Headers floating toolbar, click .

Specifications
8. In the Table Column List pop-up window, select a table column starting with the
string fb and containing a value between 22 and 40, for example, fb22_exists.
For each custom function block, the following column types are available:
• fb<number>_name — Displays the text string used for the function
block label as defined in the Function Blocks supporting table.
• fb<number>_count — Allows you to specify the number of function
blocks of the particular type that are used in the instrument if the
Multiple check box is selected in the Function Blocks dialog box.
• fb<number>_ex_time — Allows you to specify the execution time
for the function block type if the Execution time check box is selected
in the Function Blocks dialog box.
• fb<number>_exists — Displays a text box that you can select to
indicate that the function block is required for the instrument.
Tip
The <number> value corresponds to the order in which you add
•
custom function blocks in the Function Blocks supporting table, and
not their alphabetic sequence.
9. Drag the table column value that you selected from the Table Column List pop-
up window to the desired location on the currently open page.
10. Drag other custom function block values onto the page as desired.
Related Topics

Specifications
Spec Forms: An Overview

Forms serve the basis for creating specifications. Forms can consist of one or more
data pages and always contain a note page. A form must contain at least one data
page. You might design a form based on more than one page, for example, for a field
device that has both electrical and mechanical connections, requiring separate pages
for wiring connections and line-related fields. SmartPlant Instrumentation is
delivered with a library of predefined forms bearing the names of their default pages.
You can manage spec forms in the Specifications module, using the Form Editor
options. You can you change form properties, such as name, description, and
number, save a form either as a new form or as a spec page to fit your own
conventions.
After defining the form pages, you can create specs on the basis of this form. If you
want to generate a multi-tag spec containing a page where you can display values of
individual instruments, you must first need to create a multi-tag spec format on the
basis on a particular form. You can create other types of specs by assigning a
SmartPlant Instrumentation item directly to the number of the appropriate spec form.
When you assign a form to an item and generate a spec, the software creates the spec
pages according to the pages that the source form contains. You cannot modify the
data fields in the form itself, only in the form pages, which you can open in the Page
Editor.
It is possible to create multiple templates for a specific form and then, when
generating a spec, assign the item to the form data template rather than to the form.
You can then copy data from any other template based on the same form to the
current spec, and even copy data from the spec to any of these templates.
Related Topics
• Form Data Template Common Tasks, page 833

Specifications
Spec Forms Common Tasks

You use the following tasks to manage you spec forms, restore library forms, add or
remove spec pages, and so forth.
Create a Form
Use this procedure to create a form comprising one spec page. You can only create
and manage spec forms in the Specifications module. For more information, see
Create a Form, page 824.
Edit Form Properties

Use this procedure to edit number, name and note defined for a spec form. After you
edit the form properties, the software automatically updates these properties in all the
specifications that are assigned to this form. For more information, see Edit Form
Properties, page 825.
Add Pages to an Existing Form

Use the following procedure to add pages to existing forms and create a multi-page
form that you can associate with an item. By adding pages to a form, you can achieve
greater flexibility and accuracy in specifications based on that form. For more
information, see Add Pages to an Existing Form, page 826.
Remove a Page from a Form

You can remove a page from an existing multi-page form. This procedure only
applies to the current form and does not remove the page from the list of pages
available as templates for other forms. If you need to permanently delete a particular
page, you can do so in the Page Editor. For more information, see Remove a Page
from a Form, page 827.
Sort Pages Within Forms

Use this procedure to open a specific form and sort the pages included in the form.
This way you set the print preview and print order of the pages in a spec that you
generate on the basis of this form. For more information, see Sort Pages Within
Forms, page 828.
Define Form Browser Fields

Use this procedure to define fields for a form browser you can add in the Browser
module based on the current form. The fields that you select in the Spec Data
Dictionary become available for inclusion in the browser view (in the Style settings
section of the Browser Manager). You can edit the field names only in the Spec
Data Dictionary. This procedure does not affect the on-screen display of
specifications based on a form that you edit in the Spec Data Dictionary, nor does it
influence printed specifications. For more information, see Define Form Browser
Fields, page 828.

Specifications
Display a List of Pages Included in a Form

Use this procedure to open a form and display a list of spec pages that this form
includes. You might need to display a list of pages of you want to modify fields in a
specific form page (you cannot modify fields on the form itself). For more
information, see Display a List of Pages Included in a Form, page 829.
Delete a Form
This procedure enables you to delete a form that is not in use in any spec. You can
either delete the form together with all of the pages included in the form, or just the
form itself, and then delete the pages manually, from the Page Editor. If the form
that you are about to delete is a library form, you can restore this form at any stage,
together with the library pages. However, you cannot restore custom pages included
in the form. For more information, see Delete a Form, page 829.
Restore Library Forms

Use this procedure if you need to perform any of the following activities:
Activate a library form that is not available in the Select Specification Form
dialog box. After you restore a form, this form becomes available in the Select
Specification Form dialog box, and you can associate this form with items that
belong to a specific item type. You must restore all forms whose item type is not
Instrument if you want to create specifications using these forms. For example, to
create hook-up specifications, you must restore a form assigned to the Hook-Up
item type.
• Restore a library form after deleting it. You can only restore library
forms provided with SmartPlant Instrumentation. You can only
restore a library form that was saved as an .isf file.
For more information, see Restore Library Forms, page 830.
Regenerate Library Forms

You might need to use this procedure after you r System Administrator has initialized
a new domain from a source, or after upgrading your SmartPlant Instrumentation
database. Some form data may not be copied correctly to the target domain. For this
reason, it is recommended that you regenerate the library forms to avoid any
problems at a later stage. If you are using the workflow options in the Instrument
Specifications Browser, regeneration is essential after initialization or upgrade. For
more information, see Regenerate Library Forms, page 830.
Change Form Assignment for a Batch of Specs

Use this procedure to change the form assignment for a group of specs that share a
common form. The new form must have the same process function as the currently
assigned form, or belong to the General process function. For more information, see
Change Form Assignment for a Batch of Specs, page 831.

Specifications
Change the Form Assignment of a Spec

Use this procedure to change the form assignment for a particular spec. The new
form must have the same process function as the currently assigned form. When the
spec item type is Instrument, you can also select a form whose process function is
defined as General. For more information, see Change the Form Assignment of a
Spec, page 830.
Related Topics
• Spec Forms: An Overview, page 821
Create a Form
• Click Edit > Form Editor.
2. In the Form Editor, click .
3. Select a page for the new form.
Tip
• A form must contain at least one page. You can add other pages in the
form after creating the form.
4. On the toolbar, click to save the form to the database.
Related Topics

Specifications
Edit Form Properties

Note
• Before performing this procedure, make sure that you have close all
specifications that are assigned to the form whose properties you want
to edit.
2. In the Form Editor, do one of the following:
• Click Actions > Open Form.
• Click .
3. On the Select Specification Form dialog box, select the form whose properties
you want to edit.
4. Click Properties and modify the form number, name, or note as you require.
5. Click OK and then save the form.
Related Topics

Specifications
Add Pages to an Existing Form

Note
• If you want to use large notes in a form, you need to add a large note
page to this form. Since it is possible to scroll the large note page
area, you do not need to add more than one large note page to a form.
When printing forms containing a large note page, the software divides
the page into separate sheets automatically, depending on the note text
length.
•A form that contains a composite page cannot contain any other pages
because you can only include one composite page in a form.
1. In the Form Editor, do one of the following:
• On the menu bar, click Actions > Open Form.
2. On the Select Specification Form dialog box, select the form to which you want
to add pages, and click OK.
3. In the Form Editor, do one of the following to add a page:
• On the menu bar, click Actions > New Page.
4. On the Select Specification Page dialog box, select the page that you want to
include in the form.
Tips
• To edit the page name and description, click Properties and type the
required modifications.
•The process function of the form is determined by the pages in the
form. If the process function of all the pages within a form is General,
the form process function is also General. If an added page has a
different process function, the form process function changes to the
new page process function. In this case, adding a new page is
available only for pages with General or the same process function as
the form.
5. Click OK.
6. Sort the pages within the form as you require.

Specifications

• To save the changes that you made, on the menu bar, click Actions >
Save.
• To save the form under a new name, on the menu bar, click Actions >
Save as Form.
Notes
• If you are building a form incorporating pages with identical custom
field names, (for example, Page 1 and Page 2) the following scenario
can occur:
On Page 1, the spec_udf_c13 field value is A, whereas, on Page 2, the
value is B. When adding Page 2 to the form, the software changes the
spec_udf_c13 value to B on Page 1, according to the value on Page 2.
• In a multi-page form, you should use a given specification custom
field name on more than one page only for a field that you design for
constancy across all of the form pages.
Related Topics
• Create a Large Note Page, page 796
• Sort Pages Within Forms, page 828
Remove a Page from a Form

1. In the Form Editor, open a form that has more than one page.
2. Click a tab of a specific page.
• On the menu bar, click Actions > Remove Page.
• To save the form under the existing name, click Actions > Save.
• To save the form under a new name, click Actions > Save as Form.
Related Topics

Specifications
Sort Pages Within Forms

1. In the Form Editor, open a form that has more than one page.
• On the menu bar, click Actions > Sort Pages.
3. Select a page and click Move Up or Move Down to change the page order within
the form.
4. Click OK to set the new page order and update the form.
Related Topics
Define Form Browser Fields

1. On the Specifications Module window menu bar, click Edit > Spec Data
Dictionary.
2. On the Select Specification Form dialog box, select a form and click OK.
3. On the toolbar, click .
4. To edit the headers for the form browser, if you need, do one of the following:
• On the Field Properties tab, change individual field headers by typing
a text string instead of the displayed header.
Change field headers in batch mode using another form as a source.
•
To do so, click Copy From, and then, select a source form..
5. To apply existing headers of the current form, do the following:
a. In the form or on the Field Properties tab, under Header, move the cursor to
the field header.
b. After the cursor changes its shape to , click the header.

c. In the form, double-click the header to display it on the Field Properties tab.
Tips
• When you apply existing headers of the current form, in the form
display, the form fields are marked with the cyan background color.
The background color of the currently selected field, for which you are
editing the header, changes to magenta.
• The icon on the Field Properties tab points to the corresponding
field header, which is now available for editing.

Specifications
6. To define the fields for the form browser, do one of the following:
• To make all of the fields from one or more tables available for the
form browser, click the Tables tab, and then, under Browser Fields,
click All for the tables that you require.
• To define individual fields, on the Field Properties tab, select the
appropriate check boxes in the Browser column.
7. On the toolbar, click to save the form browser field definitions.
Related Topics
Display a List of Pages Included in a Form

2. On the Form Editor menu bar, do one of the following:
• Click Actions > Page List to view the page list.
• Click Reports > Spec Pages per Form to generate an d print a report
of the form pages.
Related Topics
Delete a Form
1. On the Form Editor menu bar, click Actions > Delete Form.
Tips
• You can only delete a form that is not in use in any specs.
• You can delete one form at a time.
• If the form has pages, and it is not in use in any spec, you are
prompted to delete all of the form pages as well. If the form that you
are about to delete is a library form, you can restore this form at any
stage, together with the library pages. However, you cannot restore
custom pages included in the form. Therefore, before deleting the
form, we recommend that you save the appropriate pages as external
files. You can save pages as files in the Page Editor.
2. On the Select Specification Form dialog box, select the form you want to delete
and click OK.

Specifications
Restore Library Forms

•
2. On the Form Editor menu bar, click Actions > Restore Form.
3. Select the form you want to restore and click OK.
Tip
• If the form with the same name you are restoring already exists, the
software displays the Restore Options dialog box, where you can
overwrite the existing form or recreate the library form as a new form.
Related Topics
• Regenerate Library Forms, page 830
Regenerate Library Forms

1. In the Specifications Module window, click Actions > Regenerate Library
Forms.
2. On the Regenerate Library Forms dialog box, click Run.
3. On completion of the process, click Close.
Related Topics
Change the Form Assignment of a Spec

1. In the Specifications module open a specification.
2. On the menu bar, click Actions > Change Spec Form.
3. Select the new form for your specification and click OK.
4. When prompted to change the form assignment and close the current spec, click
Yes, and then reopen the spec, which is now assigned to the new form.
Tips
• SmartPlant Instrumentation does not allow you to change the form
assignment of a spec assigned to a Specification Binder package,

Specifications
unless you first remove the specification from the Specification Binder
package.
assignment of a multi-tag spec.
Related Topics
Change Form Assignment for a Batch of Specs

1. In the Specifications Module window, on the menu bar, click Actions > Change
Spec Form.
2. Under Search parameters, from the Current form list, select the form type of
the specifications that you want to change.
3. Click Find.
Tip
• Select Find typical tags only to limit your search to specifications of
typical tags.
• Select Find telecom tags only to limit your search to specifications of
telecom tags.
4. Under Search results, select the specifications for which you want to change the
form.
5. Under Change parameters, from the New form box, select the new form type,
and click Apply.
Tips
• In the New form box, the software displays forms of the same process
function as the current form. When the spec item type is Instrument,
the software also displays forms whose process function is defined as
General.
• Specifications for which forms were successfully changed no longer
appear among the search results.
• The software does not allow you to change the form assignment of an
instrument specification assigned to a Specification Binder package,
unless you first remove the specification from the Specification Binder
package.
assignment of multi-tag specs.
6. Repeat the procedure for other specification forms if required, or click Close to
return to the Specifications Module window.

Specifications
Form Data Templates: An Overview

Form data template allows you to store data that you can copy to existing specs.
Using a form data template eliminates the need to repeat data entry for similar specs.
Also, you can set the software to copy data from a template when generating a new
instrument spec. This is possible after you assign an existing form data template to
the profile of a specific instrument type. You manage form data templates only in the
Specifications module, in the Form Data Template Editor.
You base form data templates on a specific spec form. You can create multiple
templates for each form. The form data template name does not have to be unique
and can contain up to 50 alpha-numeric characters. After generating a spec based on
the form for which you defined data templates, you can select a template and copy its
data to the spec. Also, you can copy data to a form data template from a spec based
on the same form.
Related Topics
• Copy Data to a Form Data Template from a Spec, page 887
• Copy Data to a Spec from a Form Data Template, page 889

Specifications
Form Data Template Common Tasks

You use the following tasks to manage you form data templates .
Create and Modify a Form Data Template

Use this procedure to create and modify form data templates, from which you can
copy a batch of data to your new or existing specifications. For more information,
see Create and Modify a Form Data Template, page 833.
Delete a Form Data Template

Use this procedure to delete form data templates if they are no longer required as a
data source for specs. For more information, see Delete a Form Data Template, page
834.
Related Topics
• Copy Data to a Form Data Template from a Spec, page 887
• Copy Data to a Spec from a Form Data Template, page 889
• Form Data Templates: An Overview, page 832
Create and Modify a Form Data Template

1. With the Specifications Module window open, click Edit > Form Data
Template Editor.
2. On the Select Specification Form dialog box, select the form for which you want
to create or modify a form data template, and then click OK.
3. On the Select Form Data Template dialog box, do one of the following:
• If this is the first form data template for a given form, type a name.
• To add an additional form data template, click New and type a name.
• To modify an existing form data template, select the template from the
list.
4. Click OK to open the form data template.
5. Do one of the following to enter data in the form template:
• Enter data manually in the fields that are available for editing.
• Copy data from a spec based on the same form as your form data
template. For details, see Copy Data to a Form Data Template from a
Spec, page 887.
Tip
• If the form data template has fields that are not accessible, these fields
are protected in the Spec Data Dictionary. You cannot enter values

Specifications
in protected fields. When copying data, the software ignores protected

fields. For details, see Protect Fields from Overwriting When Copying
Data, page 887.
6. On the toolbar, click to save the changes.
Related Topics
Delete a Form Data Template

1. In the Specifications module, click Actions > Delete Form Data Template.
2. In the Select Specification Form dialog box, select the form for which you want
to delete a form data template and click OK.
Tip
•The Select Specification Form dialog box only displays format that
for which you have defined data templates.
3. In the Select Form Data Template dialog box, select one or more data templates
that you want to delete, and click OK.
4. Click Yes when prompted to confirm the deletion.
Tip
• Deleting a form a data template does not affect the source spec form or
specs to which you copied data from the template.
• Deletion of a form data template is irreversible.
Related Topics

Specifications
Single-Tag Specs: An Overview

A single-tag spec is a specification you can generate for a single instrument. A
single-tag can only contain data defined for one specific instrument. If you want to
use this tag in a multi-tag spec, you need to delete the single-tag spec first. A single
tag spec consists of a note page, and one or more data pages, depending on the form
on which you base the spec.
In the specification, you can edit some of the fields by clicking inside the field and
typing the required data. Other fields, such as Tag Number or Process Conditions
receive their data from the Instrument Index, Process Data or Calculation modules
and thus do not allow a direct editing. However, you can edit the process data and
calculation fields if you have been granted the appropriate access rights to do so. The
unit of measure fields allow you to select values from a predefined list of units. All
tag number property changes that are made not in the spec itself automatically take
effect in the spec generated for this tag.
It is possible to export single-tag specs to External Editor, where other users can edit
the appropriate data settings, and then import the edited data back to SmartPlant
Instrumentation.
Note
• If a single-tag spec has fieldbus columns, you can set preferences to
allow you to edit the fieldbus column values in the spec. However,
you can only make the fieldbus columns editable if the instrument type
of the spec tag number is Fieldbus.
Related Topics

Specifications
Single-Tag Specs Common Tasks

Use the following tasks to generate and manage single-tag specs.
Generate a Single-Tag Spec

This procedure describes how to generate a single-tag spec for an existing instrument
using the Specifications module options. For more information, see Generate a
Single-Tag Spec, page 837.
Generate a Spec for a Complex Analyzer

Use this procedure to generate a specification for a complex analyzer. For more
information, see Generate a Spec for a Complex Analyzer, page 841.
Notes for Editing a Single-Tag Spec

This topic provided information on the editing options you can use if you need to
update or define data in the columns of a given single-tag spec. For more
information, see Notes for Editing a Single-Tag Spec, page 838.
Edit Manufacturers and Models in a Spec

Use this procedure to edit the instrument manufacturer and model in a spec. With a
spec open, you can display the instrument manufacturer supporting table and define
the manufacturers and models as you require. For more information, see Edit
Manufacturers and Models in a Spec, page 839.
Related Topics

Specifications
Generate a Single-Tag Spec

1. In the Specifications Module window, click Actions > Open Specification
2. From the Item type list, select Instrument.
3. From the Tag class list, select a tag class.
4. In the Item number box, enter the exact instrument tag number.
Tips
• If you do not remember the instrument tag number, leave the Item
number box empty and click Find.
• If you are creating a specification for a specific process data case of an
instrument, the value in the Form number box might be view-only. If
the value is view only, you have already created previously a
specification for a different case of the same instrument. After
creating a spec for a process data case, the software assigns the same
spec form to all other cases of the same instrument.
• If the instrument process function is General, the available forms are
only those whose process function is also General. However, if the
instrument process function is not General, both General forms and
forms that have the same process function as the tag has are available
for association with the instrument.
5. In the Form number box, enter the spec form number.
Tip
• If you do not remember the form number, leave the Form number
box empty and click Find.
6. In the Open Specification box, click OK.
Tip
• If you receive a message that the specified instrument tag does not
exist, you can create a new instrument tag on the fly, provided that you
set preferences accordingly. To be able to create instrument tags in the
Specifications module, on the Preferences dialog box, on the
Specifications > General page, under Tag creation, select Allowed.
7. In the New Specification dialog box, do one of the following:
a. Select Create single-item specification.
b. In the Document number box, accept the default document number or
modify it as you require.

Specifications
Tip
•You do not have to define the document number at this stage. If you
leave the Document number box empty, you can define the document
number in the spec title block of the spec, after you open the spec.
8. Click OK to generate and open the specification.
Related Topics
• Generate Instrument Specs in Batch Mode, page 784
Notes for Editing a Single-Tag Spec

Field Values
Some field values can be edited by clicking inside the field and typing the required
data. Some of the fields require that you select a value from a list. Other fields, such
as Tag Number or Process Conditions receive their data from the Instrument Index,
Process Data, or Calculation modules and thus do not allow a direct editing. You can
only edit process data and calculation values if you the appropriate access rights to do
so.
Units of Measure
The Units of Measure (UOM) fields allow you to select a unit from a predefined list
of units. After selecting a pressure unit, you are prompted to choose the pressure
reading method. When you select volumetric flow units, you are prompted to select
the measurement conditions (at flow or at base).
Spec Sheet Number

At the foot of the specification, you can enter the sheet number and total number of
sheets manually. You can leave these fields blank to complete them automatically
when you print the sheets.
Document Binder Status

When you edit and save an instrument specification that is part of a Specification
Binder package in the Document Binder module, you are prompted to define its
Document Binder status.
Related Topics

Specifications
Edit Manufacturers and Models in a Spec

1. Open a spec.
• Click Actions > Instrument Models.
3. To add or change a manufacturer, in the Instrument Manufacturers dialog box,
under Manufacturer, select a manufacturer from the list or click to add a new
manufacturer.
4. To change the instrument model, in the data window of the dialog box, select the
new model.
5. To add a new model for the current manufacturer, do the following:
a. In the Instrument Manufacturers dialog box, click New to add a new data
row.
b. Type the instrument model values in the appropriate boxes, and also select the
process function.
c. Click OK.
Note
• The software automatically copies the defined instrument
manufacturer and model to the appropriate fields in the current spec.
6. Save the specification.
Related Topics

Specifications
Move a Single-Tag Spec to a Multi-Tag Spec

Important
When moving a single-tag spec to a multi-tag spec, the software only
•
copies the data that appear in the current see list. If the single-tag spec
contains data that appears on the main pages of the current multi-tag
spec (not in the see list), the software ignores these values, and
automatically deletes the single-tag spec and its document number.
1. Open a multi-tag spec.
2. Click the Multi-Tag List tab.
3. Click Actions > Move from Single.
4. In the Add Tag dialog box, click Find.
5. In the Find Items dialog box, search for the tags whose spec form is the same as
the form in the current multi-tag spec.
6. Under Search results, select one or more tags, and then click OK.
Tips
• In the Find Items dialog box, the Process function and Form
number boxes are view-only because all the target single-tag specs
must be based on the same form as the format of the current multi-tag
spec and share the same process function.
• If you know the target spec tag number, you can type it in the Add
Tag dialog box, and click OK to add this tag in the current see list.
• All the target single-tag specs must be based on the same form as the
format of the current multi-tag spec.
Related Topics
• Move a Tag to Another See List, page 853

Specifications
Generate a Spec for a Complex Analyzer

1. Make sure that you have a specification form appropriate for an analyzer.
Tips
• The library form #77 is an example of a form designed for an analyzer.
If this form is not displayed in the Select Specification Form dialog
box, restore the supplied library forms.
• You can also generate a multi-tag spec for each stream of a complex
analyzer.
• You can also use this procedure to generate a spec for a simple
analyzer.
2. Generate a single-tag spec based on the analyzer form.
Related Topics
• Generate a Single-Tag Spec, page 837
• Generate a Spec for an Analyzer Stream, page 856

Specifications
Process Data Case Specs: An Overview

A process data case specification is a single-section specification generated for a
particular process data case of an instrument tag. You can create an individual
specification for each case of an instrument tag, including the governing case. Each
process data case spec has its own revisions. Process data case specifications do not
have to share the same document number (as for other specifications).
You create process data case specifications in the same way that you create
specifications for other items. Since all process data case specifications share the
same tag number, creation of a process data case specification involves an additional
step, that is selecting the desired tag case. After you specify a tag number for creating
a new spec, the software automatically detects whether this tag number has multiple
cases and prompts you to select one of those cases.
Since all process data case specifications for a given instrument share the same spec
form, after creating the first specification for a particular case, you need to use the
same spec form for all subsequent process data case specifications that you create for
the instrument.
Note
• It is possible to generate a composite (multi-section) specification that
displays more than one process data case of an instrument. For details,
see Composite Spec for Instrument with Cases: Generation Workflow,
page 873.
Related Topics
• Process Data Case Specifications Common Tasks, page 843

Specifications
Process Data Case Specifications Common Tasks

The following tasks deal with generating single-section specs for a particular process
data case, or generate a hybrid case spec.
Generate a Spec for Multiple Process Data Cases

Use this procedure to generate a spec for a specific process data case defined for an
instrument that contains case. For more information, see Generate a Spec for
Multiple Process Data Cases, page 844.
Generate a Hybrid Case Spec

For a control valve for which you defined multiple process data cases, you can create
a hybrid case from the minimum, normal, and maximum flow coefficient values
(Cv/Kv) that you calculated for the various cases. Use this procedure to generate a
specification for this tag based on its hybrid case. Make sure that you have a form
designed for the control valve hybrid case. For more information, see Generate a
Hybrid Case Spec, page 845.
Related Topics
• Process Data Case Specs: An Overview, page 842

Specifications
Generate a Spec for Multiple Process Data Cases

1. In the Specifications module, click Actions > Open Specification.
2. On the Open Specification dialog box, from the Item type list select
Instrument.
c. Click Find to display a list of instruments according to the search parameters
that you have selected.
d. Select the instrument tag for which you have calculated a hybrid case in the
Calculation module.
Tip
Under Search parameters, the Case list displays all the available
•
cases defined in the Process Data module.
4. On the Find Items dialog box, click OK to accept your selection and return to the
Open Specification dialog box.
b. Select the appropriate form (not form #76, which designed for the control
valve hybrid case), and then click OK.
Tip
•If the value in the Form number box is view-only, this means that
you have already created previously a specification for a different case
of the same tag. After creating a spec for a tag case, the software
assigns the same spec form to all other cases of the same tag.
6. On the Open Specification dialog box, click OK to open the New Specification
dialog box, and then proceed with spec creation.
Related Topics

Specifications
Generate a Hybrid Case Spec

2. On the Open Specification dialog box, from the Item type list select
Instrument.
c. Click Find to display a list of instruments according to the search parameters
that you have selected.
d. Select the instrument tag for which you have calculated a hybrid case in the
Calculation module.
Tip
• Under Search parameters, the Case list displays all the available
cases defined in the Process Data module. However, the software does
not indicate in the interface those instruments for which you calculated
a hybrid case.
4. On the Find Items dialog box, click OK to accept your selection and return to the
Open Specification dialog box.
b. Select the form #76, which designed for the control valve hybrid case, and
then click OK.
Tip
• The library form #76 is the library form supplied with SmartPlant
Instrumentation. This form contains columns that display minimum,
normal, and maximum flow coefficient values (Cv/Kv) you calculated
for the various cases in the Calculation module. If this form is not
displayed in the Select Specification Form dialog box, restore the
supplied library forms.
6. On the Open Specification dialog box, click OK to open the New Specification
dialog box, and then proceed with spec creation.
Related Topics

Specifications
Multi-Tag Specs: An Overview

A multi-tag specification is a specification you can generate for a group of
instruments. Multi-tag specifications are frequently required because instruments of
the same type have many identical parameters. A multi-tag specification contains a
group of instrument tags that you can add, one by one, to the same spec sheet. A
multi-tag specification is based on a specification format, which is, in turn, is based
on the form that you set for assigning with multiple tags. Such a form can comprise
one or more spec pages.
Instrument tags in a multi-tag spec must have identical process functions except for
the following case: if the spec form process function is General but the form pages do
not include any data fields from the PD_NOT_ASSIGN or PD_GENERAL tables,
such a spec can contain instruments whose process functions are not identical, for
example, such a spec can contain both Flow and Temperature instruments.
A multi-tag specification always contains one Notes page, one Multi-Tag List page,
and one or more common pages with fields that are identical for all of the tags. The
Tag Number field, and other specification fields that appear on the Multi-Tag List
page, show the words SEE LIST instead of data. The SEE LIST label indicates that
the values in the fields appear on the Multi-Tag List tab of the spec. The Multi-Tag
List page contains fields whose values can differ from tag to tag. You can change the
SEE LIST label to any other text using the appropriate option on the Preferences
dialog box.
It is possible to export multi-tag specs to External Editor, where other users can edit
the appropriate data settings, and then import the edited data back to SmartPlant
Instrumentation. Also, you can move tags to another multi-tag spec (to another see
list), or, on removing a tag, automatically generate a single-tag spec for this tag. You
cannot remove the master tag.
Notes
• You can include fieldbus instruments in a multi-tag spec. However,
the software does not support editing of fieldbus data fields in a multi-
tag spec.
• You cannot include composite pages in a multi-tag spec. For details of
composite specs, see .
Related Topics
• Formats Common Tasks, page 857
• Title Block in a Multi-Tag Spec, page 879

Specifications
Multi-Tag Specs Common Tasks

The following tasks enable you to manage multi-tag specs, search for instrument tags
in the see list, edit see list data, move instrument tags from one see list to another, or
to a single-tag spec, and so forth.
Generate a Multi-Tag Spec

Use this procedure to generate and open a multi-tag spec in the Specifications
module. To generate such a spec, you need to select a specific instrument and a form
for which you created a multi-tag spec format. After generating the spec, you can add
other instrument tags to the spec see list. For more information, see Generate a
Multi-Tag Spec, page 849.
Add a Single Instrument Tag to a Multi-Tag Spec

Use this procedure to add an instrument tag to the see list of an existing multi-tag
spec without opening the spec. For more information, see Add a Single Instrument
Tag to a Multi-Tag Spec, page 850.
Add Instrument Tags to a Multi-Tag Spec in Batch Mode

Use this procedure to add one or more instrument tags to the see list of an existing
multi-tag spec. To add instrument tags in batch mode, you must first open the target
spec. For more information, see Add Instrument Tags to a Multi-Tag Spec in Batch
Mode, page 851.
Edit See List Data in a Multi-Tag Spec

Use this procedure to edit data in the see list of a multi-tag spec. For more
information, see Edit See List Data in a Multi-Tag Spec, page 851.
Change the Master Tag Definition

In a multi-tag specification, several instrument tags have one common master page,
which is generated according to one of the instrument tags sharing this specification.
The master page is associated with a master tag which links to the information
common to all instrument tags that belong to the multi-tag specification. You can
change the master tag definition by selecting a different instrument tag to serve as the
master tag. The master tag definition also changes if you delete the current master
tag. In this case, the instrument tag that appears first in the see list becomes the
master tag. For more information, see Change the Master Tag Definition, page 852.
Search for a Specific Tag in a Multi-Tag Spec

Use this procedure to find a specific instrument tag within a multi-tag specification.
For more information, see Search for a Specific Tag in a Multi-Tag Spec, page 852.

Specifications
Move a Tag to Another See List

Use this procedure to move instrument tags from the see list page of the currently
spec to a see list in another spec. You can either create a new multi-tag spec on the
fly and move instrument tags from the currently open see list to the target see list in
another specification, or move tags to the see list of an existing multi-tag
specification. For more information, see Move a Tag to Another See List, page 853.
Move a Tag from See List to a Single-Tag Spec

Use this procedure to remove an instrument tag from a multi-tag spec and create a
single-tag spec for this instrument. For more information, see Move a Tag from See
List to a Single-Tag Spec, page 854.
Move a Single-Tag Spec to a Multi-Tag Spec

Use this procedure to move single-tag specifications into the currently open multi-tag
spec. For more information, see Move a Single-Tag Spec to a Multi-Tag Spec, page
840.
Remove a Tag from a Multi-Tag Spec

Use this procedure to remove instrument tags from a multi-tag (see list) specification.
When removing a tag, it is possible to retain in the database or delete the tag spec data
defined in the see list. For more information, see Remove a Tag from a Multi-Tag
Spec, page 855.
Generate a Spec for an Analyzer Stream

To generate a specification for an analyzer stream, you need a special type of multi-
tag specification, which functions as follows:
• You generate a multi-tag specification, with the stream tag as the more
master tag.
• You then add the instrument tags associated with this stream to the
multi-tag specification.
• Fields that relate to the stream are displayed on the common page or
pages (not in the see list).
• The fields that vary — the tag names and tag-specific values — are
displayed in the in the see list on the Multi-Tag List tab.
For more information, see Generate a Spec for an Analyzer Stream, page 856.
Related Topics

Specifications
Generate a Multi-Tag Spec

Note
• Before you can perform this procedure, make sure you created a multi-
tag spec format for a spec form you need to associate with the
instrument for which you want to create the spec.
1. In the Specifications Module window, click Actions > Open Specification
2. From the Item type list, select Instrument.
3. In the Item number box, enter the exact instrument tag number that you want to
define as the master tag in your multi-tag spec.
Tips
• If you do not remember the instrument tag number, leave the Item
number box empty and click Find.
• If you are creating a specification for a specific process data case of an
instrument, the value in the Form number box might be view-only. If
the value is view only, you have already created previously a
specification for a different case of the same instrument. After
creating a spec for a process data case, the software assigns the same
spec form to all other cases of the same instrument.
• If the instrument process function is General, the available forms are
only those whose process function is also General. However, if the
instrument process function is not General, both General forms and
forms that have the same process function as the tag has are available
for association with the instrument.
4. In the Form number box, enter the spec form number of the form for which you
created a multi-tag list format.
Tip
• If you do not remember the form number, leave the Form number
box empty and click Find.
5. In the Open Specification box, click OK.
6. In the New Specification dialog box, do one of the following:
a. Select Create multi-tag specification.
b. In the Document number box, accept the default document number or
modify it as you require.
Tip
• The document number that you define applies to the entire multi-tag
specification, regardless of the number of instruments you
subsequently add in the current spec see list.

Specifications
7. Click OK to generate and open the specification.

Tip
• After generating the multi-tag spec, you can add other instrument tags
to the spec directly from the spec see list, without having to perform
the current procedure again.
Related Topics
• Generate Instrument Specs in Batch Mode, page 784
• Multi-Tag Spec Formats: An Overview, page 857
Add a Single Instrument Tag to a Multi-Tag Spec

1. In the Specifications Module window, the menu bar, click Actions > Open
Specification.
2. Select an instrument tag that is not yet associated with a specification by doing
• In the Item number box, type the tag number.
Click Find to search for the tag number that you require.
•
3. Select the spec form by doing one of the following:

• In the Form number box, type the form number.
•Click Find to search for the form that you require.
4. Click OK.
5. In the New Specification dialog box, select Add tag to existing multi-tag
specification.
6. In the Document numbers pane, select the document number of the target multi-
tag spec, with which you want to associate the current instrument tag.
Tips
• To display the selected multi-tag specification, click View.
•All the documents in all of the existing lowest level plant groups are
displayed in the Document numbers pane. Therefore, you can select
a document to add the instrument tag to a multi-tag spec belonging to
any of the existing plant groups.
7. Click OK to open the specification.
8. On the toolbar, click to save the specification.
Related Topics

Specifications
Add Instrument Tags to a Multi-Tag Spec in Batch Mode

2. Click the Multi-Tag List tab to display the instrument tags that exist in the
current see list.
• To add instrument tags that currently are not associated with any spec,
on the menu bar, click Actions > Add Tag.
• To move instrument tags from existing single-tag specs, on the menu
bar, click Actions > Move from Single.
4. On the Add Tag Number dialog box, click Find and then, search for the
instrument tags that you can add to the current spec.
5. Under Search results, select the tags that you require, and then, click OK to
return to the Add Tag Number dialog box.
6. On the Add Tag Number dialog box, click OK.
7. On the toolbar, click to save the specification.
Related Topics
Edit See List Data in a Multi-Tag Spec

2. Click the cell in which you want to add or edit data.
3. Modify the existing value or define a new value.
4. Save the spec.
Tips
• You can only edit or define the see list values per specific cell.
• On main data pages of a multi-tag spec, you can edit spec fields that
are common to all the tags, in the same way that you edit a single-tag
spec.
Related Topics
• Notes for Editing a Single-Tag Spec, page 838

Specifications
Change the Master Tag Definition

1. In the Specifications module, click Actions > Change Master Tags.
2. In the Change Master Tags dialog box, under Document numbers, select a
document number.
3. In the Tag numbers pane, beside the tag number you want to set as the muster
tag, select the Master check box.
4. Click Apply to set the selected tag as the new master tag.
Tips
• If you cannot find the document number in the Change Master Tags
dialog box, this means that the spec you are looking for does not
contain a document number. You need to open the target spec and
define the document number in the spec title block.
• The master tag definition also changes if you delete the current master
tag. In this case, the instrument tag that appears first in the see list
becomes the master tag.
Related Topics
• Ways of Defining a Spec Document Number, page 788
Search for a Specific Tag in a Multi-Tag Spec

1. In a multi-tag spec, click the Multi-Tag List tab to display the see list.
2. Accept the default sort order or define a new ascending sort order by double-
clicking the header on any column in the see list to set a new ascending.
Tips
• The default sort order is by tag number in ascending direction. When
you double-click a column heading, the arrow indicates the sort key
and direction. You can click the same column already change the
sorting direction.
• The master tag definition also changes if you delete the current master
tag. In this case, the instrument tag that appears first in the see list
becomes the master tag.
3. If you have not yet found your tag, on the toolbar, click and do one of the
following:
• Type the target tag number.
• Click Find to open a dialog box where you search for the tag.

Specifications
Change the Font Size of See List Column Headers

1. With the Specifications module window open, do one of the following:
• On the Edit menu, click Format Editor.
2. Click Actions > Customize Format.
3. In each of the spin boxes, set the values as appropriate.
Tips
• The Sample header font size and Sample header height boxes allow
you to add values in PowerBuilder units (1 PowerBuilder unit is
equivalent to 1/32 of the current system font height used in Windows).
• The Sample field font size and Sample field height boxes allow you
to add values in pixels.
4. Click OK.
Tip
• The changes you made in the font size will take effect only after you
reopen the multi-tag list format you are currently editing.
Related Topics
Move a Tag to Another See List

2. Click the Multi-Tag List tab to display the see list.
3. Select the instrument tags you want to move to another multi-tag spec.
4. On the menu bar, click Actions > Move to Another Multi-Tag List.
5. On the dialog box that opens, under Select target format, select a format.
Tips
• The Select target format displays all the formats that you can use to
create multi-tag specs. You can select either the format of the
currently open specification and then create a new specification, or
select a different format.
• If a format appears without the icon, this means that there are no
multi-tag specs assigned to this format, or that this is the format of the
current spec. In this case, you can only create a new multi-tag spec,
and move the instrument tags from the current see list to the see list of
the new spec.

Specifications
If you want to move instrument tags to an existing spec, select a

•
format that already has a multi-tag spec (that is, a format that has a
icon to the left of the format name).
6. Depending on the format that you selected, do one of the following:
• If the selected format is different from the current format, and already
has a multi-tag spec, select either Move to new multi-tag instrument
specification or Move to existing multi-tag instrument
specification.
• If you selected the current format or a format that does not have multi-
tag specs, select Move to new multi-tag instrument specification,
enter a document number for the new spec, and also, from the Master
tag list, select a tag number which you want to set as the master tag in
the new spec.
Related Topics
• Move a Tag from See List to a Single-Tag Spec, page 854
Move a Tag from See List to a Single-Tag Spec

2. Click the Multi-Tag List tab.
3. Select one or more tags and click Actions > Move to Single.
Tips
• If you selected multiple tags, on the Specifications tab of the
Preferences dialog box, you can select Skip individual confirmation.
• You cannot move the master tag.
• The form number of the created single-tag specs is the same as the
form number of the current multi-tag spec.
• The software automatically creates individual document numbers for
each single-tag spec. The created tag numbers depend on whether the
spec document number naming convention exists. If it does not exist,
the software creates spec document numbers as follows: <item tag>-
SP.
Related Topics
• Move a Tag to Another See List, page 853

Specifications
Remove a Tag from a Multi-Tag Spec

1. In a multi-tag specification, on the Multi-Tag List tab, select the instrument tags
that you want to remove from the see list.
2. On the Actions menu, click Remove Tag.
3. In the message that opens, click Yes when prompted to remove the tags.
4. When prompted to clear the specification data, do one of the following:
• Click Yes to delete from the database the see list values defined for the
tag.
• Click No to preserve the tag see list values in the database.
Tip
• If you clicked No, and then generate a specification for the tag that you
removed, the software retrieves the see list values from the database
and displays them in the generated spec. To display the values, it is
only crucial that the spec form on which you base the new spec
contains the columns that appeared in the see list of the tag that you
removed. This means that the form of the new spec does not have to
be the same as the form of the spec from which you removed the tag,
and that the type of the new spec can be either single-tag or multi-tag.
Notes
• You cannot remove the master tag unless you redefine it as a standard
tag.
• The software does not allow you to remove tags that are currently
assigned to a Specification Binder package or that were revised in the
Document Binder module.
Related Topics
• Change the Master Tag Definition, page 852

Specifications
Generate a Spec for an Analyzer Stream

1. Make sure that you have created a multi-tag format based on an analyzer stream
form.
Tip
•The library form #78 is an example of a form designed for an analyzer
stream. If this form is not displayed in the Select Specification Form
dialog box, restore the supplied library forms. You can then create a
multi-tag spec format for the form #78.
2. Based on such a format, generate a multi-tag spec for the stream tag that you want
to set as the master tag.
3. In the Multi-Tag List of the generated spec, add other tags belonging to the
current analyzer stream.
4. Click Actions > Save.
Related Topics
• Add Instrument Tags to a Multi-Tag Spec in Batch Mode, page 851
• Create a Format, page 858
• Generate a Spec for a Complex Analyzer, page 841

Specifications
Multi-Tag Spec Formats: An Overview

A multi-tag spec format is a template that contains see list columns where you can
define instrument-specific values on the Multi-Tag List tab of a multi-tag spec. You
create a specification format using a specification form as a source, and can build an
unlimited number of formats based on a single form.
Related Topics
Formats Common Tasks

You use the following tasks to manage multi-tag spec formats in the Specifications
module.
Create a Format
Use this procedure to create a formats for multi-tag specs. You create a format based
on a spec form, which in turn is based on a spec page. You can build an unlimited
number of formats based on a given form. When creating a format, you can edit the
headers of the columns that appear in the spec see list, and also fine-tune the order
and width of columns. For more information, see Create a Format, page 858.
Modify a Format
You can modify an existing format so that it fits the needs of your multi-tag specs.
The modification process is similar to creating a new format. Changes that you make
to a specification format affect multi-tag specs that are already associated with that
format. You modify formats in the Format Editor, in the Specifications module.
For more information, see Modify a Format, page 860.
Change the Font Size of See List Column Headers

This procedure allows you to modify the font size and height of the see list column
headers used in all multi-tag specs based on a specific format. You can customize the
column header font size and height, and also the column name font size and height.
For more information, see Change the Font Size of See List Column Headers, page
853.
Delete a Format
This procedure enables you to select a specific form, display its format, and then
delete a format that is not in use in multi-tag specs. For more information, see Delete
a Format, page 861.

Specifications
Regenerate Formats
Use this procedure if you encounter problems with opening or printing a multi-tag
spec after upgrading your SmartPlant Instrumentation version. These problems occur
because certain format properties are not applied to a form. Format regeneration can
fix these problems. For more information, see Regenerate Formats, page 862.
Change the Format for a Multi-Tag Spec

You use this procedure if more than one format exists for a form. For more
information, see Change the Format for a Multi-Tag Spec, page 862.
Define Multi-Tag Spec Print Layout

You use this procedure to define a custom print layout for a specific format. This
feature is useful if the default print layout causes data display problems in the
printout. For more information, see Define Multi-Tag Spec Print Layout, page 862.
Related Topics
Create a Format
1. On the Specifications Window module menu bar, click Edit > Format Editor.
2. On the Format Editor menu bar, click Actions > Open Format.
4. On the Select Format dialog box, under Format, type the name of the new
format and click OK.
Tip
If the form that you selected on the Select Specification Form dialog
•
box has existing formats, click New before typing the new format
name.
5. Do the following for each field that you want to appear on the spec see list:
a. In the field selection area of the form (usually on the right), double-click the
field.
b. To display the original form header in the active row of the Edit Headers
pop-up window, click the form header after the cursor changes its shape to
.
c. In the Edit Headers pop-up window, edit the header as necessary.
Tips
• The background color of the active field changes to magenta.

Specifications
• Fields already added to the Edit Headers pop-up window are

highlighted in cyan.
• The icon in the left column of the Edit Headers pop-up window
points to the header input box for the active field. If you are working
from a library form, the form header was automatically copied to this
field.
6. On the Format Editor toolbar, click to generate the format.
7. To change the see list column position of a header and its field, do the following
in the Edit Headers pop-up window:
a. Select the header for which you want to change the column position.
b. Click Move Up or Move Down as necessary.
Tip
• The order of the headers in the Edit Headers pop-up window
determines the left-to-right column order on the Multi-Tag List tab
the spec.
8. To change the width of columns as they appear in the spec see list, do the
following on the Format dialog box:
a. Select portrait or landscape print preview.
b. Set the cursor on the border between two headers.
c. Drag the border to the left or to the right as necessary.
9. Click to save the new format.
Related Topics

Specifications
Modify a Format
1. On the Specifications Window module menu bar, click Edit > Format Editor.
2. On the Format Editor module menu bar, click Actions > Open Format.
4. Select a format that you want to modify, and click OK.
5. To edit headers that currently appear in the Edit Headers pop-up window, do the
following:
a. In the field selection area of the form (usually on the right), double-click the
field for which you want to edit the header.
b. In the Edit Headers pop-up window, edit the header as necessary.
Tips
• When you double click the field, the background color of the field
changes to magenta.
• The icon in the left column of the Edit Headers pop-up window
points to the Header input box for the active field.
• To copy the original form header into the active Header input box,
click the form header after the cursor changes its shape to .
6. To remove a field and its header from the multi-tag list, do the following:
a. In the field selection area of the form, double-click the field that you want to
delete.
b. In the Edit Headers pop-up window, click Remove.
7. To add a field and header to the multi-tag list, do the following:
a. In the field selection area of the form, double-click the field that you want to
add.
b. To display the original form header in the active row of the Edit Headers pop-
up window, click the form header after the cursor changes its shape to .
c. In the Edit Headers pop-up window, edit the header as necessary.
8. To change column position of a header and its field, do the following in the Edit
Headers pop-up window:
a. Select the header for which you want to change the column position.
b. Click Move Up or Move Down as necessary.

Specifications
Tip
• The order of the headers in the Edit Headers pop-up window
determines the left-to-right column order on the Multi-Tag List tab
the spec.
9. To change the width of columns as they appear in the spec see list, do the
following on the Format dialog box:
a. Select portrait or landscape print preview.
b. Set the cursor on the border between two headers.
c. Drag the border to the left or to the right as necessary.
10. Click to regenerate and save the modified format
Related Topics
Delete a Format
1. With the Specifications module window open, do one of the following:
• On the Edit menu, click Format Editor.
2. Click Actions > Delete Formats.
3. On the Select Specification Form dialog box, select a form whose format you
want to delete, and then click OK.
4. On the Select Format dialog box, select the required format from the list.
Tips
• You can only select and delete one format at a time.
• The software prevents you from deleting a format that is in use in
specs.
5. Click OK to delete the selected format.
Related Topics

Specifications
Regenerate Formats
1. In the Specifications Module window, click Actions > Regenerate Formats.
2. On the Regenerate Formats dialog box, click Run.
3. On completion of the process, click Close.
Related Topics
Change the Format for a Multi-Tag Spec

2. Click Actions > Change Format.
3. On the Select Format dialog box, select the required format from the list.
Tip
•After changing the format, the software only shows see list columns
that appear in the format that you selected. As a result, if the current
see list columns do not appear in the selected format, the software
retains the column values in the database but does not display them in
the spec after you change the format.
4. Click OK to change the format.
Related Topics
Define Multi-Tag Spec Print Layout

1. On the Specifications Module window menu bar, click Edit > Format Editor.
2. On the Format Editor menu bar, click Actions > Open Format.
3. Select the target spec form and click OK.
4. Select the target format or create a new one and click OK.
5. On the form that opens, add field headers to the Edit Headers dialog box. For
details, see Create a Format, page 858.
6. On the toolbar, click to save the format.

7. On the menu bar, click Actions > Define Print Layout.
8. From the Column Header pop-up window, drag the field headers to the Define
Print Layout dialog box.

Specifications
Tip
• The number of the columns on the Define Print Layout dialog box
corresponds to the number of the headers in Column Header pop-up
window. You can drag up to five headers under the same column on
the Define Print Layout dialog box.
9. Click Generate.
10. On the Generate Print Layout dialog box, select the appropriate printout
orientation and click OK.
11. Test the defined print layout as follows:
a. Click File > Preferences > Specifications > General and clear the Use
default print layout check box.
b. Open a multi-tag spec assigned to the format for which you defined the print
layout.
c. Print the spec.
Tips
• The only supported spec page size is A4.
• If you want modify the print layout, for example by adding more
column headers, you must regenerate the print layout and then save it.
• The defined print layout applies to all existing and new multi-tag specs
assigned to the form that uses the current format.
Related Topics

Specifications
Non-Instrument Specs: An Overview

A non-instrument specification is a specification whose item type is not Instrument.
A spec page associated with a non-instrument spec form contains various properties
of the source item. If needed, you can regenerate the spec page and add more
columns from the tables <item type>, udf_<item type>, spec_sheet_data, and
add_spec1..9. For example, in a cable specification, you can add columns from the
tables CABLE, UDF_CABLE, and so forth. SmartPlant Instrumentation allows you
to generate the non-instrument specifications for the following item types:
• Cable — Allows you to create a specification for a single reference

cable defined in the Reference Explorer.
• Panel — Allows you to create a specification for a single reference
panel in the Reference Explorer.
• Wiring Equipment — Allows you to create a specification for a
single reference wiring equipment item. A wiring equipment item can
be an I/O card, I/O termination, fieldbus brick, or any other user-
defined wiring equipment in the Reference Explorer.
• Hook-Up Item — Allows you to create a specification for a single
hook-up item defined in the Reference Explorer.
• Loop — Allows you to create a functional requirement specification.
This specification consists of the main page with the loop number data,
individual pages associated with the loop tags, and the note page,
which is created automatically and refers to the loop number only.
The form associated with the loop number page is the form that you
defined for the Loop item type. The forms associated with the
functional requirement tag pages can be different, depending on the
form number that you associate with each functional requirement tag.
Important
• If you need to create a specification for a loop and its tags, we
recommend that you create a loop composite spec instead of a
functional requirement spec. For details, see Loop Composite Spec:
Generation Workflow, page 875 It is planned to discontinue support of
functional requirement spec after Version 2007 of SmartPlant
Instrumentation.
SmartPlant Instrumentation does not support saving non-instrument specifications as
.isf files. Therefore, you cannot use the export or import options to work with these
specifications in External Editor. Saving non-instrument specifications in Excel
format is not supported either.
Related Topics

Specifications
Non-Instrument Specs Common Tasks

The following tasks deal with generating specs for items whose item type is other
than Instrument.
Prerequisites for Generating a Non-Instrument Spec

This topic lists prerequisites for generating a non-instrument spec. For more
information, see Prerequisites for Generating a Non-Instrument Spec, page 866.
Generate a Non-Instrument Spec

Use this procedure to create a specification for a hook-up item, reference cable,
reference panel, or reference wiring equipment. In this procedure, cable spec
generation steps are shown as an example. Procedures of creating other non-
instrument specifications follow the same pattern. For more information, see
Generate a Non-Instrument Spec, page 867.
Generate a Functional Requirement Spec

This procedure explains how to generate a functional requirement specification. You
can use this procedure after defining a functional requirement for a loop using the
appropriate options in the Instrument Index module. For more information, see
Generate a Functional Requirement Spec, page 868.
Related Topics

Specifications
Prerequisites for Generating a Non-Instrument Spec

General Prerequisites
In the Form Editor, you must restore a form for the item type you want to assign
with the specification. For example, to generate a specification for a specific cable,
you must first restore the library form 80.
Cable Spec Generation Prerequisite

In the Reference Explorer, create a reference cable.
Panel Spec Generation Prerequisite

In the Reference Explorer, create a reference panel.
Wiring Equipment Generation Prerequisite

In the Reference Explorer, create an I/O card, I/O termination, fieldbus brick, or any
other user-defined wiring equipment.
Hook-Up Item Spec Generation Prerequisite

In the Reference Explorer, create a hook-up item and assign it to an item library.
Related Topics
• Generate a Non-Instrument Spec, page 867

Specifications
Generate a Non-Instrument Spec

Note
• Before you perform this procedure, restore the appropriate library
forms.
2. On the Open Specification dialog box, from the Item type list, select Cable.
3. Enter a name of a reference cable, or click Find to find the required reference
cable or form.
4. After specifying the cable name and the form number, on the Open Specification
dialog box, click OK.
5. On the New Specification dialog box, accept or modify the document number
associated with the new specification.
Tips
• The software automatically creates the document number using the
cable name as a source, and append the – SP suffix. There is no
naming convention for a non-instrument spec document number.
• You can leave the Document number box empty if you want to
specify the document number manually, after opening the
specification. In the specification, you can enter the document number
in the title block.
• You can only create a single-cable specification. The software does
not support a see list for non-instrument specs.
6. Click OK to generate a specification.
Tips
• If you want to save the cable specification as a .psr file, click Actions
> Save As, and select Original.
• You can edit various cable properties in the cable spec in two ways: in
the cable spec itself, or on the Properties dialog box, which you can
open for the cable in the Reference Explorer.
Related Topics
• Prerequisites for Generating a Non-Instrument Spec, page 866

Specifications
Generate a Functional Requirement Spec

2. On the Open Specification dialog box, from the Item type list, select loop.
3. Enter a loop number and the form number, or click Find to find the appropriate
loop number or form.
4. After specifying the loop number and the form number, on the Open
Specification dialog box, click OK.
5. On the Functional Requirement Specification dialog box, enter a new document
number to be associated with the new specification.
Tip
Leave the Document number box empty if you want to specify the
document number manually, after opening the specification. In the
specification, you can enter the document number in the title block.
6. Under Functional requirement tags, for each functional requirement tag, from
the Spec Form Number column, select the compatible form number to be
associated with the specification, and then click OK.
Tips
• You must select forms for all of the functional requirement tags
because on generating the specification, the software creates individual
pages for each tag that is displayed in the Functional requirement
tags data window.
• The forms associated with the functional requirement tag pages can be
different, depending on the form number that you associate with each
functional requirement tag.
• After creating a functional requirement specification, it is not possible
to change the form number of a tag in the functional requirement
specification or the form number of the loop. If you do need to change
the form number, you have to delete the entire specification, and then
create a new functional requirement specification again.
Related Topics

Specifications
Composite Specifications: An Overview

A composite specification is a specification that contains more than one section. You
can either define loop composite specs or instrument composite specs. A loop
composite spec includes a loop and its instrument tags. A composite instrument spec
can include tags belonging to the same or different loops. In contrast to multi-tag
instrument specifications, which contain pages of common properties in addition to
the SEE LIST page, such composite specs do not have common pages and can
include tags whose process functions are not identical. Each section in a composite
spec page contains data pertinent to a specific instrument tag. Also, it is possible to
create a composite spec that includes process data cases of a particular instrument.
Unlike other specs you create in SmartPlant Instrumentation, a composite spec does
not have a Notes page. If you want to use notes, you must manually add a note box
in the appropriate section.
In the Domain Explorer, document numbers of loop composite specs appear under
loop numbers and document numbers of instrument composite specs appear under
each instrument included in the spec. When duplicating an instrument tag associated
with a composite spec, the software never duplicates the composite spec. When
duplicating a loop, the software always duplicates the loop composite spec.
Generating and Printing Composite Specs

When generating a composite spec, if you assigned more than one instrument to a
particular section, the software multiplies this section on the spec as many times as
the number of assigned instruments. You can set the software to multiply sections
from left to right or from top to bottom. When more than one instrument is assigned
to the same section, the instruments are sorted automatically in ascending order
according to tag number. In a composite spec that contains process data cases of an
instrument, the cases are sorted in ascending order according to case sequence
defined in the Process Data module (governing case is always the left-most section).
When printing a composite specification, we recommend that the print sheet size be
either A4 or Letter.
Managing Composite Spec Sections

SmartPlant Instrumentation comes shipped with several spec forms that already
include composite pages with predefined sections (for example, forms 88, 89, 90).
You must restore these forms before you start working with the sections included in
the composite pages of these forms. A form with a composite page cannot include
any other pages. In SmartPlant Instrumentation, you can create new sections on the
basis of existing ones but it is not possible to create a section from scratch.
You manage spec sections in the Sections Editor. Spec section editing options are
the same as for spec pages, which you manage in the Page Editor. Therefore, before
modifying data fields in a spec section, it is recommended that you familiarize

Specifications
yourself with spec page management options. For details, see Specification Pages:
An Overview, page 789 and the related topics. The Section Editor has a limited
number of editing options. It is possible, however, to export spec sections to
InfoMaker, edit them as you require, and then import them back to SmartPlant
Instrumentation.
Features not Supported for Composite Specs

The following features of SmartPlant Instrumentation are not supported for composite
specs:
• Exporting data to External Editor (IEE)

• Save as Excel options
• Claim or merge options (only relevant in an Operating owner domain)
• Copying data from a form data template or another spec
• Multi-tag list format options or inclusion of composite pages in a
multi-tag spec
• Spec Data Dictionary options
• Browser options
• Data comparison and history options
• Changing the section process function
• Custom title block assignment options available in the Specifications
module (you must use the Standard custom title block assignment
method if you want to display a custom title block in composites
specs)
• Retrieving composite specs from Intergraph IDEAL
• Using InfoMaker with composite specs saved as .psr files.
Related Topics
• Composite Spec for Instrument with Cases: Generation Workflow,
page 873
• Composite Spec for Multiple Instruments: Generation Workflow, page
871
• Loop Composite Spec: Generation Workflow, page 875
• Multiply Sections from Left to Right: An Example, page Error!
Bookmark not defined.
• Multiply Sections from Top to Bottom: An Example, page Error!

Specifications
Composite Spec for Multiple Instruments: Generation

Workflow
In this scenario, you create an instrument composite spec containing two sections:
one for a control valve and the other for an I/P transducer. Such a spec can include
multiple control valves and I/P transducers belonging to different loops. You use the
library form Control Valve/I/P Transducer as a source for creating a new form and
assigning a new composite spec page to this form.
1. In the Instrument Index module, or using the Domain Explorer, create a control
valve and I/P transducer.
2. On the Specifications Module window menu bar, click Edit > Form Editor.
3. On the Form Editor menu bar, click Actions > Restore Form and then restore
form Control Valve/I/P Transducer (form number 90).
Tip
• When restoring the form, the software restores its page and enables
you to work with sections that this page includes.
4. On the Specifications Module window menu bar, click Edit > Section Editor
and modify the fields of the following sections as you require:
• Control Valve Style3 (item type Instrument)
• I/P Transducer Style3 (item type Instrument)
5. On the Specifications Module window menu bar, click Edit > Page Editor.
6. On the Page Editor menu bar, click Actions > New Composite Page.
7. On the New Composite Page dialog box, select Data sections with headers.
8. On the Select Sections for Composite Page dialog box, under Multiply sections
in generated spec, select From top to bottom, and then select the following
sections:
• Control Valve Style3
• I/P Transducer Style3
Tip
• When you select a section multiplying option, you determine how the
software multiplies sections in a generated composite spec. In a
generated spec, if you assigned more than one instrument to a section,
the software multiplies this section on the spec as many times as the
number of assigned instruments. You set a section multiplying option
only once and cannot change it after you open and save the current
spec page in the Page Editor. This setting applies to all the sections
you add in the current spec page.

Specifications
9. In the Page Editor working area, position the sections one under the other, within
the page borders.
10. Save the page with the name CV/I/P Transducer Test.
11. Open the Form Editor and click Actions > New Form, select the Control
Valve/I/P Transducer page for the form, and then name the new form as CV/I/P
Transducer Test and specify a form number.
Specification and do the following:
a. From the Item type list, select Instrument.
b. In the Item number box, enter the tag number of the control valve you
created.
c. In the Form number box, enter the number of the CV/I/P Transducer Test
form and click OK.
d. On the New Composite Specification dialog box, beside I/P Transducer
Style1, click Assign and assign your I/P transducer to the I/P Transducer
Style1 section.
e. Click OK to generate and open an instrument composite specification.
Related Topics

Specifications
Composite Spec for Instrument with Cases: Generation

Workflow
In this scenario, you create an instrument composite spec containing three process
data cases of an instrument with the Flow process function. You use the library form
Orifice Plate Composite as a source for creating a new form and assigning a new
composite spec page to this form.
1. In the Instrument Index module, or using the Domain Explorer, create a flow
instrument.
2. In the Process Data module, create three cases for the instrument and define
process data for each case.
form Orifice Plate Composite (form number 88).
Tip
• When restoring the form, the software restores its page and enables
you to work with sections that this page includes.
• Flow Orifice Header (header section)
• Flow Orifice Data (data section)
8. On the New Composite Page dialog box, select Header section and data
section.
9. On the Select Sections for Composite Page dialog box, select the following
sections:
• Flow Orifice Header
• Flow Orifice Data
10. In the Page Editor working area, position the sections one under the other.
11. Save the page with the name Orifice Plate Composite Test.
12. Open the Form Editor and click Actions > New Form, select the Orifice Plate
Composite page for the form, and then name the new form as Orifice Plate
Composite Test and specify a form number.

Specifications
a. From the Item type list, select Instrument.

b. In the Item number box, enter the tag number of the flow instrument that has
cases.
c. In the Form number box, enter the number of the Orifice Plate Composite
Test form and click OK.
d. Select a case to assign it to the instrument composite spec you are creating and
click OK.
e. On the New Composite Specification dialog box, beside Flow Orifice Data,
click Assign and assign the two remaining cases to the Flow Orifice Data
section.
f. Click OK to generate and open an instrument composite specification.
Tip
• In the composite spec, the sections that show case data appear from
left to right. The sections are sorted in ascending order according to
case sequence defined in the Process Data module (governing case is
always the left-most section).
Related Topics
• Multiply Sections from Left to Right: An Example, page Error!

Specifications
Loop Composite Spec: Generation Workflow

In this scenario, you create a loop composite spec containing three sections: a loop
section and two instrument sections. The two instrument sections include one for a
control valve and the other for an I/P transducer. You use the library form Flow
Loop Composite Style1 as a source for creating a new form and assigning a new
composite spec page to this form.
1. In the Instrument Index module, or using the Domain Explorer, create a loop
with a control valve and I/P transducer.
form Flow Loop Composite Style1 (form number 91).
Tip
• When restoring the form, the software restores its page and the seven
sections that this page includes. In this scenario, you need three of
these sections to generate the current composite loop spec.
• Flow Loop Composite Style1 (item type Loop)
• Control Valve Style1 (item type Instrument)
• I/P Transducer Style1 (item type Instrument)
7. On the New Composite Page dialog box, select Loop composite page.
8. On the Select Sections for Composite Page dialog box, under Multiply sections
in generated spec, select From top to bottom, and then select the following
sections:
• Flow Loop Composite Style1
• Control Valve Style1
• I/P Transducer Style1
Tip
• When you select a section multiplying option, you determine how the
software multiplies sections in a generated composite spec. In a
generated spec, if you assigned more than one instrument to a section,
the software multiplies this section on the spec as many times as the
number of assigned instruments. You set a section multiplying option
only once and cannot change it after you open and save the current

Specifications
spec page in the Page Editor. This setting applies to all instrument
sections you add in the current spec page.
9. In the Page Editor working area, position the sections one under the other, with
the loop section placed at the top.
10. Save the page with the name Flow Loop Test.
11. Open the Form Editor and click Actions > New Form, select the Flow Loop
Test page for the form, and then name the new form as Flow Loop Test and
specify a form number.
a. From the Item type list, select Loop.
b. In the Item number box, enter the number of the loop you created.
c. In the Form number box, enter the number of the Flow Loop Test form and
click OK.
d. On the New Composite Specification dialog box, beside Control Valve
Style1, click Assign and assign the current loop control valve to the Control
Valve Style1 section.
e. Beside I/P Transducer Style1, click Assign and assign the current loop I/P
transducer to the I/P Transducer Style1 section.
f. Click OK to generate and open a loop composite specification.
Related Topics

Specifications
Remove an Instrument from a Composite Spec

1. In a composite specification, do one of the following:
• On the Actions menu, click Remove Tags from Composite Spec.
• On the toolbar, click
2. In the dialog box that opens, select one or more tags and click OK.
3. On the toolbar, click to refresh the spec.
Tips
• When removing tags from a loop composite spec, you can remove all
the instruments.
• When removing tags from an instrument composite spec, you cannot
remove the last remaining tag because such a spec must include at
least one instrument tag.
• After removing instruments, the sections remain displayed in the spec.
If you want to remove these sections from the spec, you must remove
them in the Page Editor. For details, see Remove a Section from a
Composite Page, page 877.
Related Topics
Remove a Section from a Composite Page

1. Open a composite spec in the Page Editor.
2. In the working area, select and right-click a section you want to remove from the
current page.
3. On the shortcut menu, click Remove Current Section.
Tip
• If a composite spec including the selected section already exists, the
software does not allow you to remove the section. You must first
open such a spec and dissociate all the instruments that are assigned to
the current section. For details, see Remove an Instrument from a
Composite Spec, page 877.
Related Topics

Specifications
Spec Title Blocks: An Overview

A specification title block is a library or customized .psr file that combines revision
rows, database fields, and a logo. You assign a title block to a spec form to display
the relevant information in specifications based on that form. If a form contains
several pages, the title block is common to every page of the form. In a generated
single-section spec, the software displays the same title block on every spec page,
including the Notes page. In a generated composite (multi-section) spec, the software
does not display the title block; you need to open a spec print preview to display the
title block.
The System Administrator, when making or modifying domain definitions in the

Administration module, can select a custom title block assignment method. The
following block assignment methods are available:
Standard (used in all modules
This method allows you to associate one default title block with all the specs you
generate. When using this method, the software hides all the title block assignment
options that are available in the Specifications module. In this case, you need to
associate your title block with SmartPlant Instrumentation on the Title Blocks dialog
box. The Domain Administrator, when managing reports, can then define your title
block as the default title block that appears automatically in all specifications that you
generate. We recommend that you use the Specs Default TB with PB Units.psr title
block with specs. This is a template title block that is supplied with SmartPlant
Instrumentation. This title block is created using PowerBuilder units.
Note
• You need to place the title block correctly in a spec page layout. To do
so, in the Preferences dialog box, on Specifications > Custom page,
under Parameter, enter TitleFooterHeight, and under Value, enter
798, which is the optimal value for specifications created using
SmartPlant Instrumentation options. For a spec page created in
InfoMaker, you may need to enter a different value, depending on the
page layout settings.
Special (used in the Specifications module only)
This method allows you to assign various title blocks to spec forms. If this method is
defined in the current domain, the Domain Administrator does not assign any default
title block to your specs, so you need to make title block assignments by yourself,
using the Specifications module options. You can create multiple custom title blocks
and associate then with SmartPlant Instrumentation using the Title Block Styles dialog
box. Depending on your database platform, you must only use one of the following
title blocks as a source for creating custom title blocks: tb_mss.psr (when using SQL

Specifications
Server), tb_ora.psr (when using Oracle, or Tbsample.psr (when using Sybase

Adaptive Server Anywhere).
Note
• When working with composite specs, you cannot use the title block
assignment options that are available in the Specifications module.
Therefore, if the selected block assignment method is Special, the
software automatically assigns the default title block to a composite
spec even though the module-specific option are available in the
Specifications module. This title block is supplied with SmartPlant
Instrumentation and is associated by default with all SmartPlant
Instrumentation reports.
Related Topics
• Title Block in a Multi-Tag Spec, page 879
Title Block in a Multi-Tag Spec

A multi-tag specification does not require any special procedure for associating a title
block. The software associates a title block with a multi-tag page through the spec
form that it belongs to. That is, when a multi-tag spec form has an associated title
block, this title block appears automatically on all pages of the spec. When you open
a multi-tag spec, the Multi-Tag List (see list) page appears without a title block.
However, if you open a print preview or print the specification, the software displays
the same title block on all of the spec pages.
Related Topics

Specifications
Spec Title Block Common Tasks

The following tasks deal with customizing, assigning, and modifying spec title blocks
if the System Administrator, when making the current domain definitions, defined the
custom title block assignment method as Special. If the method is defined as
Standard, you only need to associate a title block with SmartPlant Instrumentation
using the Title Blocks dialog box options. Then, your Domain Administrator can
define this title block as the title block that appears in any spec you generate,
regardless of the spec form or spec type.
Customize a Title Block in InfoMaker

This procedure allows you to customize a title block using Sybase InfoMaker. After
performing this procedure, you can insert the customized report layout into
SmartPlant Instrumentation so that it becomes a custom title block. For more
information, see Customize a Title Block in InfoMaker, page 881.
Assign a Title Block to a Form

Use this procedure to assign a title block that you created or edited in InfoMaker to a
spec form. You then set the block position and size within the form. For more
information, see Assign a Title Block to a Form, page 882.
Modify a Custom Title Block

Use this procedure to modify a custom title block that you have already imported into
SmartPlant Instrumentation from a .psr file. The software automatically updates the
title block in all spec forms that use this title block. For more information, see
Modify a Custom Title Block, page 883.
Update Custom Title Blocks After Version Upgrade

After upgrading SmartPlant Instrumentation, you must manually update all of your
custom title blocks based on the title block files Tb_ora.psr, Tb_mss.psr,
Tbsample.psr. Then, you need to reassign the title blocks to your spec forms. For
more information, see Update Custom Title Blocks After Version Upgrade, page 883.
Related Topics

Specifications
Customize a Title Block in InfoMaker

Note
• If your System Administrator, when making or modifying domain
definitions, selected the Standard custom title block assignment
method, you do not have to perform this procedure. Instead, you can
use the title block Specs Default TB with PB Units.psr file, that is
supplied with SmartPlant Instrumentation.
1. Start InfoMaker and a .psr file created on the basis of one of the following files:
Tb_ora.psr (for use on Oracle), Tb_mss.psr (for use on SQL Server), or
Tbsample.psr (for use in Sybase Adaptive Server Anywhere
2. When adding other design-related items, such as internal lines, text boxes, and so
forth, to the title block, add the tb segment to the names of the new items. For
example, if you want to add a new line, name the line as <Line>_tb_<1>. This is
required to distinguish between items that belong to the title block and items that
belong to the rest of the report outside the title block.
3. Modify the report layout using the following guidelines:
• When you edit the logo field, do not change the value logo under
Name, on the General tab of the Properties dialog box. This is
crucial if you intend to use Save as Excel options of SmartPlant
Instrumentation to save specifications based on a form that
incorporates this title block.
• All the objects in the report layout, such as lines, text, field, and so
forth must be defined as the Background Layer. If you are creating a
new object, make sure you change it from the default band layer to the
Background Layer.
• Objects that appear in the report layout one below another, such as
revision rows, must be defined as Detail Band Layer.
• If you add revision rows, make sure you decrease the row height so
that the title block height is not greater than the default height of the
title block you customize. A custom title block whose height is greater
than the default height causes display problems on the Note page of a
SmartPlant Instrumentation specification.
• Do not make any changes to SQL commands.
• Do not include left or right borders since the border of the page will be
used for the title block.
• If you move any report layout items while working on the report
layout, make sure you reposition those items exactly in their original
locations.

Specifications
Tip
You cannot insert a new field in the report layout. You can only
•
modify existing fields.
4. Save the report layout under a different name and close InfoMaker.
Related Topics
Assign a Title Block to a Form

1. On the Specifications Module window menu bar, click Actions > Title Block
Styles.
2. On the Title Block Styles dialog box, click New.
3. On the Title Block Definition dialog box, select the appropriate .psr file, and
click OK.
Tip
You must select a file created on the basis of one of the following
•
files: Tb_ora.psr (for use on Oracle), Tb_mss.psr (for use on SQL
Server), or Tbsample.psr (for use in Sybase Adaptive Server
Anywhere).
4. Under Style name, type the new title block name.
5. Under Number of revisions, accept the displayed number of revision lines.
6. Set the new title block size by using the four-directional arrows.
Tips
• The red line outlines the title block border.
•Under Units per click, type a numeric value to set how far the jump
will take the red line when clicking on one of the four-directional
arrows.
7. Click OK, and on the Title Block Styles dialog box, click Close.
8. Set the location of the title block in the specification as follows:
a. On the Specifications Module window menu bar, click Actions > Associate
Title Block.
b. On the Select Specification Form dialog box, select a form, and click OK.
c. On the Associate Title Block dialog box, under Style Name, select the title
block that you imported.
d. Under Choose location, select Detail.
e. Drag the title block to the required location in the specification page and when
done, click OK.

Specifications
Modify a Custom Title Block

Styles.
2. On the Title Block Styles dialog box, select the title block that you want to edit,
and click Properties to open the Title Block Definition dialog box.
Tip
• If you have made any changes to the title block in InfoMaker, click
Open File, and then, select the title block .psr file and click OK.
3. Under Style name, type the new title block name if needed.
4. Under Number of revisions, set the number of revision lines to be displayed in
the title block according to the revision lines that the title block contains.
Tip
• If the number of revisions that you set is greater than the number of the
revision rows, you might have display problems in the title block.
5. Set the new title block size by using the four-directional arrows.
Tips
• The red line outlines the title block border.
• Under Units per click, type a numeric value to set how far the jump
will take the red line when clicking on one of the four-directional
arrows.
6. Click OK, and on the Title Block Styles dialog box, click Close.
Related Topics
Update Custom Title Blocks After Version Upgrade

Styles.
2. On the Title Block Styles dialog box, select a title block based on Tb_ora.psr,
Tb_mss.psr, or Tbsample.psr file, and click Properties.
3. On the Title Block Definition dialog box, click Export File, and then, save this
file as a .psr file, for example, Update.psr.
4. Close SmartPlant instrumentation, and then, in InfoMaker, open the source .psr
file, on which the Update.psr is based. For example, if the source title block file
is Tbsample.psr, you must open this file in InfoMaker.
5. Redraw the title block in InfoMaker according to the Update.psr title block
requirements.

Specifications
6. Save this file as Update.psr to overwrite the current Update.psr file.

7. Reopen SmartPlant instrumentation, and then, on the Specifications Module
window menu bar, click Actions > Title Block Styles.
8. On the Title Block Styles dialog box, select a title block, and click Properties.
9. On the Title Block Definition dialog box, click Open File, and then, select the
Update.psr file and click OK.
10. On the Title Block Definition dialog box, click OK, to update the title block
definition in the database and re-assign the updated title block to all the spec
forms that use it.
11. On the Title Block Styles dialog box, click Close.
Related Topics

Specifications
Copying Specification Data: An Overview

The automated data copying options are useful when you need to create a number of
specifications with similar data. You can use the following sources for copying
specification data:
• Form data template— You can copy data to any spec whose form is
the same as the template form.
• Specification — You can copy data either to another spec or to a
form data template, provided that the source and target form is the
same. When you copy data to a form data template, the software does
not affect data of existing specs that are based on this template.
Data copying options are only available in the Specifications module. You cannot
copy specification data in batch mode.
You can protect all or certain fields from being overwritten when you copy
specification data. You can protect the appropriate fields in the Spec Data
Dictionary. Also, you can set preferences for copying specification data. The
following options are available on the Preferences dialog box (File > Preferences >
Specifications > General):
• Copy without overwriting existing data— Copies data to empty

fields only. This option does not overwrite data that already exists in
the target form data template or spec.
• Copy excluding blank fields in source— Copies data from source
fields except for those source fields that have no data.
• Copy all fields— Overwrites all data fields in the target form data
template or spec.
Related Topics

Specifications
Copying Specification Data Common Tasks

The following tasks enable you to copy spec data from one spec to another, or to use
form data templates.
Protect Fields from Overwriting When Copying Data

Use this procedure to protect fields from overwriting of data when you copy
specification data or import data from an external spec to a spec that exists in
SmartPlant Instrumentation. You perform this procedure at the form level. The
fields that you protect for a given form apply to all new form data templates you
create for this form. For more information, see Protect Fields from Overwriting
When Copying Data, page 887.
Copy Data from One Spec to Another

Use this procedure to copy data from one spec to another. You can copy data from a
spec belonging to any plant group of the current <plant>. The source and target spec
form number must be the same. For more information, see Copy Data from One Spec
to Another, page 890.
Copy Data to a Spec from a Form Data Template

Use this procedure to automate entry of common data to your specification by using a
form data template that you created for the form upon which the current spec is based.
For more information, see Copy Data to a Spec from a Form Data Template, page
889.
Copy Data to a Form Data Template from a Spec

Use this procedure to copy a batch of data to a form data template from a
specification. This can be an efficient way of building the template, which you can
then use to transfer common data to other specs based on the same form. When you
copy data to a form data template, the software does not affect data of existing specs
that are based on this template. For more information, see Copy Data to a Form Data
Template from a Spec, page 887.
Related Topics
• Copying Specification Data: An Overview, page 885

Specifications
Protect Fields from Overwriting When Copying Data

1. On the Specifications Module window toolbar, click to open the Spec Data
Dictionary.
2. On the Select Specification Form dialog box, select a form, and click OK.
3. On the toolbar, click (Properties).
4. To protect the fields in the correct form, do one of the following:
• To protect all of the fields from one or more tables, click the Tables
tab, and then, under Template Fields, click All for the appropriate
tables.
• To protect individual fields, on the Field Properties tab, in the
Template column, select the appropriate check boxes.
Related Topics
• Create and Modify a Form Data Template, page 833
Copy Data to a Form Data Template from a Spec

1. Click File > Preferences > Specifications > General.
2. Under Data copying options, select one of the following:
the target form data template.
spec fields except for those source spec fields that have no data. This
means that if a certain field in the source spec does not have any value
or only has spaces, the software ignores this field when copying data.
• Copy all fields— Overwrites all data fields in the form data template.
A source field that only has spaces is considered blank.
Tip
their preferences. Therefore, you can find that the data copying
options are disabled. If you want to enable these options, contact your
Domain Administrator, who can manage preferences from the

Specifications
3. On the Specifications Module window menu bar, module, click Edit > Form
Data Template Editor.
4. On the Select Specification Form dialog box, select a form that has a data
template, and click OK.
5. On the Select Form Data Template dialog box, select a form data template from
the list.
6. Click OK to open the form data template.
Tip
If the form data template has fields that are not accessible, these fields
•
are protected in the Spec Data Dictionary. When copying data, the
software ignores protected fields. For details, see Protect Fields from
Overwriting When Copying Data, page 887.
7. On the menu bar, click Actions > Copy From.
8. On the Find Item dialog box, under Form number, select the form of the spec
you want to use for copying data, and click Find.
9. Under Search results, select the item whose spec you want to use as a source for
copying data.
10. Click OK to copy the spec data.
Related Topics

Specifications
Copy Data to a Spec from a Form Data Template

the target spec.
• Copy excluding blank fields in source— Copies data from template
fields except for those template fields that have no data. This means
that if a certain field in the form data template fields does not have any
value or only has spaces, the software ignores this field when copying
data.
• Copy all fields— Overwrites all data fields in the spec. A source
field that only has spaces is considered blank.
Tip
3. In the Specifications module, open the spec to which you want to copy data.
4. On the menu bar, click Actions > Copy from Template.
5. On the Select Form Data Template dialog box, select a form data template from
the list.
6. Click OK to copy the data from the selected form data template to the
specification.
Related Topics

Specifications
Copy Data from One Spec to Another

the target spec.
spec fields except for those source spec fields that have no data. This
means that if a certain field in the source spec does not have any value
or only has spaces, the software ignores this field when copying data.
• Copy all fields— Overwrites all data fields in the target spec. A
source field that only has spaces is considered blank.
Tip
•The Domain Administrator can restrict the ability of other users to set
3. In the Specifications module, open the spec to which you want to copy data.
4. On the menu bar, click Actions > Copy from Specification.
5. On the Find Item the dialog, under Form number, select the form upon which
your specification is based, and click Find.
6. Under Search results, select the item whose specification you want to use as a
source for copying data.
Tip
•When you copy data to a spec, be careful when overwriting existing
data. In the Spec Data Dictionary, you can define fields that you do
not want to overwrite. For more details, see Protect Fields from
Overwriting When Copying Data, page 887.
7. Click OK to copy the data.
Related Topics

Specifications
Spec Revisions: An Overview

You use revisions to keep track of changes in your specifications. If the Domain
Administrator has set the software to archive revisions, you can view, print, and
compare previous revisions of specifications with the current versions.
You can manage spec revisions in the following ways:
• Locally — managing revisions that belong to a currently open spec.

When managing revisions locally, you open a particular spec and then
open the Revisions dialog box, where you can add, edit, or delete
current spec revisions. In this dialog box, when you first select a
revision numbering method, several options are available to you,
including preliminary revisions (designated by P0, P1, P2…). After
you select one of the other revision methods, you can no longer return
to the preliminary revision method and this option becomes disabled.
When using SmartPlant Foundation revisions, the revision numbering
methods are not available for selection. Only the last five revisions
appear in the Revisions dialog box or in the spec title block.
• Globally — managing revisions that belong to any number of
existing specs. You do not need to open the Specifications module to
manage revisions globally, only the Global Revisions dialog box.
Also, if you want to view all revisions belonging to all existing specs,
in the Specifications module, you need to click Actions > Manage
Spec Revisions. If you want to print out revisions belonging to
various specs, you can click Actions > Spec Revisions.
In the Specifications module, you cannot revise instrument specifications that you
assigned to a Specification Binder package in the Document Binder module.
Therefore, the software prevents you from adding new revisions to these specs, or
delete these spec revisions.
Related Topics
• Revision and Data Comparison Common Tasks, page 892

Specifications
Revision and Data Comparison Common Tasks

The following tasks deal with managing spec revisions and comparing spec data.
Manage Spec Revisions Locally

Use this procedure to add, edit, and delete specification revisions locally. For more
information, see Manage Spec Revisions Locally, page 893.
Manage Spec Revisions Globally

Use this procedure to maintain specification revisions in batch mode, using global
revision options. For more information, see Manage Spec Revisions Globally, page
894.
View and Print Spec Revisions

Use this procedure to view and print archived revisions belonging to existing specs.
By default, the dialog box displays all archived revisions in the more <plant>. For
more information, see View and Print Spec Revisions, page 895.
Compare Current Data with a Saved Revision

Use this procedure to compare data in the current specification with a specification
that was archived as a previous revision. This option enables you to generate a report
that shows the data changes. You can also set fonts and color to display the changes.
For more information, see Compare Current Data with a Saved Revision, page 896.
Compare Current Data with a Saved Spec

Using this option you can compare data in the current specification with a
specification that you saved as an .isf file. This option enables you to generate a
report that shows the data changes. You can also set fonts and color to display the
changes. For more information, see Compare Current Data with a Saved Spec, page
896.
View Data History

SmartPlant Instrumentation can indicate specification data changes by comparing
current data with the data stored in the audit trail repository for the date range that
you specify. You can set a color to mark changes, set a shade of gray to emphasize
the changed data in printed reports and their previews, and also set bold and italic font
style for emphasis on the screen and in print. History indication is available only if
the System Administrator has activated the audit trail functionality. When the audit
trail functionality is activated, each time that you save data after making changes, the
data is recorded in the audit trail repository. For more information, see View Data
History, page 897.

Specifications
Change Storage Method of Specification Revisions

Use this procedure to convert specification revisions from one storage format to
another. By default, the software stores spec revisions in the database and
compresses the revision data automatically to save space. You can save revisions to
the SmartPlant Instrumentation database or as external .psr files, or compress them
and save as a single .zip file. You can only perform this procedure after the Domain
Administrator, in the Report Management dialog box, specifies the folder for saving
spec revisions as .psr or .zip files. Saving revisions in .zip or .psr format is useful
when you have made a large number of revisions, and want to reduce the size of your
database. For more information, see Change Storage Method of Specification
Revisions, page 898.
Delete Spec Revisions

Use this procedure to delete one or more spec revisions in batch mode. You can
select and delete revisions that belong to different specs. For more information, see
Delete Spec Revisions, page 899.
Related Topics
• Spec Revisions: An Overview, page 891
Manage Spec Revisions Locally

1. Open a spec.
• Click Actions > Revisions.
3. In the Revisions dialog box, select one of the revision numbering methods (use
P0, P1, P2... for preliminary revisions or 0, 1, 2 /A, B, C, and so forth for normal
serial revisions).
Tips
• When you first select a revision numbering method, several options
are available to you, including preliminary revisions (designated by
P0, P1, P2…). After you select one of the other revision methods, you
can no longer return to the preliminary revision method and this option
becomes disabled.
• When working with revisions in an integrated environment, the
revision numbering methods are not available for selection.
• Only the last five revisions appear in the Revisions dialog box, or in
the revision title block. To view all revisions of the current spec, click
Actions > Compare with Revision.
4. Click New to add new revision data or update the existing data as desired.

Specifications
Tips
• SmartPlant Instrumentation automatically adds a new line with the
next logical character and date each time you click New after you
select the initial method.
If you are working in an integrated environment in a module that
•
5. Add or edit the revision data in the appropriate boxes.
Tip
The By box contains the current user's initials by default, if previously
•
defined by the System Administrator in the Administration module.
You can also edit this setting if required.
6. To delete revisions locally you no longer require, select the revisions and click
Delete.
Related Topics
Manage Spec Revisions Globally

1. In the main SmartPlant Instrumentation window, click Tools > Global
Revisions.
2. On the Settings tab, under Activity, do one of the following:
• Select Add Revision to add revisions to instrument tags without
checking the current revision settings.
Select Upgrade Revision to add revisions to instrument tags
•
according to defined criteria.
3. Enter the required revision information.
4. Click the Specifications tab.
5. Select all or particular specs that you want to revise.
Tips
• To select multiple specs, use the Shift or Ctrl key.
•Multi-tag specs only appear at the end of the list when you select the
Select all check box. The Tag Number box displays the text SEE
LIST with the number of the master tag enclosed in parentheses.
6. Click Apply to add the revisions to the specs of the selected instrument tags.

Specifications
Tips
• If any of the specs selected for revision is assigned to a Specification
Binder package, that spec does not undergo a revision and the software
displays an appropriate message. Afterwards, a list of the specs that
were not revised is displayed, and the reason appears in the Comment
field.
• You can click Print to print the list of specs for which the revision
failed, or click Save As to save the list to a file. These buttons appear
after the software could not revise certain specs.
Related Topics
View and Print Spec Revisions

1. In the Specifications module, click Actions > Spec Revisions.
2. Under Revision filter, define filter parameters as needed and then select Apply.
Tips
• By default, the dialog box displays all archived revisions in the
<plant>. You can select a specific plant group to filter the revisions
accordingly. To revert to the default display, in the Plant group box,
select the empty row. Also, you can filter revisions by spec form
number, or type a specific number in the Revision box.
• You can also search for a revision by tag number or document number
by entering the appropriate values under Find.
3. In the data window, select one or more revisions that you want to view or print
out, and click OK.
Related Topics

Specifications
Compare Current Data with a Saved Revision

1. Open a spec.
2. Click Tools > Data Comparison Display Options and set font and color settings
for comparison as you require.
3. On the Actions menu, click Compare with Revisions to open a dialog box with a
list of available revisions for the current spec.
4. Select a revision and click OK.
5. In the dialog box that opens, click Yes to preview the report, or No to print the
report without previewing.
Tips
• If you clicked Yes to preview the report, close the preview window to
see the specification with the changes indicated.
• The report shows the names of the columns that were changed: Spec
Report Value shows the current data, and External Spec Value
shows external file data.
• SmartPlant Instrumentation displays your specification with changed
fields indicated according to your settings in the Data Comparison
Display Options dialog box.
Related Topics
Compare Current Data with a Saved Spec

1. Open a spec.
2. Click Tools > Data Comparison Display Options and set font and color settings
for comparison as you require.
3. On the Actions menu, click Compare with External.
4. In the Select File for Comparison dialog box, navigate to the required .isf file
and click OK.
5. In the dialog box that opens, click Yes to preview the report, or No to print the
report without previewing.
Tips
• If you clicked Yes to preview the report, close the preview window to
see the specification with the changes indicated.

Specifications
• The report shows the names of the columns that were changed: Spec
Report Value shows the current data, and External Spec Value
shows external file data.
• SmartPlant Instrumentation displays your specification with changed
fields indicated according to your settings in the Data Comparison
Display Options dialog box.
Related Topics
View Data History

Note
• History indication is available only if the System Administrator has
activated the audit trail functionality. When the audit trail
functionality is activated, each time that you save data after making
changes, the data is recorded in the audit trail repository.
1. Open a spec.
2. Click Options > History Options.
3. Do one of the following to select the date range for data history comparison:
• In the From and To boxes, type the appropriate dates or use the
spinners.
• To set the To data field value as today's date, click Today.
4. To set a font style to emphasize changes on the screen and in print, select Bold or
Italic, or both check boxes.
5. To change the color used to display changes on the screen, do the following:
b. On the Color dialog box, choose the color that you require.
dialog box.
and their previews, do the following:
b. On the Grayscale dialog box, slide the bar to the required position.
c. Click OK to save your new grayscale settings and return to the History
Options dialog box.
dialog box.

Specifications
8. On the Options menu, click Mark Changes to mark changes in the current
specification for the dates that you specified in the History Options dialog box.
Tips
• To refresh the history indication in an open specification, on the
Options menu, clear Mark Changes and then select this option again.
• The software does not mark changes in a spec note, or in a large note
page.
Related Topics
Change Storage Method of Specification Revisions

1. Open the Specifications module.
2. On the Actions menu, click Manage Spec Revisions.
Tip
To display specifications of one revision only, under Revision filter,
•
type the revision number and click Apply
3. Under Select spec revisions, select one or more revisions whose storage method
you want to change.
4. Under Change storage method, do one of the following:
• Select PSR files to save each revision as an external .psr file in the
location specified in the Administration module. This option is only
available after the Domain Administrator, in the Report Management
dialog box, specifies the folder for saving spec revisions as .psr or .zip
files.
• Select ZIP file to save all the selected revisions as a single external
.zip file in the location specified in the Administration module. This
option is only available after the Domain Administrator, in the Report
Management dialog box, specifies the folder for saving spec revisions
as .psr or .zip files.
•Select Database to save the revision to the SmartPlant Instrumentation
database. For this option, the data is automatically compressed to save
disk space.
5. Click Change method.
Related Topics
• Spec Revisions: An Overview, page 891

Specifications
Delete Spec Revisions

1. In the Specifications module, click Actions > Manage Spec Revisions.
2. Filter revisions as you require.
Tip
• If you want to display revisions defined for all specs that exist in all of
your plant groups, under Plant group, select the empty row.
3. Select one or more revisions.
4. Click Delete.
Tip
• When you delete a revision, the software does not delete the spec
itself. Deleting a spec, however, always deletes all of the spec
revisions automatically.
Related Topics
• Delete Global Revisions, page 85

Specifications
Save, Export, and Import Options: An Overview

SmartPlant Instrumentation supports saving spec data in the following formats:
• .isf (only specs whose item type is Instrument)

• .psr (any single-tag spec, multi-tag spec, or a non-instrument spec)
• .xls (only specs whose item type is Instrument)
To edit a specification in an external application, you need to save the specification in
a format that the external application supports. You can export specifications
individually or in batch mode. You can export specification data to the following
specifications:
• External Editor (supplied with the SmartPlant Instrumentation

software package) — Supports working with spec data saved in .isf
format, allows you to convert .psr files to .isf format, and import data
from .isf files to SmartPlant Instrumentation.
• InfoMaker — Supports working with spec data saved in .psr format,
does not allow you to import data from .psr files. You first need to
convert .psr files to .isf format in External Editor.
• Excel — Supports working with spec data saved in .xls format., does
not allow you to import data from Excel files back to SmartPlant
Instrumentation.
Related Topics
• Save as Excel: An Overview, page 908

Specifications
Save, Export, and Import Options Common Tasks

Use the following tasks to save specs in .isf, .psr, or .xls format one by one or in batch
more. Also, these tasks enable you to import data to specs using External Editor.
Save a Spec in PSR Format

Use this procedure to save a single specification in .psr format for opening in
InfoMaker. You cannot work with .psr files in External Editor. However, in External
Editor, you can then convert .psr files to .isf format, and edit the specification data as
you require. For more information, see Save a Spec in PSR Format, page 902.
Save an Instrument Spec in ISF Format

Use this procedure to save an instrument specification document in .isf format so that
you can open it in External Editor, which is supplied with SmartPlant
Instrumentation. You can use External Editor to view and edit specifications. After
editing, you can import the changed data back into your specs in SmartPlant
Instrumentation. For more information, see Save an Instrument Spec in ISF Format,
page 903.
Save Instrument Specs in Batch Mode

Use this procedure to save a group of selected instrument specifications. You can
save a batch of instrument specs either as .psr files or .isf files. If you choose to the
.psr format, you can then open the .psr files in InfoMaker. Saving specs in .isf format
allows you to edit the specs in External Editor, which is supplied with SmartPlant
Instrumentation. For more information, see Save Instrument Specs in Batch Mode,
page 903.
Save an Instrument Spec in Excel Format

Use this procedure to save a currently open instrument specification in Excel format.
For more information, see Save an Instrument Spec in Excel Format, page 904.
Batch Save of Instrument Specs in Excel Format

Use this procedure to select a group of instrument tags and save their specifications in
Excel format. For more information, see Batch Save of Instrument Specs in Excel
Format, page 904.
Protect Fields Before Exporting Specs to External Editor

Use this procedure to protect all or specific fields whose values you do not want to be
available for editing in External Editor. After you save the spec as an .isf file, and
open it in External Editor, the fields that you protected appear as view-only. For
more information, see Protect Fields Before Exporting Specs to External Editor, page
905.

Specifications
Import Data to a Specification from an External File

Use this procedure to import data from an external specification file in .isf format to
the current specification. If the format of the external specification is .psr, you can
use External Editor to convert the files to .isf format. The external specification must
be based on the same form as the target specification. If you attempt to copy data
from a specification based on a different form, the software displays an appropriate
message. For more information, see Import Data to a Specification from an External
File, page 906.
Import Data to Instrument Specs in Batch Mode

You can import data from external files to instrument specifications in batch mode.
You need to specify a source file folder and then select the .isf files from which you
want to import data. The software imports data to instrument specifications by
matching the tag numbers in the source .isf files and target specifications that exist in
SmartPlant Instrumentation. SmartPlant Instrumentation does not support importing
data in batch mode to multi-tag (see list) specs. For more information, see Import
Data to Instrument Specs in Batch Mode, page 907.
Related Topics
• Save, Export, and Import Options: An Overview, page 900
Save a Spec in PSR Format

1. Open a specification.
2. Click Actions > Save As.
3. Select Original, and click OK.
4. In the dialog box that opens, under Save as type, select PowerSoft Report (PSR)
format (*.PSR).
5. Select the folder where you want to save the files, type the name of the target .psr
file, and click Save.
Related Topics

Specifications
Save an Instrument Spec in ISF Format

1. Open an instrument specification that you want to save in .isf format.
2. Click Actions > Export Data.
3. In the Save to File dialog box, select the folder where you want to save the files.
4. Enter the target file name, and click Save.
Note
• SmartPlant Instrumentation does not support saving non-instrument
specifications in .isf format.
Related Topics
Save Instrument Specs in Batch Mode

1. Open the Specifications module, and click Actions > Save as Files.
2. In the Save as Files dialog box, under Select file format, do one of the following:
• Select ISF to save the files in .isf format for opening in External
Editor.
• Select PSR to save the files in .psr format for opening in InfoMaker.
3. Click Browse.
4. In the Select Folder dialog box, specify a desired folder, and click Save.
5. Click Find.
6. In the Find Items dialog box, define search parameters as you require and click
Find to display a list of tags according to the search parameters.
7. Select one or more tags and click OK to return to the Save as Files dialog box.
8. In the Save as Files dialog box, click OK.
Note
• Saving specifications as .psr or .isf files in batch mode is only
available when the specification item type is Instrument.
Related Topics

Specifications
Save an Instrument Spec in Excel Format

1. Open an instrument specification.
2. Click Actions > Save as Excel.
Tip
• In the generated Excel files, graphic elements within title blocks
display as designed. SmartPlant Instrumentation does not support
export of other graphic elements to Excel format.
Related Topics
• Batch Save of Instrument Specs in Excel Format, page 904
Batch Save of Instrument Specs in Excel Format

1. In the main window of the Specifications module, click Actions > Save as Excel.
2. In the dialog box that opens, find specs that you want to save in Excel format.
3. In the Search results data window, select the instrument tags whose specs you
want to save in Excel format.
Tips
• After you install a new SmartPlant Instrumentation version or service
pack, if you previously saved specifications in Excel format, rename
the previous result files or move them from the target folder. You can
change the default settings for the target folder, on the Preferences >
Specifications > Save as Excel tab.
• If you previously saved specs in Excel format, and do not want to
overwrite existing result files, you should rename the previous files or
move them from the target folder.
•If you previously saved multi-tag specifications in Excel format and
then made changes to the format upon which these specifications are
based, you should rename the previous result files or move them from
the target folder before exporting further specifications based on that
format.
4. Click OK to start exporting the spec data to Excel.
Tips
• In the generated Excel files, graphic elements within title blocks
display as designed. SmartPlant Instrumentation does not support
export of other graphic elements to Excel format.

Specifications
• Specifications sharing a common form are saved in a common Excel

file. For example, specs based on form 11 might be saved in file
T_Form11_0.xls. To set the preferences to create an individual Excel
file for each spec, on the Preferences > Specifications > Save as
Excel tab, under Saving method, select Separate file for each tag.
Related Topics
• Save an Instrument Spec in Excel Format, page 904
Protect Fields Before Exporting Specs to External Editor

1. On the Specifications module toolbar, click to open the Spec Data
Dictionary.
2. In the Select Specification Form dialog box, select the form for which you want
to set field protection, and click OK.
3. On the Spec Data Dictionary toolbar, click to open the Field Properties tab.
• To protect individual fields, on the Column Headers tab, under
Editable in IEE, clear the check boxes for the fields you want to
protect.
•To protect all of the fields belonging to a given database table, click
the Tables tab, and then, under Editable in IEE, click No.
Note
• You perform this procedure at the form level. This means that the
fields that the field protection applies to any instrument specification
based on this form. Field protection does not apply to existing specs
saved as .isf files.
Related Topics

Specifications
Import Data to a Specification from an External File

Important
When you importing data to an existing spec, the software can
•
overwrite existing data. To prevent all automated overwriting of
existing specification data, in the Preferences dialog box, under Data
copying options, select Copy without overwriting existing data.
Also, in the Spec Data Dictionary, you can set fields as unavailable
for editing in the form data template or in specs based on the current
form.
1. Open a specification in the specifications module.
2. Click Actions> Import Data.
3. In the Open File dialog box, select the source .isf file.
4. Click Open to import the data from the source file to the specification.
Tip
If the imported data includes manufacturers and models that do not
•
appear in the Instrument Manufacturer or Instrument Model supporting
tables, the software automatically adds them during the import
process.
5. Edit the specification as necessary and then click to save the changes.
Related Topics

Specifications
Import Data to Instrument Specs in Batch Mode

1. In the Specifications module, click Actions > Import Data.
2. Beside Source folder, click Browse to specify the folder where the source .isf
files are located.
Tip
• In the Log file name and path box, the software displays the default
path of the log file IMPORT_ISF.LOG. SmartPlant Instrumentation
creates this file after importing data. If you previously imported data,
this log file already contains records of the previous import session. If
you do not change the log file path for the current import session, the
software adds new records of the current import session in the same
file. To create a new file IMPORT_ISF.LOG, you can click Browse
and specify a different log file path.
3. Under Select source files, select the desired .isf files.
Tips
• When you importing data to an existing spec, the software can
overwrite existing data. To prevent all automated overwriting of
existing specification data, in the Preferences dialog box, under Data
copying options, select Copy without overwriting existing data.
Also, in the Spec Data Dictionary, you can set fields as unavailable
for editing in the form data template or in specs based on the current
form.
• If you select Ignore form ID in database, the software imports data
into specifications even when in the source and target specifications,
the internal ID numbers of the specification form are different.
4. Click Import.
Related Topics

Specifications
Save as Excel: An Overview

You can use SmartPlant Instrumentation Save as Excel options to save specifications
in Microsoft Excel format. You can then use any of the Excel functionalities to edit
the exported specifications. The software allows you to save all specs that share a
common spec form to a single Excel file. For example, you can save specifications
based on form 11 in file T_Form11_0.xls. If needed, you can set the Save as Excel
preferences so that you can create an individual Excel file for each specification. The
default target folder is <SmartPlant Instrumentation home
folder>\SaveAsExcel\ResultFiles. You can specify a different path and folder by
changing the Save as Excel preferences.
The Excel workbook opens displaying the specification with the lowest tag number.
If the file that you opened contains multi-page specs, each page is displayed on a
separate Excel worksheet. If you exported multi-tag specifications, the multi-tag list
is displayed on the Excel See List worksheet. The notes are displayed on the Excel
Notes worksheet.
Note
• In Excel XP, you need to set macro security to Medium.
Supported Spec Types
You can only use Save as Excel options with specs whose item type is Instrument
(single-tag or multi-tag specs). SmartPlant Instrumentation does not support Save as
Excel options for specs whose item type is other than instrument, or whose form
contains page sections.
Note
• If you previously saved multi-tag specifications in Excel format and
then made changes to the format upon which these specifications are
based, you should rename the previous result files or move them from
the target folder before exporting further specifications based on that
format.
Font Style
Regardless of the font of the original specification, SmartPlant Instrumentation
selects the Arial font in the Excel target file.
Graphics and Other Embedded Objects

In general, graphic elements within title blocks like those in library forms display as
designed when saved for Excel. SmartPlant Instrumentation does not support export
of other graphic elements to Excel format. SmartPlant Instrumentation does not
support export of embedded objects to Excel, for example, equations.

Specifications
Related Topics
• Batch Save of Instrument Specs in Excel Format, page 904
• Customizing Specs for Save as Excel Common Tasks, page 910
• Save an Instrument Spec in Excel Format, page 904
• Save as Excel Troubleshooting, page 920

Specifications
Customizing Specs for Save as Excel Common

Tasks
Before you save a specification in Excel format, you need to check the source spec
for elements that can cause various display problems in Excel. The following topics
describe how to customize your spec page to avoid display some of possible displays
problems in Excel.
Guidelines for Customizing Pages for Save as Excel

In general, specs based on SmartPlant Instrumentation library pages export accurately
to Excel. However, if you want to save specs in Excel format, you might need to
familiarize yourself with the following guidelines, that enable you to fine-tune you
spec pages and save specs accurately in Excel format. After you create forms and
specifications based on such pages, you can then save these specs accurately in Excel
format. For more information, see Guidelines for Customizing Pages for Save as
Excel, page 912.
Guidelines for Customizing PSR Files for Save as Excel

In general, specs based on SmartPlant Instrumentation library pages export accurately
to Excel. When you customize .psr pages in InfoMaker, use these guidelines for
compatibility with Excel. After you import such pages into SmartPlant
Instrumentation, include them in a form, and generate specs based on this form, you
can then save these specs accurately in Excel format. For more information, see
Guidelines for Customizing PSR Files for Save as Excel, page 914.
Create an Invisible Vertical Zero Line

Use this procedure to open a spec page in InfoMaker and create an invisible vertical
grid line for which the X values are 0. If a form upon which specifications are based
contains vertical fields, it must fulfill one of the following two conditions for correct
export to Excel:
• The X values of the left-hand vertical grid line must be 0.

• You create an invisible line for which the X values are 0.
Modifying a form to fulfill either of these conditions can also improve the display of
other features, for example, select lists. For more information, see Create an
Invisible Vertical Zero Line, page 916.
Replace Double Lines with Thick Single Lines

There are several situations in which a particular choice of line elements within a
form yields non-standard Excel spreadsheets following a Save as Excel operation.
Use this procedure if your specification is based on a form that contains double grid
lines. Use of double lines instead of single thick lines can cause a display problem in

Specifications
Excel. For more information, see Replace Double Lines with Thick Single Lines,
page 917.
Correct a Line Discontinuity

In general, a spec page is divided into three side-by-side components — parameter
categories, field headers, and field values. For correct translation to Excel, perform
this procedure so that a horizontal row line that spans more than one vertical
component becomes a continuous line rather than separate lines with imprecise
continuity. For more information, see Correct a Line Discontinuity, page 917.
Correct Horizontal and Vertical Divergence of Grid Lines

Use this procedure to correct horizontal and vertical divergence of grid lines. Lines
that are not exactly horizontal or lines that are not exactly vertical can be sources of
display problems when you save SmartPlant Instrumentation specifications in Excel
format. For more information, see Correct Horizontal and Vertical Divergence of
Grid Lines, page 918.
Set Value Display Precision for Save as Excel Globally

Use this procedure to set the number of decimal digits that you want to display in the
Excel cells after saving specs in Excel format. The default global Save as Excel
precision is two decimal places. In general, process data and calculation values that
SmartPlant Instrumentation stores in the database are of greater precision than the
values that Excel displays in the cells of generated specs. You perform this procedure
in SmartPlant Instrumentation. For more information, see Set Value Display
Precision for Save as Excel Globally, page 918.
Set Value Display Precision for Individual Fields

Use this procedure to override the global precision for individual fields in a particular
spec page. In general process data and calculation values that SmartPlant
Instrumentation stores in the database are of greater precision than the values that
Excel displays in the cells of generated specs. When you save a specification as an
Excel file, SmartPlant Instrumentation reformats the display precision for Excel. The
default global Save as Excel precision is two decimal places. You perform this
procedure in InfoMaker. For more information, see Set Value Display Precision for
Individual Fields, page 919.
Related Topics

Specifications
Guidelines for Customizing Pages for Save as Excel

Graphic Limitations of the Excel Environment
The Page Editor of SmartPlant Instrumentation allows you freedom in designing
specification pages, with few limitations on the layout of data fields, fields with
computed values, text fields, and lines. But when designing pages for Excel
compatibility, it is important to keep in mind that an Excel worksheet is basically a
grid of cells. Although a standalone Excel spreadsheet supports random placement of
text, value, and line objects, Save as Excel works best if you imagine an Excel grid
underlying your page.
Fine-Tuning the Grid and Lines

Although you can use the mouse to create and place lines, you must fine-tune the grid
by referring to the Line Position pop-up window for each line object. After you set
the major lines of the page grid, you can insert database fields, computed fields, text
fields, and lines. Verify the following:
• All lines are either exactly vertical lines or exactly horizontal.

• For every vertical line, BeginX = EndX.
• For every horizontal line, BeginY = EndY.
• Left/right external border lines share common BeginY (top) and EndY
(bottom) values.
• Top/bottom external border lines share common BeginX (left end) and
EndY (right end) values.
• When one line ends by running into another, make sure that they share
an X value or a Y value. This prevents overshooting and
undershooting.
• Create as much of the grid as possible before creating text and value
objects.
• Although there is no requirement for every line to run the entire length
or width of the page, imagine an Excel grid underlying your page. For
example, if you inserted a vertical line near the top of the page at X =
500 PBU, if your mouse placement of a vertical line near the bottom of
the page ended up at X = 505, make the X values consistent for both
lines.
• Similarly, if you inserted a horizontal line towards the left of the page
at Y = 700 PBU, if your mouse placement of a horizontal line towards
the right of the page ended up at Y = 705, make the Y values
consistent for both lines.

Specifications
Left-Aligning Fields to Lines

During the process of export from SmartPlant Instrumentation to Excel, the software
associates each field with a vertical line to the left of the field. To display the lines
accurately, make sure the BeginX value of a field should equal the X values of the
line to its left.
Fine-Tuning Adjacent Fields

• To prevent text cut-off, leave at least 5 PBU between adjacent fields.
The requirement to left-align fields to lines also applies to fields to the
right of other fields.
• For multiple fields between horizontal lines, set constant BeginY and
EndY values for all of the fields. The BeginY value should be several
PBU greater than the Y values of the line above, and the End2 value
should be several PBU less than the Y values of the line below.
Related Topics
• Guidelines for Customizing PSR Files for Save as Excel, page 914

Specifications
Guidelines for Customizing PSR Files for Save as Excel

Graphic Limitations of the Excel Environment
InfoMaker allows you to modify existing SmartPlant Instrumentation spec pages,
with few limitations on the layout of text, value, line, and other objects. When
designing InfoMaker pages for Excel compatibility, it is important to keep in mind
that an Excel worksheet is basically a grid of cells. Although a standalone Excel
spreadsheet supports random placement of text, value, and line objects, Save as Excel
works best if you imagine an Excel grid underlying your InfoMaker page. You
cannot create an entirely new page in InfoMaker.
Fine-Tuning the Grid and Lines

Although you can use the mouse to create and place lines, you must fine-tune the grid
by referring to the Properties > Position tab for each line object. Verify the
following:
• All lines are either exactly vertical lines or exactly horizontal.

• For every vertical line, X1 = X2.
• For every horizontal line, Y1 = Y2.
• Left/right external border lines share common Y1 (top) and Y2
(bottom) values.
• Top/bottom external border lines share common X1 (left end) and X2
(right end) values.
• When one line ends by running into another, make sure that they share
an X value or a Y value. This prevents overshooting and
undershooting.
• Create as much of the grid as possible before creating text and value
objects.
• Although there is no requirement for every line to run the entire length
or width of the page, imagine an Excel grid underlying your
InfoMaker page. For example, if you inserted a vertical line near the
top of the page at X = 500 PBU, if your mouse placement of a vertical
line near the bottom of the page ended up at X = 505, make the X
values consistent for both lines.
• Similarly, if you inserted a horizontal line towards the left of the page
at Y = 700 PBU, if your mouse placement of a horizontal line towards
the right of the page ended up at Y = 705, make the Y values
consistent for both lines.

Specifications
Left-Aligning Fields to Lines

After you set the major lines of the page grid, you can insert data fields and field
headers, computed fields, fields displayed as select lists, check boxes, or option
buttons. During the process of export from SmartPlant Instrumentation to Excel, the
software associates each field with a vertical line to the left of the field. To ensure
accurate display, the X1 value of a field should equal the X values of the line to its
left. The following lines are acceptable:
• A visible vertical line on the left edge of the field

• A visible vertical line, with X value equal to the X1 value of the field,
but on a higher or lower part of the page
• A vertical grid line, with X value equal to the X1 value of the field,
and on the Properties > General tab, the Visible check box is cleared.
Even for such an invisible line, imagine an Excel grid underlying your
InfoMaker page. For example, if you inserted an invisible vertical line
in one part of the page at X = 500 PBU, if your field placement at
another part of the page ended up at X1 = 505, make the X values
consistent for both lines. For each invisible line, make sure that the
icon to the right of Visible is displayed as . If the icon is displayed
as , click it, and in the dialog box that opens, delete the contents of
the Expression pane, and then click OK.
Fine-Tuning Adjacent Fields
• To prevent text cut-off, leave at least 5 PBU between adjacent fields.
The requirement to left-align fields to lines also applies to fields to the
right of other fields.
• For multiple fields between horizontal lines, set constant Y1 and Y2
values for all of the fields. The Y1 value should be several PBU
greater than the Y values of the line above, and the Y2 value should be
several PBU less than the Y values of the line below.
Related Topics

Specifications
Create an Invisible Vertical Zero Line

1. In SmartPlant Instrumentation, save a spec page as a .psr file.
2. Open the .psr file in InfoMaker.
3. On the menu bar, click Insert > Control > Line.
4. On the General tab of the Properties dialog box, do the following:
a. Under Name, type l_coordinator.
b. Clear the Visible check box.
5. Make sure that the icon to the right of Visible is displayed as . If the icon is
displayed as , click it, and in the dialog box that opens, delete the contents of
the Expression pane, and then click OK.
6. On the Position tab, type the following settings:
a. X1: 0
b. Y1: 0
c. X2: 0
d. Y2: Type a value equal to or greater than the highest Y2 value on the form.
7. On the menu bar, click File > Save.
8. Import the page back into SmartPlant Instrumentation.
9. Regenerate the spec page and specification, and save the specification again in
Excel format.
Related Topics
• Open a Page from an External File, page 793
• Save a Page as an External File, page 795

Specifications
Replace Double Lines with Thick Single Lines

3. Click the duplicate line, and then press the Delete key.
4. Right-click the remaining line, and on the shortcut menu click Properties.
5. On the General tab of the Properties dialog box, under Pen Width, use the
spinners to set the new width of the line.
Excel format.
Related Topics
Correct a Line Discontinuity

3. Right-click the right-most line segment, and on the shortcut menu, click
Properties.
4. On the Position tab, under X2, copy the value to the Clipboard, using a standard
Microsoft shortcut (for example, Ctrl+C).
5. For each line segment to the right of the left-most segment, click the line segment,
and then press Delete.
6. Right-click the left-most line segment, and on the shortcut menu, click
Properties.
7. On the Position tab, under X2, paste the Clipboard value, using a standard
Microsoft shortcut (for example, Ctrl+V).
Excel format.
Related Topics

Specifications
Correct Horizontal and Vertical Divergence of Grid Lines

3. To correct a horizontal divergence, do the following:
a. Right-click the divergent line, and on the shortcut menu click Properties.
b. On the Position tab of the Properties dialog box, set the value under X1
equal to the value under X2.
4. To correct a vertical divergence, do the following:
a. Right-click the divergent line, and on the shortcut menu click Properties.
b. On the Position tab of the Properties dialog box, set the value under Y1
equal to the value under Y2.
Excel format.
Related Topics
Set Value Display Precision for Save as Excel Globally

1. In SmartPlant Instrumentation, click File > Preferences > Specifications > Save
as Excel.
2. Under Accuracy level, enter the number of decimal digits that you want to
display in specs you save in Excel format.
3. Regenerate the Excel files for specs that you require.
Tips
• If you want to set value display precision for a specific field, you need
to open the spec page in InfoMaker, and then reformat the appropriate
field as needed. For details, see Set Value Display Precision for
• You can also reformat individual fields in the Excel sheet, setting the
appropriate number of decimal places. However, you need to reformat
these fields each time after saving this SmartPlant Instrumentation
specification in Excel format.
Related Topics

Specifications
Set Value Display Precision for Individual Fields

3. For each field that you want to format, do the following to set the number of
decimal places that are displayed in SmartPlant Instrumentation and later in
Excel:
a. Click in the field.
b. On the Format tab of the Properties dialog box, under Format, type 0.
followed by pound signs (#) to indicate the required number of decimal
places. For example, 0. indicates no decimal places, 0.# indicates one decimal
place, 0.### indicates three decimal places, and so forth.
4. On the menu bar, click File > Save as File.
5. On the Select File Name dialog box, type the file name that you require.
Excel format.
Related Topics

Specifications
Save as Excel Troubleshooting

After saving a specification in Excel format, scan the resulting file for display errors.
The following list describes how to troubleshoot some of the possible errors. .
Resolve Spec Accessing Problem in a Common Excel File

Use this procedure to be able to access every spec successfully after saving multiple
specs in a common Excel file. The procedure deals with changing Excel macro
security to Medium. If you are running Excel XP, macro security is set to High by
default. For more information, see Resolve Spec Accessing Problem in a Common
Excel File, page 922.
Remove the Protection from a Spec Saved as Excel

Use this procedure to remove the protection from a spec; For more information, see
Remove the Protection from a Spec Saved as Excel, page 923.
Resolve a Data Saving Problem

Use this procedure if you receive an error message stating that you "cannot save
data... incorrect syntax" when you try to save specs in Excel format. This problem
can occur if your specifications are based on pages arranged with the text headers
above the fields, rather than in separate vertical groupings. You can use a headers-
above-fields style, and avoid the error message by editing the x-coordinates of either
the text headers or the fields to creating microscopic misalignment. This procedure
deals with editing the text headers. After editing in InfoMaker, your pages can
support specifications that you save in Excel format. For more information, see
Resolve a Data Saving Problem, page 923.
Resolve Grid Line Overlap Problems

This topic provides a solution you need to implement in InfoMaker when labels and
values overlap lines above or below. For more information, see Resolve Grid Line
Overlap Problems, page 923.
Correct Undershooting and Overshooting of Grid Lines

Use this procedure to correct grid line display problems caused by correcting
imperfect meeting of the outermost grid lines in the source spec page. You can use
this procedure to correct undershooting, when the lines do not meet, and
overshooting, when at least one of the lines extends beyond the meeting point. For
more information, see Correct Undershooting and Overshooting of Grid Lines, page
924.
Prevent Truncation of Labels and Values

This topic provides a troubleshooting solution you need to implement in InfoMaker
when the right end of labels and values is displayed cut off. For more information,
see Prevent Truncation of Labels and Values, page 925.

Specifications
Fix Displaced Labels

When you save specifications in Excel format, you may find displaced labels in the
categories column — by default at the left of the page — or in the title block. This
problem can be caused by lack of coordination between the SmartPlant
Instrumentation spec page upon which the specification is based and the row division
in the Excel spreadsheet. You have two options to assign the displaced label to a
row: extend an existing horizontal line to pass above or below the displaced label, or
normalize label coordinates, which you do by assigning to the displaced label the Y-
coordinate of a row that spans the rest of the form. For more information, see Fix
Displaced Labels, page 925.
Fix Text Display in Excel Cells

Use this procedure to fix incomplete display of text in a spec saved as Excel. You
can perform this procedure either in Excel or InfoMaker. Cell content can be
improperly displayed due to the width of the Excel columns. This can occur in the
following situations:
• If the text string in a cell is longer than the width of the cell, and the
cell to the right is empty, the text extends into the adjacent cell.
• If the text string in a cell is longer than the width of the cell, and the
cell to the right is not empty, the overlapping text is cut off.
• If the cell is very narrow, no data appears in the cell. By inserting the
mouse pointer in the cell, you can view the cell contents in the formula
bar.
For more information, see Fix Text Display in Excel Cells, page 927.
Fix Function Conversion Problems

Use this procedure to convert manually those SmartPlant Instrumentation functions
used in the spec into Excel functions if automatic conversion was not successful.
When you save a specification in Excel format, SmartPlant Instrumentation converts
its functions into Excel functions. Where the conversion does not succeed,
SmartPlant Instrumentation enters the calculated result into the relevant cell of the
Excel spreadsheet, and does not display a formula in the formula bar. This problem is
likely to occur if you created your own specification function in InfoMaker. For
more information, see Fix Function Conversion Problems, page 927.
Set Value Display Precision

Use this procedure if you encounter problems in process data or calculation value
display precision in the Excel cells after saving specs in Excel format. In general,
process data and calculation values that SmartPlant Instrumentation stores in the
database are of greater precision than the values that Excel displays in the cells of
generated specs. The default global Save as Excel precision is two decimal places.
Therefore, if you need to display in Excel a precise SmartPlant Instrumentation value,
you need to increase the number of decimal digits for Save as Excel. You can either

Specifications
set values display precision globally, or for individual fields. For more information,
see Set Value Display Precision, page 928.
Fix Display of Vertical Fields

Use this procedure if vertical fields are not displayed correctly the Excel file. If a spec
page upon which specifications are based contains vertical fields, it must fulfill one of
the following two conditions for correct export to Excel:
• The X values of the left-hand vertical grid line must be 0.

• You create an invisible line for which the X values are 0.
If aligning the page grid lines to X = 0 does not solve the problem, you need to trim
and center vertical form fields in InfoMaker. For more information, see Fix Display
of Vertical Fields, page 928.
Fix Display of Select Lists

Use this procedure if select lists are not displayed correctly the Excel file. For more
information, see Fix Display of Select Lists, page 929.
Prepare Problematic Excel Files for Intergraph Support

Use this procedure if you encounter problems that you are unable to solve, and then
contact Intergraph Support. For more information, see Prepare Problematic Excel
Files for Intergraph Support, page 929.
Related Topics
Resolve Spec Accessing Problem in a Common Excel File

1. In Excel, on the menu bar, click Tools > Options.
2. On the Security tab, click Macro Security.
3. On the Security Level tab, click Medium.
4. Click OK to close the Security dialog box.
5. Click OK to close the Options dialog box.
Related Topics

Specifications
Remove the Protection from a Spec Saved as Excel

• With the spec open in Excel, on the menu bar, click Tools >
Protection > Unprotect sheet.
Related Topics
Resolve a Data Saving Problem

1. Save the spec page upon which the specification is based in .psr format.
2. Open the .psr file in InfoMaker, right-click the required text header, and then, on
the shortcut menu click Properties.
3. On the Position tab, under X, increase the previous value by 0.1
4. Repeat this step for every header that is located precisely above its field.
Excel format.
Related Topics
Resolve Grid Line Overlap Problems

1. Open the appropriate spec page in InfoMaker.
2. In InfoMaker, make sure that lines that intersect near problematic fields do not
overshoot. Overshooting occurs when grid lines meet imperfectly, and at least
one of the lines extends beyond the meeting point. If overshooting occurs, see
Correct Undershooting and Overshooting of Grid Lines, page 924
3. If there is no overshooting, make sure that you set constant Y1 and Y2 values for
all of the objects between the lines. The Y1 value should be several PBUs
(PowerBuilder units) greater than the Y values of the line above, and the Y2 value
should be several PBUs less than the Y values of the line below.
Excel format.
Related Topics

Specifications
Correct Undershooting and Overshooting of Grid Lines

3. To correct undershooting or overshooting on the left border, do the following:
a. Right-click the top line or on the bottom line, and on the shortcut menu click
Properties.
b. On the Position tab, under X1, copy the value to the Clipboard, using a
standard Microsoft shortcut (for example, Ctrl+C).
c. Right-click the required horizontal line, and on the shortcut menu, click
Properties.
d. On the Position tab, under X1, paste the Clipboard value, using a standard
Microsoft shortcut (for example, Ctrl+V).
4. To correct undershooting or overshooting on the right border, do the following:
a. Right-click the top line or the bottom line, and on the shortcut menu click
Properties.
standard Microsoft shortcut.
c. Right-click the required horizontal line, and on the shortcut menu, click
Properties.
Microsoft shortcut.
5. To correct undershooting or overshooting on the top border, do the following:
a. Right-click the left-most line or the right-most line, and on the shortcut menu
click Properties.
b. On the Position tab, under Y1, copy the value to the Clipboard, using a
standard Microsoft shortcut.
c. Right-click the required vertical line, and on the shortcut menu, click
Properties.
d. On the Position tab, under Y1, paste the Clipboard value, using a standard
Microsoft shortcut.
6. To correct undershooting or overshooting on the bottom border, do the following:
a. Right-click the left-most line or the right-most line, and on the shortcut menu
click Properties.
b. On the Position tab, under Y2, copy the value to the Clipboard, using a
standard Microsoft.
c. Right-click the required vertical line, and on the shortcut menu, click
Properties.

Specifications
d. On the Position tab, under Y2, paste the Clipboard value, using a standard
Microsoft shortcut.
Excel format.
Related Topics
Prevent Truncation of Labels and Values

3. For accurate export to Excel, fine-tune problematic areas of the page in
InfoMaker according to plumb line principles:
• The X positions of vertical lines and X1 and X2 object positions
should not be used randomly.
• For considerations of graphic design and for compatibility with Excel,
set close values equal.
4. Save the file.
Excel format.
Related Topics
Fix Displaced Labels

1. Open the problematic spec in the Page Editor in SmartPlant Instrumentation and
save it as a .psr file.
3. To normalize label coordinates, do the following:
a. Right-click the field to the right of the displaced label, and on the shortcut
menu, click Properties.

Specifications
b. On the Position tab, under Y, copy the value to the Clipboard, using a
standard shortcut (for example, Ctrl+C).
c. Right-click on the displaced label, and on the shortcut menu, click Properties.
d. On the Position tab, under Y, paste the Clipboard value, using a standard
shortcut (for example, Ctrl+V).
Tip
The value of the Height field on the Position tab can also influence
•
the appearance of the text in Excel. You must enter a height value that
is in proportion to the font size that you set in the Font tab folder.
4. On the File menu, click Save.
Tip
•You only need to perform the following steps if you want to fix
displaced labels by extending an existing horizontal line above or
below the displaced label. These steps deal with extending a line that
runs through the right-hand and the middle column into the left-hand
(categories) column. You can adapt this procedure for other
configurations as well.
5. To extend an existing horizontal line above or below the displaced label, do the
following:
a. Right-click the left-most line (vertical), and on the shortcut menu click
Properties.
standard shortcut (for example, Ctrl+C).
c. Right-click the horizontal line that you want to extend, and on the shortcut
menu, click Properties.
shortcut (for example, Ctrl+V).
e. Click in the main window to view your changes.
Excel format.
Related Topics

Specifications
Fix Text Display in Excel Cells

1. If you want to fix text display directly in Excel, do one of the following:
• In Excel, drag the column borders to accommodate the text.
• In Excel, on the Excel Format Cells dialog box, on the Alignment
tab, select Wrap text.
2. If you want to fix text display directly in InfoMaker, do the following:
a. Open the problematic spec in the Page Editor in SmartPlant Instrumentation
and save it as a .psr file.
b. Open the .psr file in InfoMaker.
c. and increase the width of this column as necessary.
d. On the File menu, click Save.
e. Import the page back into SmartPlant Instrumentation.
f. Regenerate the spec page and specification, and save the specification again in
Excel format.
Related Topics
Fix Function Conversion Problems

1. Open the problematic Excel file.
2. Copy the value of the unknown function from the original cell to a temporary cell.
3. Copy the unknown function from the log file to the original cell.
Tip
• The log files are located in <SmartPlant Instrumentation home
folder>\SaveAsExcel\ResultFiles\. The filenames are created
according to the convention LogFileFormXXX_#.txt, where XXX is
the form number and # relates to the internal change made to the form.
4. In the original cell, modify the exported function to convert it into an Excel
function.
5. Move the mouse pointer outside the cell to display the value of the function.
6. Compare the value displayed in the Excel cell with the value in the source
specification. If the values are identical, this is an indication (but not a proof) that
you have accurately converted the formula.
7. If you succeed in converting the function, delete the contents of the temporary
cell.

Specifications
Tips
• If you resave the same specification in Excel format, to prevent the
software from overwriting your new function, you must rename the
corrected Excel file. You can then copy the formula to future Excel
versions of this specification.
• If the converted formula does not work, restore the original cell
contents from the temporary cell, and then contact Intergraph Support.
Related Topics
Set Value Display Precision

• To set value display precision globally, see Set Value Display
Precision for Save as Excel Globally, page 918.
• To set value display precision for individual fields and override the
global value precision settings, see Set Value Display Precision for
Related Topics
Fix Display of Vertical Fields

3. Right-click a vertical field, and then, on the shortcut menu, click Properties.
4. To verify that a given field diverges from the horizontal, on the Font tab, click the
icon to the right of the Escapement box or . On the dialog box that opens,
in the Expression box, a value of 900, for example, indicates a vertical field.
5. On the General tab of the Properties dialog box, under Alignment, select
Center.
6. If the field is wider than the text, do one of the following to trim the field:
• On the Position tab, under Width, change the value to the minimum
value needed to display the actual text.
In the Design view, use the mouse to change the field width.
•

Excel format.

Specifications
Related Topics
Fix Display of Select Lists

• To fix the display of select lists in Excel, you need to create an
invisible vertical zero line in the problematic spec page. For details,
see, Create an Invisible Vertical Zero Line, page 916.
Related Topics
Prepare Problematic Excel Files for Intergraph Support

1. In SmartPlant Instrumentation, click File > Preferences > Specifications > Save
as Excel.
2. Select Delete temporary Excel files, and click OK.
3. Save the problematic specifications in Excel format.
4. For each problematic specification, send the following files to Intergraph Support:
• From the <SmartPlant\Instrumentation home
folder>\SaveAsExcel\ResultFiles folder send T_Form*.xls and
LogFileForm*.txt (or the <tag number>.xls)
• From the <SmartPlant\Instrumentation home
folder>\SaveAsExcel\DataFiles folder, send Data*.xls and Form*.xls.
Related Topics

Specifications
Specification Report List

The following table shows a description of each Specifications module report that is
available for displaying and printing.
Report Description Note

Specifications by Allows you to print all specs belonging For loop spec or
Item Type to items of a particular item type, or instrument spec report
print specs according to your item generation, you can
selection.. select the current plant
group or all plant
groups available in
your plant structure.
Specifications by Allows you to print specs according to For loop spec or
Form specific forms on which the instrument spec report
specifications are based. generation, you can
select the current plant
group or all plant
groups available in
Specifications by Allows you to print specifications This option allows
Document Number according to specified document you print all existing
numbers. spec belonging to any
item type.
Form Data Allows you to select form data
Templates templates and print a report showing
the form data template data.

Specifications

Spec Forms Allows you to print specific forms. You can set the
software to generate
the report with or
without field names.
The software
generates the report as
the specprn.psr file
and saves this file to
the folder you
specified in the
Temporary folder
path box, on the
General page of the
Preferences dialog
box. If you leave this
box blank, the
software saves the
specprn.psr file to the
SmartPlant
Instrumentation home
folder.
Specifications by Allows you to print specs belonging to For loop spec or
Date items of a particular item type instrument spec report
according to specified date range. generation, you can
select the current plant
group or all plant
groups available in
Spec Form Field Displays the field names and their The field headers are
Report – Per Form respective headers for the forms. displayed as they
appear in the Spec
Data Dictionary.
You can select a
specific form or all
available forms.
Spec Form Field Contains spec form names where a You can select a
Report – Per Field selected field appears. specific field name or
all available field
names.
Spec Form Select Contains a list of fields that appear as
List select lists in the form, with all the
possible values for each field.

Specifications

Spec Form Lists by Contains a list of specification forms You can select one or
Process Function and instrument types associated with more process
the specified process functions. functions. Forms
belonging to a
particular process
function appear on a
separate sheet.
Spec Pages by Contains a list of pages associated with This report only
Form the forms that you select. shows a list of pages
in the form, not the
fields that are used in
the page. Pages used
in a particular form
appear on a separate
sheet.
Print Specs into Allows you to print the specifications Before printing
PDF Files that you select into a common .pdf file. specifications into a
.pdf file, you must
install GNU
Ghostscript or Adobe
Acrobat Distiller and
set it as your report
generator.
Related Topics

Specifications
Printing Specifications and Reports Common Tasks

The following tasks enable you to generate and print various spec-related reports.
Print a Specification Report

Use this procedure to print a report of specifications that are based on the same spec
form. In the procedure topic, the report for specifications according to selected forms
is shown as an example. You need to have access to the Specifications module to
print spec reports. The steps involved in printing most of the Specifications module
reports are similar. For more information, see Print a Specification Report, page 934.
Generate Reports by Date

Use this procedure to set a date range and then generate a report of all spec forms that
underwent changes within this date range. For more information, see Generate
Reports by Date, page 935.
Generate a Report for a Selected Field Name

Use this procedure to generate a Spec Form Field Report for a certain data field that is
in use in spec forms. This report indicates the forms that use this data field, and also
indicates the headers that you assigned to this field in the Spec Data Dictionary for
the various forms. For field headers that you did not edit in the Spec Data
Dictionary, this report prints the headers that appear in the pages that the form
contains. For more information, see Generate a Report for a Selected Field Name,
page 935.
Assign User-Defined Headers for Spec Form Field Reports

Use this procedure to edit form headers or to assign user-defined headers to the data
fields in a selected form. The header changes affect Spec Form Fields reports and
Form Browser views that you create in the Browser module. This procedure does not
affect the display of specifications based on a form that you edit in the Spec Data
Dictionary, nor does this procedure influence printed specifications. For more
information, see Assign User-Defined Headers for Spec Form Field Reports, page
936.
Print the Currently Open Specification

Use this procedure to print out the currently open specification. The Specifications
module preferences that you set on the Preferences dialog box determine how the
software prints specification notes. For more information, see Print the Currently
Open Specification, page 937.
Print Specs into PDF Files

Use this procedure specifications into a single .pdf file, or to individual .pdf files.
Before printing specifications into a .pdf file, you must install GNU Ghostscript or

Specifications
Adobe Acrobat Distiller. For more information, see Print Specs into PDF Files, page
937.
Related Topics
• Specification Report List, page 930
Print a Specification Report

1. Click File > Preferences > General, and make sure you set the SmartPlant
Instrumentation temporary folder path correctly, for example,
C:\Program Files\SmartPlant\Instrumentation\TEMP.
2. On the Specifications Module window menu bar, click Reports > By Forms.
• Click Current Plant Group if you want to print reports for specs
belonging to the current <unit> plant group only.
Click All Plant Groups to be able to print reports for specs that exist
•
in all of the available plant groups in the current plant structure.
4. Select one or more forms and click OK.
5. If prompted, click Yes to preview the report, or click No to print the report
without opening the print preview.
Tips
• By default, the software prompts you to open a print preview. You
can also change this setting on the Preferences dialog box, on the
General page.
• By default, the software prints specification notes on a separate sheet.
You can change this setting on the Preferences dialog box, on the
Specifications > General page.
Related Topics

Specifications
Generate Reports by Date

1. On the Specifications Module window menu bar, click Reports > By Date.
• Click Current Plant Group if you want to print reports for specs
belonging to the current <unit> plant group only.
• Click All Plant Groups to be able to print reports for specs that exist
in all of the available plant groups in the current plant structure.
3. Type or select the required date range in the From and To boxes.
Tip
• Click Today to display the current date in the To box.
4. Click OK to save the date range settings for current report generation.
5. If prompted, click Yes to preview the report, or click No to print the report
without opening the print preview.
Tips
• By default, the software prompts you to open a print preview. You
can also change this setting on the Preferences dialog box, on the
General page.
• By default, the software prints specification notes on a separate sheet.
You can change this setting on the Preferences dialog box, on the
Specifications > General page.
Related Topics
Generate a Report for a Selected Field Name

1. On the Specifications Module window menu bar, click Reports > Spec Form
Field Report – Per Field > Selected Field Name.
2. On the Select Field Name dialog box, select the required data field and click OK.
Tip
• If the list of data fields is long, start typing a field name in the Find
box and the software selects the field name automatically as you type.
3. Click OK and then, if prompted to preview the report, click Yes to open the
report print preview, or No to print the report without opening the print preview.
Related Topics

Specifications
Assign User-Defined Headers for Spec Form Field Reports

1. On the Specifications Module window menu bar, click Edit > Spec Data
Dictionary.
2. In the Select Specification Form dialog box, select a form and click OK.
4. To edit the field headers for Spec Form Field reports, do one of the following:
• On the Field Properties tab, change individual headers by typing a
text string instead of the displayed header.
Change headers in batch mode using another form as a source. To do
•
so, click Copy From, and then, select a source form.
5. To apply existing headers of the current form, do the following:
a. In the form, or on the Field Properties tab, under Header, move the cursor to
the header, and after the cursor changes its shape to , click the header.
b. In the form, double-click the header to display it on the Field Properties tab.
Tips
• If you apply existing headers of the current form, in the form display,
the form fields are marked with a background the cyan background
color. The background color of the currently selected field, for which
you are editing the header, changes to magenta.
• The icon in the Field Properties tab points to the corresponding
header, which is now available for editing.
Related Topics

Specifications
Print the Currently Open Specification

1. On the Specifications > General page of the Preferences dialog box, do one of
the following:
• Select Show notes to include spec notes on the first page of the spec.
• Clear Show notes to omit spec notes from the first page of the spec.
2. On the Specifications > General page of the Preferences dialog box, do one of
the following:
• Select Print notes on a separate sheet to print the spec notes section
on a separate print sheet.
• Clear Print notes on a separate sheet to print the spec notes section
as displayed on the spec.
3. Open a spec and, do one of the following:
• Click Actions > Print.
Related Topics
Print Specs into PDF Files

Important
• Before printing specifications into a .pdf file, you must install GNU
Ghostscript or Adobe Acrobat Distiller. You then open the
Preferences dialog box and on the General tab, select the appropriate
application from the PDF generator list.
1. On the Specifications Module window menu bar, click Reports > Print Specs
into PDF Files.
2. On the Print Specs into PDF Files dialog box, do one of the following:
• Click Print all into one file and then specify the target file name and
path. This allows you to create one .pdf file shared for all
specifications.
• Click Print into individual files and then specify the target folder for
the software to create an individual .pdf file for each specification.
Tip
• When creating individual .pdf file names for item specifications, the
software uses the names of the items as a source. If the item name

Specifications
includes characters other than alphanumeric characters (that is, \-/(#)

and so forth), the software converts them to underscores. The software
retains hyphens and spaces. For example, if the item name is 101-FT-
100\B, the created .pdf file name is 101-FT-100_B.pdf. If the item
name is 12P#20 TYPE E I/OAS (CUSTOM), the created .pdf file
name is 12P_20 TYPE E I_OAS _CUSTOM_.pdf.
3. Click Find.
4. On the Find Items dialog box, find items for which you want to print to
specifications to a .pdf file.
Tip
On the Find Items dialog box, the software only displays items for
•
which specifications already exist.
5. Under Search results, select items whose specifications you want to print into
one or several .pdf files, and then click OK.
6. On the Print Specs into PDF Files dialog box, click OK.
Related Topics

Specifications
Pipe Specs: An Overview

Pipe spec is a specification that defines pipe properties for various process conditions.
In SmartPlant Instrumentation, the term pipe spec denotes a set of requirements for
materials and construction of the pipelines and their components. You can include
this information in a specification that defines various process conditions for a
specific pipe. In SmartPlant Instrumentation, pipe specs are used for references and
as a guideline for design in the areas affected by direct contact with process. These
references include pipeline information in the Process Data module and installation
item details you can display in hook-up drawings.
In a hook-up drawing, you can display all instrument you associate with a particular
pipe spec. You make pipe spec definitions using the Pipe Specs supporting table,
available either from the Instrument Index or Process Data module. After making
your pipe spec definitions, you can assign a pipe spec to one or more lines in the
Process Data or Instrument Index module. Also, you can assign a pipe spec to one or
more instruments in the Browser or Instrument Index module. You do not use the
Specifications module options to generate or manage pipe specs.
You then assign pipe specs to user-defined hook-up item sub-libraries and affect
instrument – hook-up assignment. After assigning a pipe spec to a user-defined sub-
library, when making instrument – hook-up associations, you can only use
instruments that have the source pipe spec data. You cannot use the default sub-sub-
library for pipe spec assignment.
Related Topics
• Pipe Specs Common Tasks, page 940

Specifications
Pipe Specs Common Tasks

The following tasks deal with pipe spec management. Pipe spec is a specification
that defines various process conditions for a specific pipe.
Define or Modify Pipe Specs

Use this procedure to define pipe specs in the Pipe Specs supporting table. You can
perform this procedure either in Instrument Index or process data module. For more
information, see Define or Modify Pipe Specs, page 941.
Assign Pipe Specs to Instruments

You can assign pipe specs to instrument tag numbers in the Browser module or in the
default view of the Instrument Index Standard Browser accessed from the Instrument
Index module. You have to assign pipe specs to tag numbers if you want to use pipe-
spec sub-libraries in the Hook-Ups module and assign the tag numbers to hook-ups.
Prior to assigning pipe specs to instrument tag numbers, you make pipe spec
definitions in the Pipe Specs supporting table, which you can access either from the
Instrument Index or from the Process Data module. In these modules, you can also
assign pipe specs to line numbers. For more information, see Assign Pipe Specs to
Assign Pipe Specs to Lines

Use this procedure to can assign pipe specs to lines. You can then display the pipe
spec definition in the line process data sheet. For more information, see Assign Pipe
Specs to Lines, page 943.
Associate Pipe Specs with Sub-Libraries

Use this procedure to associate one or more pipe specs with user-defined sub-
libraries. After the association, when assigning instruments to hook-ups, you can
only use instruments that have the source pipe spec data. You cannot use the default
sub-library for pipe spec assignment. For more information, see Associate Pipe
Specs with Sub-Libraries, page 944.
Display Pipe Specs Assigned to a Hook-Up Item Sub-Library

Use this procedure to displays pipe specs associated with a specific user-defined
hook-up item sub-library. For more information, see Display Pipe Specs Assigned to
a Hook-Up Item Sub-Library, page 945.
Dissociate a Pipe Spec from Lines

Use this procedure to dissociate a pipe spec from a line. You must perform this
procedure if you need to delete this pipe spec from the Pipe Specs supporting table.
For more information, see Dissociate a Pipe Spec from Lines, page 946.

Specifications
Delete Pipe Specs

Use this procedure to delete a pipe spec from the Pipe Specs supporting table. You
can perform this procedure either in the Instrument Index or Process Data module.
For more information, see Delete Pipe Specs, page 947.
Related Topics
• Pipe Specs: An Overview, page 939
Define or Modify Pipe Specs

Lines.
• On the Process Data Module window toolbar, click to open the
Select Line dialog box..
2. From the Line type list, select a line type.
5. Do one of the following.
• To create a new pipe spec, click New and type the pipe spec name and
description.
• To edit an existing pipe spec, click a field in a selected row and
modify the existing pipe spec name and description as needed.
Related Topics

Specifications
Assign Pipe Specs to Instruments

1. Open the Browser Manager, and then, for the Instrument Index Standard
Browser, define a view that includes the Tag Number and Pipe Spec fields.
2. In the Pipe Spec column, from the select list, select a pipe spec for association
with the instrument whose tag number is displayed in the same row, in the Tag
Number column.
Tips
• You can assign the same pipe spec to more than one instrument but
only one pipe spec per instrument.
• To dissociate a pipe spec from an instrument, from the select list in
Pipe Spec column, select a blank field.
• After you assign tags to hook-ups in the Hook-Ups module, you can
open a view for the Hook-Up Tag List browser. This browser displays
only those tags that are associated with hook-ups. In this browser
view, you can also change the pipe spec associations as you require.
Related Topics
• Assign Pipe Specs to Lines, page 943

Specifications
Assign Pipe Specs to Lines

Lines.
3. Select a line and click Properties.
4. On the Line Properties dialog box, beside the Pipe spec list, click to open the
Pipe Specs dialog box.
5. Select a pipe spec and click OK to assign it to the line.
Tips
• You can now open a process data sheet for this line to display the
assigned pipe spec. If you defined more than one pipe spec in the Pipe
Specs supporting table, you can assign a different pipe spec to the line
from the process data sheet.
• The pipe spec becomes a property of the process data sheet. This
means that you can assign this pipe spec to other lines by copying line
data to other lines. Note, however, that when you copy line data to
instruments, the software does not copy line pipe spec definition to the
instruments.
Related Topics
• Assign Pipe Specs to Instruments, page 942

Specifications
Associate Pipe Specs with Sub-Libraries

1. In the Hook-Up Item Libraries folder of the Reference Explorer, do one of the
following:
• In the tree view pane, expand the hierarchy of an item library and
right-click a user-defined sub-library.
In the tree view pane, select an item library and then, in the Items
•
pane, select one or more user-defined sub-libraries.
2. On the shortcut menu, click Actions > Associate Pipe Specs with Sub-
Libraries.
Tips
• On the dialog box that opens, the software displays all the pipe specs
defined in the Pipe Specs supporting table.
•In the dialog box panes, you can double-click the Pipe Specs column
header in the to sort the items in ascending order. Double-click the
header again to sort the items in descending order.
3. Under Available pipe specs, select one or more pipe specs and do one of the
following:
• Click Associate.
•Drag the selected items to the Associated pipe specs pane.
4. If you selected more than one user-defined sub-library in the Reference
Explorer, click Next to display another sub-library and associate pipe specs as
you require.
Tip
• You can associate the same pipe specs with more than one user-
defined sub-library.
Related Topics

Specifications
Display Pipe Specs Assigned to a Hook-Up Item Sub-

Library
1. Press F7 to open the Domain Explorer, and expand the hierarchy to the hook-up
type level in the Hook-Ups folder.
• In the tree view pane, select a specific hook-up.
• In the tree view pane, select a hook-up type, and then, in the Items
pane, select and right-click one or more hook-ups.
4. On the Hook-Up Properties dialog box, from the Hook-up sub-library list,
select a user-defined hook-up item sub-library.
5. Click Pipe Specs to display pipe specs associated with the user-defined sub-
library that you selected.
Tips
• The Pipe Specs button is only available when the sub-library that you
selected is user-defined.
Related Topics

Specifications
Dissociate a Pipe Spec from Lines

Lines.
On the Process Data Module window toolbar, click
• to open the
3. Select a line and click Properties.
4. On the Line Properties dialog box, in the Pipe Spec column of the data window,
click the pipe spec definition and press the Delete key.
5. Click OK to return to the Select Line dialog box.
Tips
• This procedure only allows you do dissociate a pipe spec from one line
at a time. If you want dissociate this pipe spec from all lines, you can
open the process data sheet for a specific line, make sure that the Pipe
spec box is empty, and then copy line data to other lines.
• You do not delete the pipe spec itself, only dissociate it from the line.
The dissociated pipe spec remains in the Pie Specs supporting table. If
you want to delete a pipe spec permanently, you must delete it from
the supporting table.
• Dissociating a pipe spec from a line does not dissociate this pipe spec
from instruments.
Related Topics
• Delete Pipe Specs, page 947

Specifications
Delete Pipe Specs

Lines.
Select Line dialog box.
5. Select the pipe spec that you want to delete, and click Delete.
6. Repeat the previous step for each pipe spec that you want to delete.
Tip
• You cannot delete a pipe spec that is currently assigned to lines. First,
dissociate the pipe spec from the lines.
Related Topics
• Dissociate a Pipe Spec from Lines, page 946

Document Binder Module

Overview
The Document Binder module is used to gather specifications and other related
SmartPlant Instrumentation documents that need to be maintained together. Each
collection of documents is known as a binder package. You can perform a collective
update for all the documents in a single binder package and assign them the same
revision number. You can specify two types of binder package: Specification Binder
packages and General Document Binder packages. For details of differences between
the binder package types, see Comparison of Binder Package Types.
You can group documents according to any criteria you require. However, for
instrument specification sheets, a given instrument specification may only be
assigned to one Specification Binder package or to any number of General Document
Binder packages, but not to both types of binder packages.
For details of the options available in the tree for each binder package type, see:
• Specification Binder Packages, page 949

• General Document Binder Packages, page 950

Specification Binder Packages

You use Specification Binder packages to create groups of instrument specifications
for whatever purpose you require; for example, when requesting a price quotation
from a vendor for several instruments, you can group the instruments together in a
Specification Binder package and include other relevant documents.
The following folders are available:
• Specification List— This is a cover sheet with instrument tag data for
all the specifications included in the Specification Binder package.
• Form Notes— This contains user notes that apply to specific form
numbers. There must be at least one specification associated with a
particular form number in the Specification Binder package in order
for you to be able to add form notes.
• General Notes— General notes provide a means of adding user
comments that are associated with the Specification Binder package as
a whole.
• Specification Sheets— This category shows the specifications
included in the Specification Binder package, and provides you with
the options to access and edit individual sheets, to totally or partially
revise the sheets in the list, and to print all or some of the sheets.
• Change Summary Report— This shows details of the changes that
were made to the specifications since the last revision.
When the documents are created, each document type is numbered sequentially using
the following method:
• Specification Sheets: S-1, S-2, S-3, and so forth. The pages of a

multi-tag specification are identified by a number with a different
suffix for each page, for example, S-2.1, S-2.2, S-3.1, S-3.2, and so
forth.
• Form Notes— G-1, G-2, G-3, and so forth.
• Change Summary Report— C-1, C-2, C-3, and so forth.
• General Notes— N-1, N-2, N-3, and so forth.
Page numbers are calculated from the relative position of the document in the
Specification Binder package. To recalculate the page numbers after modifying
specifications, click Actions > Repaginate.
Related Topics
• Starting the Document Binder Module, page 951
• Troubleshooting, page 984

General Document Binder Packages

You use General Document Binder packages to create groups of documents for
whatever purpose you require; for example, when requesting a price quotation from a
vendor for several items, you can group the items together in a General Document
Binder package and include other relevant documents.
The following folders are available:
• Document List— This is a cover sheet with data for all the
documents included in the General Document Binder package.
• Document Notes— This contains user notes that apply to specific
document numbers. There must be at least one document associated
with a particular document number in the General Document Binder
package in order for you to be able to add document notes.
• General Notes— General notes provide a means of adding user
comments that are associated with the General Document Binder
package as a whole.
• Documents— This category shows the documents included in the
General Document Binder package, and provides you with the options
to access and edit individual documents, to totally or partially revise
the documents in the list, and to print all or some of the documents.
Related Topics
• Starting the Document Binder Module, page 951
• Troubleshooting, page 984

Starting the Document Binder Module

Note
• Before starting this module, check with the Domain Administrator that
you have been granted appropriate access rights for the tasks you will
carry out.
Start the Document Binder Module

• To open the main Document Binder window, do one of the following:
• On the main toolbar, click .
• Click Modules > Document Binder.

Creating Binder Packages

A binder package is a group of documents or instrument specifications, and may
include additional general notes and form notes. On creation of a new binder
package, the software creates a complete set of folders. The software updates these
folders as you assign documents to the binder package.
Create a New Binder Package

1. Open the Document Binder module. For details, see Creating Binder Packages,
page 952.
2. In the Document Binder window, at the top of the left frame, select Binder
Packages.
3. Click Actions > New Binder Package.
4. On the New Binder Package dialog box, enter the following data:
• The binder package type (required)
• The binder package name (required)
• Description (optional)
• Purchase order number (optional)
• Requisition number (optional)
Tip
• For Specification Binder packages only, if you select Apply purchase
order and requisition number to all tags, the software adds this data
to all tags currently associated with the Specification Binder package.
As long as this checkbox is selected, the software adds this data to
every tag that you associate with the Specification Binder package.
5. Click OK.
Related Topics
• Assigning General Notes to Binder Packages, page 965
• Assigning Instrument Specifications to a Specification Binder
Package, page 953
• Creating Form Notes, page 963
• Editing Binder Package Properties, page 954

Assigning Instrument Specifications to a

Specification Binder Package
After creating a Specification Binder package, you can assign instrument
specifications to it. On assigning a specification, the software automatically updates
the Instrument Specification List. Furthermore, in the browser view, the software
sets the value in the Item Status column to Added for the instrument tags associated
with the newly assigned specification.
Note
• To view information in the right area of the window in greater detail,
in the tree of the Preferences dialog box, expand the hierarchy
Document Binder > Specification Binder and under Select
instrument specification list display, select User-defined columns
from Browser module. When you display detailed data in the right
area of the screen, the software determines the layout according to the
default view in the Spec Binder Package Browser (under the
Document Binder group). You can customize this view in the
Browser module.
Assign an Instrument Specification to a Specification

Binder Package
1. In a Specification Binder package, select the Specification Sheets folder.
2. Click Actions > Assign Specification. The Find Tag dialog box opens, from
which you can retrieve tags. To filter the retrieved tags, enter values in the
selection fields.
3. Click Find to retrieve the list of tags.
4. From the list, select tags to be included in the Specification Binder package and
click OK.
The list of tags appears under the Specification Sheets folder for the
5. To open a specification for viewing or editing, select a sheet from the list and do
• Click Actions > Open.
• Double-click the sheet.
Related Topics
• Creating Binder Packages, page 952

Editing Binder Package Properties

You can rename a binder package and edit its description until the first time you add a
revision to it. After that you can only edit the purchase order number and requisition
number.
Edit Binder Package Properties

1. In the Document Binder window, in the left frame, right-click the binder package
that you want to edit.
2. On the shortcut > Properties.
3. On the General tab, edit the following data as needed:
• Binder package name — after you save at least one revision, this
field is not available.
• Description — after you save at least one revision, this field is not
available.
• Purchase order number.
• Requisition number.
Note
• If you select Apply purchase order and requisition number to all
tags, the software updates all tags currently associated with the binder
package. As long as this checkbox is selected, the software adds this
data to every tag that you associate with the binder package.
4. Click OK.
Related Topics

Removing Instrument Specifications from a

You can remove instrument specifications from a Specification Binder package when
those specifications are no longer required.
Notes
• You can choose whether SmartPlant Instrumentation keeps or deletes
revisions that you saved while the specification was part of the
• On removing a specification, the way in which the specification list is
updated depends on the following:
• If the specification was originally assigned prior to saving the last
revision of the Specification Binder package, the instrument tag still
appears in the specification list browser view, with the Tag Number
column set to Deleted.
• If the specification was originally assigned after saving the last
revision of the Specification Binder package, its tag does not appear in
the specification list.
Choose one of the following options:
• Remove_single
• Remove_several
• Remove_all
Remove a Single Instrument Specification From a

1. In the Document Binder window, in the Binder Packages tree, do the following:
a. Expand the Specification Binder package from which you want to remove an
instrument specification.
b. Select Specification Sheets.
2. In the right pane, select the specification that you want to remove.
3. Click Actions > Remove.

Remove a Selection of Instrument Specifications From a

a. Expand the Specification Binder package from which you want to remove a
specification.
2. Right-click the desired specification sheets, and on the shortcut > Remove
Selected Items.
3. On the Remove Selected Items dialog box, under Select, select the check box
beside each specification that you want to remove.
Tip
• You can select the Select all check box if you want to remove all the
specifications.
Remove All Instrument Specifications From a Specification

Binder Package
a. Expand the Specification Binder package from which you want to remove a
specification.
2. Click Actions > Remove All.
Related Topics
Package, page 953

Deleting a Binder Package

You can only delete a binder package if it has not yet been saved as a revision. In this
case, if the binder package includes specifications, these must be removed first.
Delete a Binder Package

1. Remove any specifications in the binder package you want to delete, for details
see Removing Instrument Specifications from a Specification Binder Package,
page 955.
Tip
• If all specifications with a particular form number are deleted, the form
note associated with that form is automatically deleted.
2. Delete the binder package by doing one of the following:
• Click the right mouse button and on the shortcut > Delete.
Related Topics

Managing Association of External Files with a

Binder Package
Use these procedures to manage external files that you associate with a binder
package. You can associate a new file with the binder package, dissociate a file, or
open an associated file. Associated files can be .doc, .txt, .bmp, .wav, .psr files, or
any file formats that are supported by your Windows system.
For all of the procedures, do the following to open the Associated Documents dialog
box:
1. In the Document Binder window, select the binder package for which you want
to manage external files.
2. Click Actions > Associated Documents.
From the Associated Documents dialog box, you can perform the following
procedures:
Associate an External File With a Binder Package

1. In the Associated Documents dialog box, click Associate.
2. In the Associate External Document dialog box, navigate to the file, and click
Open.
3. In the Associated Documents dialog box, under Description, type a short
description for the associated file.
Open an External File That You Associated With a Binder

Package
• On the Associated Documents dialog box, select the file that you
want to open, and click Open.
Dissociate an External File From a Binder Package

• In the Associated Documents dialog box, select the file that you want
to dissociate from the binder package, and then click Dissociate.
Related Topics
Package, page 953

Notes
There are three classes of notes that you can add to a binder package:
• Form Notes — A form note is associated with a particular form in a

Specification Binder package, and is used, for example, to indicate the
purpose of certain fields in the form.
• Document Notes— A document note is associated with a particular
document type in a General Document Binder package, and can be
used, for example, to indicate the purpose of certain fields in the
document.
• General Notes — A general note can appear in a Specification
Binder package or in a General Document Binder package and is
associated with the binder package as a whole.
Related Topics

Creating Form Note Templates

Form note templates are source forms used to create form notes.
Create a Form Note Template

1. Click Actions > Form Note Templates.
2. On the Form Note Templates dialog box, click New.
3. On the New Form Note Template dialog box, enter a name for the note template
(required) and description (optional) as follows:
a. Select a form from the Form list or click Select and select a form from the list
that appears.
The Template and Description fields are automatically filled with the
form or template name and description (if one exists).
b. If desired, overwrite the name displayed in the Template field. (a required
field.)
c. Enter text in the Description field if desired.
Note
• Form note template names must be unique.
4. Click OK.
Related Topics
• Deleting Form Note Templates, page 962
• Editing Form Note Templates, page 961

Editing Form Note Templates

Form note templates are source forms used to create form notes in the Document
Binder module. Use this procedure to edit form note templates.
Edit a Form Note Template

1. On the Form Note Templates dialog box, select the desired template.
2. Click Edit Text.
3. In the Note Editor window, edit the note name, description, and note text as you
desire.
Caution
• The text editor only allows you to paste text from the clipboard. You
can copy text from other text editors or word processing applications,
for example, Notepad or Microsoft Word. However, any formatting in
the original document will be lost when you paste the text into this
field. You should not attempt to paste graphics images, as this may
cause problems in the file later.
4. When done, click .
Related Topics
• Creating Form Note Templates, page 960
• Deleting Form Note Templates, page 962

Deleting Form Note Templates

Form note templates are source forms used to create form notes. Use this procedure
to delete form note templates.
Delete a Form Note Template

1. Click Actions > Form Note Templates.
2. On the Form Note Templates dialog box, select the required template and click
Delete.
3. Click Yes to delete the note.
4. Click Close to close the window.
Related Topics

Creating Form Notes

Form notes are notes that are attached to a particular form. They can be used, for
example, to indicate the purpose of certain fields in the form where this is not clear to
the user. They can also be used to provide vendors with your standard company
specifications. Form notes may only be added for the forms with which the
specification is associated. Consequently, if you remove all the specifications
associated with a particular form from the Specification Binder package, the form
notes for that form are deleted.
Create a Form Note

1. In the left pane, select the Form Notes folder.
2. Click Actions > New Form Note.
3. On the New Form Note dialog box, enter a name for the form note (required) and
description (optional) as follows:
a. Create a form note based on a form by selecting a form from the drop-down
list in the Form field or by clicking Select and selecting a form from the list
that appears.
• If any form note templates have been defined for the form you
selected, you can base the form note on one of these templates if
desired.
b. To base the form note on a template, select it from the Template list or click
Select and select the desired template.
Tip
• Selecting a form note template not only copies the name and
description to the form note but also uses the note text in the
template as default. For details of defining form note templates.
For details see Creating Form Note Templates, page 960.
• The Form note and Description fields are automatically filled
with the form or template name and description (if one exists),
which overwrite the previous entries.
c. If desired, overwrite the name displayed in the Form note field (required
field).
d. Enter text (optional) in the Description field if desired.
Tip
• The names of form notes must be unique.
e. Click OK to open the Form Note Editor dialog box.

Tip
• If you selected to create a form note from a template, any note text
that was entered for the template will appear by default in the note
field.
f. Make any changes as required to the note name, the description, and the note
text itself.
Caution
•The text editor only allows you to paste text from the clipboard.
You can copy text from other text editors or word processing
applications, for example, Notepad or Microsoft Word, however,
any formatting in the original document will be lost when you
paste the text into this field. You should not attempt to paste
graphics images as this may cause problems in the file later.
g. When done, click .
Related Topics
• Editing Binder Package Notes, page 966

Assigning General Notes to Binder Packages

General notes apply to an entire binder package, which can be either a Specification
Binder package or a General Document Binder package.
Assign a General Note to a Binder Package

1. Click the General Notes folder.
2. Click Actions > New General Note.
The Note Editor window opens, with the default general note name [New].
3. Change the name of the note from the default, enter a description (optional), and
type the desired note text.
Caution
field. You should not attempt to paste graphics images as this may
Related Topics

Editing Binder Package Notes

After creating a note, you can edit the name, description, and note text if desired.
Edit a Note
1. Select one of the following folders:
• Form Notes.
• Document Notes.
• General Notes.
• Click Actions > Open to open the Note Editor window. (Continue at
step 3.)
• Expand the folder by double-clicking it. (Continue at step 4.)
3. Select the desired note from the list in the dialog box and click OK.
The Note Editor window opens. (Continue at step 5.)
4. Open the Note Editor window as follows:
a. Select the required note in the tree.
b. Do one of the following:
• Double-click the note.
• Click Actions > Open.
5. Edit the note name, description, and note text as required.
Caution
field. You should not attempt to paste graphics images as this may
Related Topics

Specification Binder Package Revisions

You can revise a set of specifications and notes in a Specification Binder package, for
example, before printing a request for quotation from a vendor. Once you assign a
specification to a Specification Binder package you may only create revisions to that
specification as part of the Specification Binder package from the Document Binder
module.
In general, the software allows you to save a revision only for documents that you
have changed and saved. You are also allowed to save a revision in the following
situations:
• If a specification has been newly-assigned to the binder package or if

you have modified a specification for which a revision was already
generated in the binder package.
• If you manually modified the Changed status of a document from No
to Yes.
• If you removed an instrument specification from a Specification
Binder package. For details, see Removing Instrument Specifications
from a Specification Binder Package, page 955.
On creating a new revision for a Specification Binder package, documents in the
binder package (Specification List, Form Notes, General Notes, and Change
Summary report) are revised automatically, provided a change notification is set for
at least one specification. Other document revisions are displayed in the title block of
a printed version of these documents.
Notes
• To be able to generate revisions, a Specification Binder package must
have at least one specification assigned to it (if the binder package
contains only general notes, for example, you cannot generate a
revision for it).
• You cannot delete or rename a Specification Binder package once a
revision has been performed on it.
• Before performing a revision in the Document Binder module, verify
that none of the designated documents are open for editing in any other
SmartPlant Instrumentation modules.
• When you perform a revision on a Specification Binder package, the
specifications it contains may be assigned revision numbers that are
actually lower than the number of any revisions that were performed
for the individual specifications before they were assigned to the
binder package.

• The software does not include in the Document Binder module

revisions or documents that you created from the Properties dialog
box for an item, for example, in the Terminal Strip Properties dialog
box.
• You can set the preferences to allow for independent viewing of
specification revisions made before and after incorporation into a
• Before saving a revision, you must first release all instrument tags
associated with the designated specifications from any workflow
assignments. If the System Administrator selected to implement a
workflow option, one of the following conditions applies:
• If Full was selected (which includes workflow for the Document
Binder module), all the specifications in the Specification Binder
package must have the status Release to Spec.
• If Without Document Binder was selected, only those specifications
in the Specification Binder package whose status is PD not required
or Locked from PD can be revised.
Related Topics
• Adding a Revision to a Binder Package, page 969
• Binder Package Revision Archive: An Overview, page 972
• Printing from a Binder Package, page 977

Adding a Revision to a Binder Package

Use this procedure in order to revise the documents in a binder package. There are a
number of conditions restricting adding a new revision. For details, see Specification
Binder Package Revisions, page 967.
Add a Revision to a Binder Package

1. Select the desired binder package.
• Click the right mouse button and on the shortcut > Revisions.
3. On the Revisions dialog box, select one of the revision numbering methods (use
serial revisions).
Tips
P0, P1, P2...). Once you select one of the other revision methods, you
will not be able to return to the preliminary revision method and this
option will be disabled.
• Only the last five revisions appear in the Revisions dialog box.
4. Click New to add new revision data.
5. Add the revision data in the appropriate data fields.
Tip
• The By field contains the current user's initials by default, if
previously defined by the SmartPlant Instrumentation System
Administrator. You can also edit this field. Today's date appears in
the Revision Date field, by default, but you can change it if desired.
6. Click OK to save the revision and close the dialog box.
Tip
• After the revision is saved, the change notifications for all the specs
are set to No. In the browser view, the Tag Status column for
instrument tags associated with specs assigned to or deleted from the
binder package prior to the last revision is cleared.
• An instrument specification that is added to a Specification Binder
package becomes a part of that package and is revised according to the

new Specification Binder package revision number, and not the

previous revision number that applied to the individual instrument
specification.
• If you add a document to a General Document Binder package, and a
revision is made for the package as a whole, you can still add revisions
for the individual drawings in the package without any relation to the
revision number of the package.
Related Topics
• Deleting a Revision from a Binder Package, page 971
• Specification Binder Package Revisions, page 967

Deleting a Revision from a Binder Package

Use this procedure to delete revisions from a given binder package.
Note
• You can set the module preferences for automatic deletion of revisions
when removing a specification from a binder package.
Delete a Revision From a Binder Package

1. In the Document Binder window, highlight the binder package from which you
want to delete a revision.
3. On the Revisions dialog box, select the revision you want to delete, and click
Delete.
4. Confirm the deletion by clicking Yes.
Tip
• Repeat steps 1 – 3 for each revision that you want to delete.
Related Topics
• Removing Instrument Specifications from a Specification Binder
Package, page 955

Binder Package Revision Archive: An Overview

When you create a new revision for a binder package in the Document Binder
module, a view-only archive copy is made of the information contained in the
Specifications, Notes, and Change Summary Report.
The revision archive data can be saved in the database or in a file, depending on the
setting that the Domain Administrator selects in the Administration module.
Related Topics
• Converting Binder Package Revisions to ZIP Files, page 973

Converting Binder Package Revisions to ZIP Files

When you save revisions to the database, the software compresses the data
automatically to save space. To further streamline your database, you can also
remove specification, binder package, and construction revisions from the database
by converting them to .psr or .psr-within-.zip format files, which you save in folders
external to the database. This feature is useful when you have made a large number
of revisions, and want to reduce the size of the active and backup databases.
This procedure describes how to remove binder package revisions from the database
into .zip format files.
Notes
• The Domain Administrator sets the default revision storage method in
the Administration module. This gives you the option of storing
binder package revisions directly to .zip files external to the database.
• As detailed below, you can vary this procedure to convert binder
package revisions back-and-forth among .psr, .zip, and SmartPlant
Instrumentation database format.
Convert Binder Package Revisions to .Zip Format Files

1. Click Actions > Manage Revisions.
2. To display binder packages of one revision only, under Revisions filter, type the
revision number and click Apply.
• In the data window, select the revisions that you want to convert.
• To select all of the displayed revisions for conversion, click Select all.
4. Under Convert revisions to, click ZIP files.
Tips
• To convert revisions to uncompressed .psr format, click PSR files.
• To restore .psr or .zip format files to the database, click Database.
5. Click Convert.
Related Topics
• Binder Package Revision Archive: An Overview, page 972
• Saving Binder Package Documents to a ZIP File, page 981

Change Summary Report

The change summary report allows you to view all the changes that were made to
binder packages since the last time a revision was made. To generate such a report,
you double-click the Change Summary Report folder in the left area of the main
Document Binder window. The report shows a list of the instrument tags that were
modified and are associated with the specifications in the selected binder packages.
For example, in the case of a multi-tag specification, a tag may have been added to
the specification, or deleted from it.
If the tag data was modified, the report will display the following:
• Tag number
• The column where the change was made
• The old and new values for the specific column
• The person who made the change
• The date of change
Notes
• The Change Summary Report uses data stored in the Audit Trail
repository, therefore to enable generation of this report, in the
Administration module Domain Definition window, the Domain
Administrator has to select the Audit trail options check box.
• If changes were made to the main page of a multi-tag spec, each item
in the list will be displayed separately in the report, along with its
changes.
• Before a revision is saved for the first time or if no changes were made
to items in the binder package after a certain revision, a report will not
be generated.

Enabling Specification Changes Notification

When you edit a specification in the Specifications module after adding a revision,
you can set whether to notify the changes in the Document Binder module.
When a notification of the changes to a specification is enabled:
• The revision number of the specification will be incremented the next

time a revision is made to the Specification Binder package to which it
is assigned.
• Changes to the specification appear in the Change Summary Report.
Note
• The Change Summary Report uses data stored in the Audit Trail
repository, therefore to enable generation of this report, in the
Administration module Domain Definition window, the Domain
Administrator has to select the Audit trail options check box.
After a Specification Binder package has undergone a revision, the changes
notification is removed (on the Specification Change Notification dialog box, No
appears under the Changed column for all the specifications), and any documents
associated with it (Specifications, Form Notes, and General Notes) are saved.
Following a revision in the Document Binder module, if you modify a specification in

the Specifications module, when saving the changes, a prompt appears enabling you
to decide whether to notify the changes in the Document Binder module (this prompt
does not appear if the change is already notified for the specification).
The available options are:
• Mark this item as changed — When this option is selected, the

change you made in the Specifications module will also be indicated in
the Document Binder module. In the Specification Change
Notification dialog box, the Changed column for the specification
will display Yes. Consequently, the specification revision number will
be updated the next time you revise the Specification Binder package
to which it is assigned. If any change was made to the specification,
the instrument tags associated with the specification will appear in the
Change Summary Report.
• Do not change existing notification — When this option is selected,
the change will not be notified in the Document Binder module. In the
Specification Change Notification dialog box, the Changed column
for the specification will display No. It is recommended that you select
this option only when the change is minor and you do not want it to be
included in the next saved revision.

Modifying Specification Change Notifications

Manually
You can modify the change notation of specifications in a Specification Binder
package.
Modify the Change Notification of a Specification

1. Select a Specification Binder package.
2. Click Actions > Spec. Change Notification.
3. On the Specification Change Notification dialog box, for the desired
specifications, select the desired option in the Changed column:
• Yes— Notify that the specification has changed.
• No— Notify that the specification has not changed.
Tip
• Where Yes is selected, the specification is revised when the
Specification Binder package is next revised. You can view the
changes in the Change Summary Report.
Related Topics
• Enabling Specification Changes Notification, page 975

Printing from a Binder Package

Use this procedure to print documents from a binder package. You first choose
between current documents on the one hand, and previous revisions on the other
hand. You then specify what to print as follows:
• All the specifications and associated documents of the binder package.

• Changed documents only.
• Only the documents that you select.
Notes
• Your Specifications module preferences also determine preferences for
specifications that you print within binder packages. For more
information, see Document Binder General Preferences.
• You can set font and color for report comparison. For more
information, see Setting Font and Color for Report Comparison, page
90.
Print Documents in a Binder Package

1. Select the binder package for which you want to print documents.
• Click Actions > Print.
• Click the right mouse button and on the shortcut > Print.
3. On the Print dialog box, under Select revision, do one of the following:
• Click Working issue for current files.
• For a previous revision, click Formal issue and select the desired
revision from the Revision list.
4. Under Print what, do one of the following:
• Click All documents in binder package to print all the documents of
the revision you selected, or of the working issue.
• Click Changed documents only to print documents associated with
specifications marked as changed since the previous revision. This
option is available only if you selected Working issue above.
• Click Selected documents to print the specifications and notes of your
choice from the revision you selected, or from the working issue.
5. Select Show print preview to view the documents prior to printing.
6. Click OK.

7. If you clicked Selected documents, the Select Documents dialog box opens.
Highlight the documents that you want to print and click OK.
Related Topics
• Printing from a Binder Package to a PDF File, page 979

Printing from a Binder Package to a PDF File

You can print a set of documents in a binder package as .pdf files. After setting the
path and file name, you choose between current documents on the one hand, and
previous revisions on the other hand. You then specify what to print as follows:

All the documents that you select are saved together in a single .pdf file. When you
open the file — in Adobe Acrobat® for example — you can navigate easily from
one document to the next.
Important
• Before printing binder package documents to a .pdf file, you must
install GNU Ghostscript or Acrobat Distiller. You specify the active
.pdf generator on the Preferences dialog box, General, page Error!
Bookmark not defined. page.
Print From a Binder Package to a PDF File

1. Select the binder package for which you want to print documents to a file.
2. Click Actions > Print to File.
3. On the Print to File dialog box, do one of the following:
• Accept the file path displayed under Path. In this case, the software
will create a unique file name in the currently displayed folder.
• Click and navigate to the folder where you want the software to
save your .pdf files. After selecting this folder, you have the following
File name options:
• Type a file name.
• Select an existing file name from the current folder.
• Leave the File name box blank to let the software create a unique
file name.
4. On the Print to File dialog box, under Select revision, do one of the following:
revision from the Revision name list.
5. Under Print what, do one of the following:

• Click All documents in binder package to print to file all the

documents of the revision you selected, or of the working issue.
• Click Changed documents only to print to file documents associated
with specifications marked as changed since the previous revision.
This option is available only if you selected Working issue above.
• Click Selected documents to print to file the specifications and notes
of your choice from the revision you selected, or from the working
issue.
6. Click OK to print the documents to a .pdf file.
Highlight the documents that you want to print and click OK.
Related Topics

Saving Binder Package Documents to a ZIP File

You can save a set of documents from a binder package to a .zip (compressed) file.
The documents within the .zip file are in the .psr format that the software uses for
saving reports.
After setting the path and file name, you choose between current documents on the
one hand, and previous revisions on the other hand. You then specify what to save as
follows:

Save From A Binder Package To A .Zip File

1. Select the binder package for which you want to save documents into a .zip
file.
2. Click Actions > Save to File.
3. On the Save to File dialog box, do one of the following:
• Accept the file path displayed under Path. In this case, the
software will create a unique file name in the currently displayed
folder.
• Click to open the Save As dialog box. Navigate to the folder
where you want the software to save your .zip files. After
selecting this folder, you have the following File name options:
• Type a file name.
• Select an existing file name from the current folder.
• Leave the File name box blank for the software to create a
unique file name.
•Click Save to return to the Save to File dialog box.
4. Under Select revision, do one of the following:
revision from the Revision name list.
5. Under Save what, do one of the following:
• Click All documents in binder package to save all the documents
of the revision you selected, or of the working issue.

• Click Changed documents only to save documents associated

with specifications marked as changed since the previous revision.
This option is available only if you selected Working issue above.
• Click Selected documents to save the specifications and notes of
your choice from the revision you selected, or from the working
issue.
6. Click OK to save the documents into a .zip file.
Highlight the documents that you want to save and click OK.
Related Topics
• Converting Binder Package Revisions to ZIP Files, page 973
• Printing from a Binder Package to a PDF File, page 979

Displaying Binder Package Properties

You can display the properties of a particular binder package to show general details
and a record of the revisions that were made.
Display the Properties of a Binder Package

1. Select the desired binder package.
• Click Actions > Properties.
• Click the right mouse button and on the shortcut > Properties.
3. On the Binder Package Properties dialog box, click the General tab to show
general details of the binder package.
4. Click the Revisions tab to show details of revisions made to the binder package.
5. When done, click Close.

Troubleshooting
Errors may occur when you are working in the Document Binder module. This
section describes the common ones, with recommendations for solving the problems.
Binder package problems

Problem Description Suggested Reason Recommended
Solution
Binder package cannot be Binder package has already
renamed. undergone a revision.
Binder package cannot be Binder package has already If binder
deleted. undergone a revision or if not, it still package has
has specs assigned to it. not yet
undergone a
revision,
remove all the
specifications
from the binder
package.
When selecting detailed view Default View deleted or not defined Create a View
of specification list, a message in Document Binder Browser. in the Package
appears: "Failed to retrieve Browser and
Style Setting". define a style
for it. Ensure
that the Set as
default view
check box is
selected.
No forms available for No specification has been assigned
selection when you try to add to the binder package.
a note to the Form Notes
folder.

Revision problems
Solution
Cannot revise the binder One or more of the documents in Close the edit
package. the binder package are being location
edited. (specification
or note editor).
One or more of the instrument Release all
tags associated with the instrument tags
specification are locked for from any
process data. workflow
assignments.
Revised documents cannot be Target is not defined for the Your Domain
saved. revision. Administrator
needs to define
the path or
location.

Printing problems
Solution
Pages cannot be prepared for Open specifications or notes. Close all
printing. specifications
and notes, then
re-select the
print option.
The binder package includes One or more of the documents in Search for the
blank reports. the binder package is missing. missing reports
according to
the names
displayed in the
error messages,
and move them
to the
appropriate
document
location.
Cannot print binder package. Binder package contains no Assign a spec
documents. to the binder
package, or add
a General Note.
Cannot repaginate before A problem exists with the Open the
printing. specification, the form, or the specification in
format. the
Specifications
module and
follow the
instructions.

Loop Drawings Module

Overview
You use the Loop Drawings module to retrieve predefined instrumentation data and
generate appropriate loop drawings. Each component in the loop drawing is assigned
the necessary drawing blocks that represent its functionality and wiring routing. The
drawings display information about the loops and their instruments, wiring routing,
line data, DCS data, document references, approvals, revisions, and general
information.
The Loop Drawings module generates loop drawings by means of a fast build
process. By configuring typical blocks for key instrument types, the loop components
can be automatically initialized with their corresponding graphical elements. The
Loop Drawings module enables you to create loop drawings that include data
retrieved from the database and if required, from an external file.
You can generate loop drawings one of the following ways:
• Using the Enhanced Report Utility.

• Using an external CAD application (SmartPlant Instrumentation
supports Intergraph SmartSketch, Autodesk AutoCAD (2000 or later),
or Bentley Systems MicroStation for Windows).

Blocks in SmartPlant Instrumentation: An Overview

A drawing block must belong to a particular block type, therefore you must define at
least one instrument block type before you can add a new block (apart from the
default general block types and the Loop Block type). Therefore, after you defined
the loop drawing blocks in the CAD application you need to define the blocks and
block types in SmartPlant Instrumentation. You can use similar blocks to represent
identical components in different drawing positions by defining several blocks that
use the same drawing file.
SmartPlant Instrumentation is shipped with several examples of blocks that are used
in the demonstration database (IN_DEMO.DB). The wiring methodology behind
these blocks includes the use of an overall shield with single cables and multiple pair
cables. After the installation, these blocks can be found in the path <SmartPlant
Instrumentation home folder>\CAD\Blocks.
There must be a correlation between the file formats supported by your CAD
application and the file format in which you save a new drawing block. Standard
drawing blocks exist for each of the following CAD applications (shown with the
appropriate file extension):
• Intergraph SmartSketch — .sym

• AutoCAD — .dwg
• MicroStation — .cel
A block is a term that is used in SmartPlant Instrumentation. Depending on the CAD
application that you use, the following equivalent terms apply.
SmartPlant SmartSketch AutoCAD MicroStation

Instrumentation Term
Block Symbol Drawing Cell
Macro Text element Attribute Tag
element
Block Types
You manage blocks in the Drawing Block Types folder of the Domain Explorer.
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. All block types that appear in a given <plant> also appear in all
<plants> that exist in the current domain. After you define blocks in the Drawing
Block Types folder and organize them according to their block types, you perform
block association in the Loops folder of the Domain Explorer.

The following drawing block types are available:
• General Blocks (shown as ) — Blocks used in all loop drawings

or hook-up drawings. In the Drawing Block Types folder, under
Border and Logo block types, you can create logo and border blocks
for loop drawings or hook-up drawings if the shipped logo or border
blocks do not meet your requirements. For a complete list of the
shipped logo and border blocks, see Shipped Block Files, page 991.
You assign one logo and one border block to all loop drawings or
hook-up drawings using the Default General Blocks dialog box. In
addition to border and logo blocks, you can create user-defined
general block types and then define other general blocks you want to
assign to all loop drawings. You can assign any number of user-
defined general blocks using the automatic block assignment method.
The software automatically displays all blocks belonging to every
user-defined general block type in every CAD loop drawing you
generate, regardless of the CAD application you use. User-defined
general blocks cannot be assigned to hook-up drawings.
• Loop Blocks (shown as ) — Blocks that you assign directly to the
loop number in the Loops folder of the Domain Explorer. In the
Drawing Block Types folder, under Loop Block block type, you
define loop blocks you want to make available for association with
loop numbers in the Loops folder of the Domain Explorer. The
Loop Block Type folder is the only folder where you can create loop
blocks. You cannot delete this folder.
• Instrument Blocks (shown as ) — Blocks that you assign to
instruments that appear at the instrument level in the Loops folder of
the Domain Explorer. You can create as many instrument block
types as you require. After defining instrument blocks, you can
choose a block assignment method to associate your blocks with
specific instruments.
Notes
• The software always places in the drawing one block belonging to the
Logo type and one block belonging to the Border type regardless of
whether you add user-defined general blocks in the drawing.
• You can specify the coordinates of user-defined general blocks to
prevent overlapping with other drawing elements, such as the border
or the logo.
• In hook-up drawings, you can only use the blocks created in default
Border and Logo general block types

Block Assignment Methods

After defining the blocks and their macros, it is necessary to assign your instrument
tag numbers to the drawing blocks that represent the instruments graphically. The
following is the description of the available assignment methods:
• Automatic block assignment method — In the Loops folder of the

Domain Explorer, these blocks are shown under instruments as .
Also, you must use this method if you want to assign user-defined
general blocks to your loop drawings. After assigning such a block to
an instrument type, the software displays this block in every loop
drawing whose source loop contains an instrument with the same
instrument type. The assigned user-defined general blocks do not
appear in the Domain Explorer.
• Manual block assignment method — In the Loops folder of the
Domain Explorer, these blocks are shown under instruments as . In
the Domain Explorer, it is possible to change the block assignment
method from automatic to manual.

Shipped Block Files

Border and Logo Block Files
The files in the list are the predefined drawing blocks that you can use to represent the
border / title (one of which should be defined as the default border) and the logo (one
of which should be defined as the default logo).
File Name Description Available

Formats
BORD_DEF Border and title. .dwg,
.sym
BORD_DEM Border and title. .dwg
BORDER Border and title. .cel
BRDDEM Border and title. .cel
TITLE Border and title. .cel
INGR Intergraph logo. .cel
LOGO_DEF Intergraph logo. .dwg,
.sym
LOGO_DEM Intergraph logo. .dwg,
.sym
LOGO_IN Intergraph logo. .dwg
LOGOIG Intergraph logo. .cel
DCS and Control Block Files

Formats
CTRL1 Analog input control. .dwg
CTRL2 Analog input and analog output .dwg
control.

Field Device Block Files

Formats
CV2 Control valve. .dwg,
.sym
ORIF_1 Orifice on a steam traced line. .dwg
ORIF_2 Orifice. .dwg
PLOC_IND.DWG Parallel connection of an indicator. .dwg
PT_1 Pressure element. .dwg
SLOC_IND.DWG Series connection of an indicator. .dwg
TC_1 Skin temperature controller .dwg
(welded).
TC_2 Temperature element. .dwg
TE Temperature element wired to a .dwg
temperature transmitter.
Wiring Routing Block Files

Formats
AIT_ROUT Typical analog input routing; field .dwg
device, junction box, marshaling
rack, and an analog input I/O card.
AOT_ROUT Typical analog output routing; I/P .dwg
transducer, junction box,
marshaling rack, and an analog
output I/O card.
PAIT1 Use for parallel indicator and .dwg
transmitter.
SAIT Use for serial indicator and .dwg
transmitter.

Add a Block Type

Use this procedure to add a new instrument block type or a user-defined general
block type in the Drawing Block Types folder of the Domain Explorer.
1. In the Domain Explorer, right-click the Drawing Block Types folder and, on the
• Click General Block Type to create a user-define general block type.
• Click Instrument Block Type to create a block type whose blocks
you can then assign to instrument tags in the Loops folder of the
Domain Explorer.
3. In the Block Type Properties dialog box, type the new block name and
description in the appropriate boxes.
Tips
• Block types are defined at the domain level; therefore, a block type
that you add in the current <plant> automatically appears in all the
<plants> that exist in the current domain.
• You cannot add a new block type for loop blocks.
Add a Block to a Block Type

1. In the Domain Explorer, double-click the Drawing Block Types folder to
expand its hierarchy.
2. Right-click a block type and on the shortcut menu click New > Block.
3. On the Block Properties dialog box, enter information as follows:
a. In the Block field, enter the name to be used for the block by SmartPlant
Instrumentation.
b. In the Description field, type in a description for the block.
c. Under Block type, select a block type from the list.
d. Under Drawing block file, navigate to the block source file by clicking
Browse.
e. Specify the file path.
f. Under Origin, enter the required X and Y parameters to position the new
block on the drawing.
Tips
• You can enter decimal numbers as well as whole numbers.

• Blocks that you add under the Border, Logo, or a user-defined general
block type appear on the Default General Blocks dialog box, which
you open from the Actions menu of the Loop Drawings Module
window menu bar. In the Domain Explorer, general blocks only
appear in the Drawing Block Types folder and are shown as .
• Loop blocks that you add become available for association with loops
in the Loops folder of the Domain Explorer. These blocks are shown
as .
• Instrument blocks that you add become available for association with
instrument tag numbers in the Loops folder of the Domain Explorer.
In the Drawing Block Types folder, instrument blocks are shown as
. In the Loops folder, blocks assigned to instruments using the
automatic block assignment method are shown as and blocks
assigned to instruments using the manual block assignment method are
shown as .
View a Drawing Block in a CAD Application

Use this procedure to display a block it in your CAD application — SmartSketch,
MicroStation or AutoCAD — depending on the settings you made on the
Preferences dialog box.
Note
• The difference between viewing and generating is that viewing only
shows the code fields of blocks and macros while generating actually
retrieves the data and displays it on the drawing layer.
1. Press F7 to open the Domain Explorer and then expand the hierarchy to the loop
level in the Loops folder.
2. In the tree view pane, expand the loop hierarchy to the tag level and select a tag.
3. In the Items pane, right-click a block.
4. On the shortcut menu, click Reports > View Block in CAD Application.

Define Insertion Points for Blocks

In SmartSketch, AutoCAD or MicroStation, you can define the insertion point for
individual blocks relative to the drawing origin (lower left corner). This enables you
to use the same block in different positions in different loop drawings.
2. Expand the loop-tag-block hierarchy and then do one of the following:
• In the tree view pane, right-click a desired block.
• In the Items pane, select and right-click several blocks.
Tip
• You can only define insertion points for blocks shown as . These
blocks are assigned to instruments using the manual block assignment
method. If your block selection in the Items pane includes
automatically assigned blocks, (shown as ), you need to redefine
your selection.
3. On the shortcut menu, click Actions > Define Block Origin.
4. On the Define Block Origin dialog box, select a block.
Tip
• If there is a large number of blocks in the data window, under Find,
select a column heading and then type a value. For example, if you
select Tag Number as a column heading and type a specific tag
number, in the data window, the software finds the block assigned to
this tag number.
5. Under Tag assignments, enter the required values (in the CAD application units)
for the block new insertion point X- and Y-coordinates.
Tip
• The block origin can consist of numbers that include decimal values,
for example, 9.85.

Copy Blocks to Another <Plant>

Use this procedure to copy one or more blocks that you select in the Drawing Block
Types folder of the Domain Explorer to another <plant> that exists in the current
domain.
1. In the Domain Explorer, double-click the Drawing Block Types folder to
expand its hierarchy.
2. Double-click a block type whose blocks you want to copy.
• In the tree view pane, right-click a specific block.
• In the Items pane, select and right-click blocks you want to copy.
4. On the shortcut menu, click Actions > Copy Blocks to Another <Plant>.
5. In the Items pane, select and right-click the blocks that you want to copy to other
tag numbers.
6. On the shortcut menu, click Copy Blocks to Tag Numbers.
7. On the dialog box that opens, select a target plant and click OK.
Tips
• The blocks that you copy appear in the appropriate block type of the
target plant. The block types you define in the source plant
automatically appear in all the plants in the current domain because
block types are defined at the domain level.
• When copying blocks, the software does not copy any associations you
made for the blocks in the source plant.

Associate a Loop Block

Use this procedure to associate a loop block with one or more loop numbers. You
can only assign a loop block if the loop that you selected does not have any
instrument blocks assigned using the manual block assignment method. Such blocks
are shown under the loop tags as . The software, however, does not prevent you
from assigning a loop block to the loop is the loop tags have instrument blocks
assigned using the automatic block assignment method. Such blocks are shown under
the loop tags as . After associating a block with a loop, when generating a loop
drawing, the software always uses the loop block and ignores instrument blocks this
loop might contain.
Note
• You must first define loop blocks in the Drawing Block Types folder
of the Domain Explorer. In the Domain Explorer, loop blocks are
shown as . For details, see Add a Block to a Block Type, page 993.
1. Press F7 to open the Domain Explorer and then expand the hierarchy to the tag
• In the tree view pane, right-click a specific loop number.
• In the Items pane, select and right-click several loop numbers.
3. On the shortcut menu, click Actions > Associate Loop Block.
Tips
• If there is a large number of blocks in the data window, under Find
block, select a column heading and then type a value. For example, if
you select Block as a column heading and type block name Control,
in the data window, the software selects the block whose name starts
with Control.
• If you want to display only specific blocks in the data window, click
Filter and specify a filter parameter.
4. In the data window, select the loop block and then click OK.
Tips
• You can only assign one loop block per loop.
• To dissociate loop block, right-click it and then, on the shortcut menu,
click Actions > Dissociate Loop Block.

Associate Instrument Blocks Automatically (via Instrument

Type)
In an instrumentation design setup with a very large number of control loops, similar
tag numbers are represented repeatedly using the same drawing block, the only
difference being the data that is retrieved by the macros in the drawing. Therefore,
instead of having to associate each block with an instrument manually, you can use
this procedure to associate typical blocks with a specific instrument type.
1. In the Loop Drawings Module window, do one of the following:

• On the menu bar, click Actions > Block – Instrument Type
Assignment.
2. On the Block – Instrument Type Assignment dialog box, in the Type data
window column, select an instrument type.
Tip
• If there is a large number of instrument types in the data window,
under Find instrument type, select a column heading and then type a
value. For example, if you select Description as a column heading
and type Control, in the data window, the software locates the
instrument types whose description starts with Control.
3. Click Assign.
4. If you defined several instrument block types in the Drawing Block Types folder
of the Domain Explorer, from the Block type list, select the appropriate
instrument block type.
5. Select blocks that you want to assign to the instrument type.
Tips
• If you select Show blocks of all types, the software displays all blocks
belonging to all the instrument block types that you defined n the
Drawing Block Types folder of the Domain Explorer. In addition to
instrument blocks, the software displays all user-defined general
blocks. If you assign a user-defined blocks to the instrument type, the
software displays this block in all loop drawings that include an
instrument belonging to the current instrument type.
• Click View to open a block in your CAD application.
6. Click OK and then check the block assignment in the Loops folder of the
Domain Explorer.

Tip
• In the Loops folder of the Domain Explorer, the instrument blocks
that you assigned appear under the tag numbers belonging to the
instrument type that you selected. These blocks are indicated with the
icon .
Change the Block Assignment Method from Automatic to

Manual
This procedure enables you to change the assignment method of instrument blocks
from automatic to manual. Blocks assigned to tag numbers using the manuals block
assignment method become available for selection in the Generate Loop Drawings
dialog box, where you can set the software to generate loop drawings only for those
loops that use a specific manually assigned instrument block.
Note
• You cannot use this procedure if the source loop contains a loop block
(shown as under the loop number).
1. Press F7 to open the Domain Explorer and then expand the hierarchy to the
instrument level in the Loops folder.
• In the Items pane, select and right-click one or more loops.
• In the tree view pane, select a specific loop and then in the Items pane,
select and right-click instruments whose blocks are assigned using the
automatic block assignment method.
Tip
• In the Loops folder, blocks associated with tags using the manual
method are marked with the icon . Blocks associated with tags
using the automatic block assignment method are marked with the icon
.
3. On the shortcut menu, point to Actions and click Change Block Assignment
Method.
4. Click Yes when prompted.
Tips
• In the Domain Explorer, the block icons change accordingly.
• After changing the block assignment method from automatic to
manual, these blocks are no longer associated with an instrument type,
and therefore are not affected by any changes you or other users can
make to the block – instrument type association.

• Manually associated blocks become available for selection in the

Generate Loop Drawings dialog box, where you can generate a CAD
loop drawing per block.
Associate Instrument Blocks Manually

You can manually associate one or more blocks with tag numbers belonging to the
same loop number. In this case, that the software draws blocks after you select a loop
number in the Domain Explorer.
Note
• If you have a large number of loops with tag numbers that have
identical properties, you can assign block using the automatic block
assignment method. For details, see Associate Instrument Blocks
Automatically (via Instrument Type), page 998.
1. Press F7 to open the Domain Explorer and then expand the hierarchy to the tag
2. In the Items pane, select and right-click tag numbers to which you want assign
blocks.
3. On the shortcut menu, click Actions > Associate Instrument Blocks.
Tips
• If there is a large number of blocks in the data window, under Find
block, select a column heading and then type a value. For example, if
you select Block as a column heading and type block name Control,
in the data window, the software locates the block whose name starts
with Control.
• If you want to display only specific blocks in the data window, click
Filter and specify a filter parameter.
4. In the data window, select the blocks that you want to associate and then click
OK.
5. In the Specify Drawing Pages for Blocks Assignment dialog box, under Page,
use spinners to specify pages on which you want the selected blocks to appear
after loop drawing generation.
Tips
• The Specify Drawing Pages for Blocks Assignment dialog box
opens when the source loop number is assigned to a multi-page
drawing or multi-drawing.
• In the Loops folder of the Domain Explorer, the instrument blocks
that you assigned appear under the tag numbers that you selected.
These blocks are indicated with the icon .

Update Block Assignments

This procedure enables you to update block assignments that might have been
changed during your <plant> life cycle. You can update block assignments in batch
mode, for one or more instrument tags belonging to the same loop or to a group of
loops.
1. In the Domain Explorer, expand the Loops folder hierarchy.
• In the Items pane, select and right-click one or more loops.
• In the tree view pane, select a specific loop and then in the Items pane,
select and right-click tag numbers.
3. On the shortcut menu, point to Actions, and click Update Block Assignments.
4. On the Update Block Assignments dialog box, select an update option as you
require.
Important
• When selecting the Overwrite option, any existing blocks associated
manually with the current tag number are dissociated.
• To update block assignments for the displayed tag number only, click
Apply and then click Next to display another tag number.
• To update block assignments for the all the tag numbers you selected
in the Domain Explorer, click Apply to All.

Copy Associated Blocks to Other Instrument Tags

Use this procedure to copy one or more blocks that are associated with a particular
instrument to other instrument tags displayed in the Domain Explorer.
Notes
• You can only copy blocks to those tags that belong to loops you
assigned to the CAD generation method. In the Domain Explorer,
the icons of such loops appear with the C indicator.
• This procedure only allows you to copy blocks assigned to a specific
instrument. If you want to copy all instrument blocks that all of the
loop instrument contain, you need to perform a different procedure.
For details, see Copy Automatically Assigned Blocks to Tags of Other
Loops, page 1003.
2. In the tree view pane, expand the loop hierarchy to the tag level and select a
source tag.
3. In the Items pane, select and right-click the blocks that you want to copy to other
tag numbers.
4. On the shortcut menu, click Copy Blocks to Tag Numbers.
5. In the dialog box that opens, do one of the following to find tags belonging to the
loops whose generation method is CAD:
• Click Find to find all the tag numbers.
• Set search parameters and then click Find to display tag numbers that
match the search parameters.
6. Under Search results, select tag numbers to which you want to copy the blocks.
7. Click OK.
Tip
• If any of the source blocks is associated with an instrument type, when
copying the blocks, the software changes the block assignment method
from automatic to manual. In the Loops folder of the Domain
Explorer, under the target instrument tags, the block icons change
from to .

Copy Automatically Assigned Blocks to Tags of Other

Loops
Use this procedure to copy blocks from all instrument tags of a specific loop to all
instruments of one or more target loops. The software only copies those blocks that
are assigned to the source loop instruments using the automatic block assignment
method. In the Domain Explorer, these blocks are indicated with the icon. The
software validates the instrument tag assignments and the drawing type of the target
loops before copying the blocks.
Notes
• You can only copy blocks to those tags that belong to loops you
assigned to the CAD generation method. In the Domain Explorer,
the icons of such loops appear with the C indicator.
• Using this procedure, you copy blocks at the <plant> level, that is,
your target loops belong to different <units> of the current plant. If
you only want to copy blocks that belong to a specific instrument or
copy blocks at the <unit> level, you need to perform a different
procedure. For details, see Copy Associated Blocks to Other
2. In the tree view pane, right-click a loop.
3. On the shortcut menu, click Copy Blocks to Tags of Other Loops.
4. On the dialog box that opens, under Target loop number, select one or more
loops.
Tip
• You can select all the target loops or find a specific loop. The
software finds and selects the loop number as you type its name in the
Find target loop box.
5. Click OK to validate the target blocks and create the copy_block.txt log file in the
temporary folder path of SmartPlant Instrumentation.
6. When prompted to copy the blocks, do one of the following::
• Click Yes to start copying the blocks and skip problematic loops
automatically.
• Click No if you only want to view the target loop validation problems
in the log file.
7. In the temporary folder path of SmartPlant Instrumentation, view the
copy_block.txt log file.

Assign an Instrument Block to a Drawing Page

Use this procedure to assign a CAD drawing block to a specific page in the generated
loop drawing when the loop drawing multi-page drawing or multi-drawing. You
must perform this procedure if the drawing block is assigned to the loop instrument
using the automatic block assignment method. Such blocks are shown under the loop
tags as .
1. In the Domain Explorer, expand the Loops folder hierarchy.
2. In the tree view pane, expand the hierarchy to the instrument level and then select
an instrument tag.
3. In the Items pane, right-click a block.
Tips
• You can only select one block at a time.
• For a block shown as , you might have already specified the
drawing page when assigning the block to the instrument using the
following procedure: Associate Instrument Blocks Manually, page
1000. It is possible to specify a different page for such a block.
4. On the shortcut menu, click Actions > Select Drawing Page.
5. On the Select Drawing Page dialog box, select a page number.
6. Double-click the selected number or click OK and then repeat this procedure to
assign another block to a drawing page.

Dissociate Blocks from Instruments

Use this procedure to dissociate blocks from instruments belonging to the same or
different loops.
1. On the Loop Drawings Module window menu bar, click Dissociate Instrument
Blocks.
2. Under Select blocks, select one or more blocks and also select the specific
instruments form which you want to dissociate the blocks.
3. Click OK to dissociate the blocks.
Tips
• When dissociating blocks assigned to instruments using the automatic
block assignment method, the software does not dissociate these blocks
from the instrument type. You can reassign these blocks automatically
whenever you require. In the Domain Explorer, these blocks are
shown as . For details, see Update Block Assignments, page 1001.
• You can also dissociate instrument blocks from the Loops folder of
the Domain Explorer. However, it is only possible to dissociate
blocks belonging to one specific instrument. After you select an
instrument in the Loops folder, the software displays the associated
blocks in the Items pane. You can right-click one or more blocks and
then, on the shortcut menu, click Actions > Dissociate Instrument
Blocks.

Specify Border and Logo Blocks for Loop Drawings

This procedure allows you to set SmartPlant Instrumentation to use a specific border
block and logo block every time you generate a CAD loop drawing. Blocks that you
set as default general blocks must belong to the shipped general block types, that is,
Border and Logo. You define and manage blocks in the Drawing Block Types
folder of the Domain Explorer.
Notes
• You can only perform this procedure after you have assigned blocks to
the Border and Logo general block types in the Drawing Block
Types folder of the Domain Explorer.
• In addition to the shipped general block types, you might have created
user-defined general block types. All blocks belonging to the block
types appear automatically in every CAD loop drawing that you
generate.
1. In the Loop Drawings Module window menu bar, click Actions > Default
General Blocks.
2. In the Default General Blocks dialog box, select the border and logo blocks to be
used in all the loop drawings.
Assign General Blocks to All Loop Drawings via Instrument

Type
Use this procedure to assign user-defined general blocks to a specific instrument type.
This procedure allows you to display general blocks in all loop drawings
automatically if the source loops have tags belonging to the instrument type to which
you assigned the blocks. The software displays such blocks in addition to the default
border and logo blocks that you specify on the Default General Blocks dialog box.
1. In the Domain Explorer, right-click the Drawing Block Types folder.
2. On the shortcut menu, click New > General Block Type and define a block type.
3. Right-click the block type you created and then, on the shortcut menu, click New
> Block.
4. Define one or more blocks as you require.
5. In the Loop Drawings Module window, do one of the following:

• On the Actions menu, click Block – Instrument Type Assignment.

6. On the Block – Instrument Type Assignment dialog box, in the Type data
window column, select an instrument type.
Tip
• If there is a large number of instrument types in the data window,
under Find instrument type, select a column heading and then type a
value. For example, if you select Description as a column heading
and type Control, in the data window, the software locates the
instrument types whose description starts with Control.
7. Click Assign.
8. From the Block type list, select the user-defined general block type that you
created in the Drawing Block Types folder.
9. Select one or more blocks that you want to assign to the instrument type.
10. Click OK and then generate the appropriate loop drawing to display the assigned
blocks.
Tip
• User-defined general blocks are only shown in the Drawing Block
Types folder of the Domain Explorer.

Updating Loop Drawing Properties: An Overview

In the Loop Drawings module, you can specify a drawing type for every loop drawing
that you want to generate.
The following drawing types are available:
• Single-page — A loop drawing type used to display all the drawing

blocks and the title block on a single drawing page. Property updates
for this drawing type take effect in both CAD loop drawings and
drawings you generate by the Enhanced Report Utility.
• Multi-page — A loop drawing type used to display drawing blocks
on more than one page, where all the pages share the same document
number, description, and title block. Property updates for this drawing
type only take effect in CAD loop drawings.
• Multi-drawing — A loop drawing type used to display blocks on
more than one page, where each page has an individual document
number, description, and title block. Property updates for this drawing
type only take effect in CAD loop drawings.
By default, all drawings belong to the single page drawing type.
Loop drawing properties appear in the title block fields. These fields contain
identifying information about the document number, page number, and file name, and
also information about revisions, approvals, and references to other documents.
Properly completed identifying information ensures that each drawing is uniquely

identifiable. You can maintain your loop drawing properties by keeping the revision,
document reference and client / vendor approval information up to date.

Set the Date Format in CAD Loop Drawings

Use this procedure to set a date format in your CAD loop drawings. You set the date
format when customizing your CAD loop drawing preferences on the Preferences
dialog box.
2. In the tree view, click Loop Drawings > General.
3. In the Date format box, enter the date format using the syntax in the following
table:
4.
Date Format Example
mm-dd-yy 01-30-07
mm-dd-yyyy 01-30-2007
dd-mm-yy 30-30-07
dd-mm-yyyy 30-30-2007
d-mmm-yy 30-Jan-07
mmm-yy Jan-07
Tips
• SmartPlant Instrumentation only support date formats that are listed in
this table.
• You can use one of the following characters as separators: dash (-),
slash (/), space, comma, semicolon, colon, or dot.

Define a Drawing as a Multi-Drawing

Use this procedure to define a CAD drawing as a multi-drawing.
3. On the shortcut menu, click Actions > Loop Drawing List.
4. On the Loop Drawing List dialog box, select the loop, and then click Properties.
5. On the Loop Drawing Properties dialog box, under Drawing type, click Multi-
drawing.
6. Click New and then enter the values as you require.
Tips
• You cannot change the loop number value.
• In the Page column, you can type any alphanumeric character that
designates a specific loop drawing page.
• You can specify an individual source path for any drawing page by
clicking to the right of the selected drawing file. A source path is a
path which software uses to locate the source file when generating a
CAD drawing that belongs to the multi-drawing type. The path that
you specify does not overwrite the path setting specified in the
Preferences dialog box. The software saves all generated loop
drawings in a designated folder that you define on the Preferences
dialog box.

Define a Drawing as a Multi-Page Drawing

Use this procedure to define a CAD drawing as a multi-page drawing.
4. On the Loop Drawing List dialog box, select the loop, and then click Properties.
5. On the Loop Drawing Properties dialog box, under Drawing type, click Multi-
page.
6. Click New and then enter the values as you require. Repeat this action as many
times as you need.
Tips
• You cannot change the loop number value.
• In the Page column, you can type any alphanumeric character that
designates a specific loop drawing page.
• You can specify an individual source path for any drawing page by
clicking to the right of the selected drawing file. A source path is a
path which software uses to locate the source file when generating a
CAD drawing that belongs to the multi-page type. The path that you
specify does not overwrite the path setting specified on the
Preferences dialog box. The software saves all generated loop
drawings in a designated folder that you define on the Preferences
dialog box.

Modify Properties of a Single-Page Drawing

Use this procedure to modify properties of a CAD drawing to be generated as a
single-page drawing.
4. On the Loop Drawing List dialog box, select the loop number, and then click
Properties.
Tip
• If the drawing belongs to the single page type, the Single page button
under Drawing type is selected automatically. You can change the
type of the drawing to multi-page or multi-drawing
5. Modify the values as you require.
Maintain CAD Loop Drawing Revisions

Use this procedure to maintain CAD loop drawing revisions. Revisions enable you to
keep track of the changes made to the CAD loop drawing during its lifetime. It is
important and useful to have a chronological description of the changes, dates of
change, and a list of persons who approved them. Use the following procedure to
add, edit, or delete revisions.
2. In the Items pane, select and right-click one or more loops.
3. On the shortcut menu, point to Actions and click Loop Drawing List.
4. On the Loop Drawing List dialog box, click Revisions.
P0, P1, P2... for preliminary revisions or 0, 1, 2 /A, B, C and so forth for normal
serial revisions).
Tips
P0, P1, P2…). Once you select one of the other revision methods, you
can no longer return to the preliminary revision method and this option
becomes disabled.

• When working with revisions in an integrated environment, the

revision numbering methods are not available for selection.
6. Click New to add new revision data or update the existing data as desired.
Tips
• SmartPlant Instrumentation automatically adds a new line with the
next logical character and date each time you click New after you
select the initial method.
7. Add or edit the revision data in the appropriate data fields.
Tips
• The By column contains the current user initials by default, if
previously defined by the System Administrator. You can edit this
value as you require.
• You can delete obsolete revisions by clicking Delete.
• You can also maintain revisions in batch mode.
• Each revision is represented by a numbered macro and the revisions
are displayed in the order of the macro numbering, beginning with the
first revision (ascending order) or the last revision (descending order).
If the total number of revisions is greater than the number of lines
available for display in the drawing and you want to see the latest
revisions, you should set your preferences to display the revisions in
descending order so that the latest revision is displayed first.

Maintain Document References

Use this procedure to maintain document references that you include in title blocks of
CAD loop drawings. You can manually add a new document reference, or you can
edit or delete an existing document reference.
Title blocks can display the following document references:
• Automatic references to P&ID drawings

• Manual references to loop drawings
• Automatic references to reports generated in the Wiring module
4. On the Loop Drawing List dialog box, click References.
5. On the Document References dialog box, do one of the following:
• Select a row in the data window and click Properties to update the
existing document reference name and description of a manually
inserted reference.
• Click New to define properties of a new document reference.
Tips
• You can view document references to reports generated in the Wiring
module only if you have selected the Display references to wiring
reports automatically check box in the Loop Drawings > General
page of the Preferences dialog box. You cannot edit properties of
these document references.
• The time of reference creation determines the order of the references
in the title block. In the title block, the software displays the
references in descending order, according to the time of creation. This
means that the reference you create first appears in the title block at
the top of the reference list.
• If an instrument in the selected loop has a reference in a P&ID
drawing, this reference automatically appears on the Document
References dialog box. It is possible, you can edit a P&ID drawing
reference in the Instrument Index module.

Make CAD Drawing Approvals

Use this procedure to make client and vendor approvals for CAD loop drawings.
4. On the Loop Drawing List dialog box, click Approvals.
5. On the Approvals dialog box, set data for client and vendor approvals as you
require.
Modify Loop Drawing Identifying Information

Use this procedure to set or modify loop drawing identifying information.
2. In the Items pane, select and right-click loops.
4. On the Loop Drawing List dialog box, click Properties.
5. Modify the data as you require.
Tips
• Properties that you can edit are determined by the specified drawing
type.
• The document number does not have to be unique.
• Properties that only apply to CAD drawings are indicated as such.
Other properties, such as document number and loop drawing
description, are used in both CAD loop drawings and in loop drawings
generated by the Enhanced Report Utility.

Update Paths for CAD Drawings and Block Files

Use this procedure to update in the SmartPlant Instrumentation database paths for
existing drawings and block files. You can update paths globally for block files
associated with instruments and loops, for general block files, and for generated
CAD drawings.
Note
• The paths that you specify do not overwrite the preferences settings
specified for new block files and output drawings. For more
information about the CAD path preferences, see Loop Drawings >
CAD File Locations (Preferences), page 157.
Update Paths for Existing CAD Drawings And Block Files

1. In the Loop Drawings Module menu bar, click Actions > Update Paths for
Existing Drawings and Blocks.
2. Under Path for associated block, do one of the following:
• Click Apply to drawings in the domain/project to apply the new
path to all the plants in the current domain, or to the current project
when the domain type is Operating owner.
• Click Apply to drawings in the current <plant> only to apply the
new path to the current plant only.
3. Type the full path to the folder where you keep your drawing blocks files or click
Browse to navigate to the desired folder.
4. Under Path for generated drawings, do one of the following:
• Click Apply to blocks in the domain/project to apply the new path to
all the plants in the current domain, or to the current project when the
domain type is Operating owner.
• Click Apply to blocks in the current <plant> only to apply the new
path to the current plant only.
5. Type the full path to the folder where you keep your generated drawings or click

Associating an External CAD Drawing

This option enables you to associate an external CAD drawing with one or more
loops you have selected in the Domain Explorer. An external CAD drawing is a
drawing you have created outside the SmartPlant Instrumentation environment, using
SmartSketch, AutoCAD, or MicroStation. After associating an external CAD
drawing, you can open it in a compatible CAD application using the View External
CAD Drawing option of the Domain Explorer. External CAD drawings are only
used for viewing from within SmartPlant Instrumentation. They are nether included
in loop drawing generation, nor referenced in any item properties or settings.
3. On the on the shortcut menu, click Actions > Associate External CAD Drawing.
4. On the Select File dialog box, select the desired SmartSketch, AutoCAD or
MicroStation file.
Tip
• You can associate the following file types: .dwg, .dxf, .dgn, .cgm.
5. Click Open to associate the selected drawing.
Tips
• If there is already an external CAD drawing associated with the
current loop or loops, the new CAD drawing overwrites the existing
one.
• To dissociate the external CAD drawing, the on the shortcut menu,
click Actions > Dissociate External CAD Drawing.
View an External CAD Drawing

This option allows you to view an external CAD drawing that has been associated
with one or more loops the Domain Explorer. An external CAD drawing is a
drawing you have created outside the SmartPlant Instrumentation environment, using
SmartSketch, AutoCAD, or MicroStation.
3. On the on the shortcut menu, point to Reports and click View External CAD
Drawing to open the CAD drawing associated with the selected loop or loops.

CAD Loop Drawing Generation: An Overview

SmartPlant Instrumentation allows you to generate loop drawings using external CAD
applications. The same generation principles are valid for any of the listed CAD
applications. The following CAD applications are supported:
• Intergraph SmartSketch
• AutoCAD
• MicroStation
In the generation process, SmartSketch (.sym), AutoCAD (.dwg), or MicroStation
(.dgn) type drawings are created from the selected loops.
Prerequisites
• Before generating loop drawings, make sure that CAD application
paths are set up correctly on the Preferences dialog box. For details,
see CAD Settings for SmartPlant Instrumentation, page 1021.
• If you use SmartSketch, prior to starting the generation process, in the
Preferences dialog box, you must select the check box Use macro
symbol (&) to retrieve data because in SmartSketch all macros have
the `&' prefix. If you clear the check box, the software displays only
macro attributes in the drawings.
• If you use AutoCAD, to ensure that the software displays macro
captions, on the Custom tab of the Preferences dialog box, in the
Parameter box, type TagAsMacroName and in the Value field, type
Y.

Basic Principles of CAD Loop Drawing Generation

The following diagram illustrates a (schematic) flow control loop. The loop drawing
includes five drawing blocks for the following components: monitoring system,
control valve, each set of wiring connections to the DCS, and the DCS itself. The
wiring routing and control systems are conceptually the same for both tags (but with
different data), so in this example, the blocks for these items are identical.
Tag A is a monitoring system

consisting of a flow transmitter and flow element.
Tag B consists of a control valve with an I/P transducer.

Loop Drawing Generation Methods: An Overview

SmartPlant Instrumentation allows you to assign a loop number to one of the
following generation methods: CAD, Enhanced Reports, and manual. Methods are
marked by designated symbols attached to loop numbers in the Loops folder of the
Domain Explorer. By default, loop numbers are not assigned to any generation
method.
Loop drawing generation is traditionally done using a CAD application such as

SmartSketch, AutoCAD, or MicroStation. You must specify the CAD application
paths and other CAD file locations on the Loop Drawings > CAD File Locations
page of the Preferences dialog box.
In addition to using a CAD method, you can also use the Enhanced Report Utility,
which is supplied with SmartPlant Instrumentation. This utility enables you to
generate, view, modify, and annotate loop drawings as needed. The Enhanced Report
Utility has an advantage over CAD as a loop drawing generation method in that it
requires no extra work in creating CAD drawing blocks. The report comes directly
from the database and does not necessarily require additional modifications
You can either assign each loop number to a specific method or apply the same
method to all loop numbers when generating loop drawings in batch mode. In the
Domain Explorer, for the intended method of generation, the software assigns an
appropriate generation indicator to the loop number icons.
The available indicators are:
• C— Loop drawing to be generated by a CAD application

(SmartSketch, AutoCAD, or MicroStation).
• M— Loop drawing to be generated manually, without using
SmartPlant Instrumentation options. When generating loop drawings,
the software always skips loops assigned to the Manual method.
• For loop drawings where the selected generation method is Enhanced
Report, the following symbols are available:
• E — By Loop
• ES — By Signal
• CL — Custom by Loop
• CS — Custom by Signal

CAD Settings for SmartPlant Instrumentation
Sample Loop Drawing (After Generation)

Apply Loop Drawing Generation Method

You can specify the desired method for one or more selected loops in the Domain
Explorer. You can also specify in the Preferences dialog box which generation
method to use by default and whether to display each signal on a separate drawing
sheet when you select By Signal or Custom by Signal as the generation method.
• In the tree view pane, right-click a target loop.
• In the Items pane, select and right-click several loops.
3. On the shortcut menu, click Apply Generation Method and then select a
generation method.
Tips
• In the Domain Explorer, the icons of the loop numbers to which you
applied a generation method appear with method indicators. For
method indicator descriptions, see Loop Drawing Generation
Methods: An Overview, page 1020.
• To clear the current loop generation method for one or more loops, on
the shortcut menu, click Clear Generation Method.

Generate CAD Loop Drawings

2. In the Items pane, select and right-click one or more loop numbers.
Tips
• If among the loops that you selected there are loops assigned to the
Manual method (symbol M in the Explorer), the software skips these
loops when generating drawings in batch mode.
3. On the shortcut menu, click Reports > Generate Loop Drawings.
4. On the Generate Loop Drawings dialog box, from the Generation method list,
select CAD.
5. Under Automatic save options, select Save drawing automatically and do one
of the following:
• In the Output drawing path data field, type the exact folder path to
which you want to save the generated drawing.
• Click Browse to navigate to the desired path for saving the file.
6. Click CAD Options, and then, from Save file in format list, specify the CAD file
format in which to save the generated drawings (if your CAD application supports
more than one file format).
7. Select the following check boxes:
• Send to plotter or printer— Sends the generated drawing to the
current CAD plotter.
• Use macro functions — Applies macro functions associated with the
macros.
• Save output data to database— Enables you to compare drawing
data of the current generation to data of a subsequent generation made
for the same loop.
8. Under Generation criteria, do one of the following:
• Click Per loop to generate drawings for all the loops you selected.
• Click Per page and then type the desired page number to generate
only a specific drawing page for the drawings you selected.
• Click Per block to select a block from the list and generate drawings
only for the loops that to which you assigned this block.
Tip
• The Per block option is useful when you select several loops in the
Items pane of the Domain Explorer. If your selection includes loops

that do not contain the block that you selected, the software does not
generate loop drawings for those loops. For the loops that do contain
the selected block, the software includes all of the blocks when
generating loop drawings. For example, if you selected five loops and
each of them has the block that you selected and also has three other
different blocks, the software includes all of these blocks in the
generated loop drawings. The blocks displayed in the lists are blocks
associated with instruments using the manual block assignment
method. In the Loops folder of the Domain Explorer, these blocks
are shown as are shown with the icon.
9. Under Create report about, select which reports you want to generate:
• Null data— Displays macro strings in the drawing for which
SmartPlant Instrumentation data is unavailable.
• Invalid macros— Displays macro strings in the drawing which are
not defined in SmartPlant Instrumentation.
Tip
• You can select to generate both reports if needed.
10. Under Mark drawing using, select the options for which you want to display a
text string, specified in the adjacent text box:
• String for null data— Allows you to type a string that indicates in
the drawing those macros for which SmartPlant Instrumentation data is
unavailable.
• String for invalid macros— Allows you to type a string that
indicates in the drawing those macros which are not defined in
11. If you need to use macros from an external source during the current loop drawing
generation, under External data, select the Use external macro source check
box, and then click Define.
12. Click OK to start the loop drawing generation process in your CAD application.

Show the Latest Generated CAD Drawing

This option enables you to display the latest loop drawing that was generated in
SmartPlant Instrumentation using an external CAD application. The drawing opens
in the CAD application you set as default on the Preferences dialog box.
• In the Loop Drawings module, click Actions > Show Latest

Generated Drawing.
Display CAD Loop Drawing Generation History

You can keep track of all the macro data changes in your CAD drawings. You
choose this option when generating a loop using an external CAD engine. You can
access the loop generation history from the print preview of loop drawings and the
relevant reports.
The loop generation history feature compares the retrieval values of macros from
different generations. Therefore, the history data is available when you have already
generated at least one loop drawing for a selected loop.
When comparing a loop drawing that you have just generated with an older one, you
have to set the comparison date range to include both generations. If that date
includes more than one loop drawing, select the exact loop drawing to which you
want to compare the currently generated one.
The results show a comparison of the current data in the loop drawing with the data
stored in the history for the specified date range or generation.
1. On the Generate Loop Drawings dialog box, in the CAD Options tab, select the
Save output data to database check box.
2. On the CAD History tab, select the Compare outputs check box if this is not the
first generation to make the additional options available.
• Click Set date range and then, in the From and To boxes, specify the
history date range you need for the comparison.
• Click Select specific generation, and then, from the data window,
select a specific generation to which you want to compare the current
generation.
4. Under History data, select one of the following check boxes or both check boxes:
• Select Display in the drawing to display history data in the generated
drawing.

• Select Display in the report to display the Data Changes Report

before proceeding with the loop generation. The report includes the
tag number, block name, macro name and description, old value and
the new value.
• Click Show data from previous generation to display the old history
value from the previous generation.
• Click Mark with user-define value and type a new value in the box
below. This marks the drawing or the report with the new value
instead of the old history value from the previous generation.
Tips
• In the generated drawing or report, the software displays the old value
in parentheses.
• If you selected Display in the report, the software displays the Data
Changes Report before proceeding with the loop generation. After
printing or viewing the report, click OK to return to the Generate
Loop Drawings dialog box.
6. Click OK to start the generation process.

Delete CAD Loop Drawing Generation History

To improve performance when comparing generated data values in CAD loop
drawings, you need to delete the history of obsolete CAD loop drawing generations.
Before deleting the values of previous CAD loop drawing generations, you select the
required loops, and then set the period within which you want to delete the selected
history records.
1. In the Domain Explorer, right-click loops that you select, and then, on the
shortcut menu, click Actions > Delete Generation History Records.
2. In the From and To boxes, specify the date range of the generation history
records that you want to delete.
3. Click Show Records.
4. Under Select records for deletion, select history records that you want to delete.
Tip
• Select the Select all check box to be able to delete all the displayed
records at once.
5. Click Delete.
Clear Previous Macro Result Records

Use this procedure to clear macro result records of generated loop drawings. The
software saves the macro results in the database for the next time you want to
generate a loop drawing for the same loop. The saved data accumulates and at a
certain stage might affect the generation performance.
2. In the Items pane, select and right-click loops whose temporary generation data
table you want to clear.
3. On the shortcut menu, click Actions > Clear Temporary Data.

Loop Drawing Reports

The following reports are associated with loop drawings that you can generate in
SmartPlant Instrumentation:
• CAD Loop Drawing Generation Errors — Available on the shortcut

menu in the Domain Explorer. This report lists a summary of errors
that occurred during the last loop drawing generation using your CAD
application. Data that appears in this report depends on specific loop
numbers that you select. For details, see Generate a Report of CAD
Loop Drawing Generation Errors, page 1028.
• Macros — Available in the Loop Drawings module, on the Reports
menu of the main window. Lists all the SmartPlant Instrumentation
macros. This report provides you with information about every macro
name, description, database name, and function description (if it
exists). This report displays macros for all loop numbers existing in
your database. For details, see Generate a Macro Report, page 1036.
• User-Defined Macro Functions — Available in the Loop Drawings
module, on the Reports menu of the main window. Lists all the
macro functions you created on the basis of SmartPlant
Instrumentation standard macro functions. The macro function affects
the value which the macro returns after generation. For example, you
can specify a user-defined function that removes all the spaces in the
retrieved values and displays the remaining characters as upper case.
This report displays user-defined macro functions for all loop numbers
in your database.
Generate a Report of CAD Loop Drawing Generation Errors

Use this procedure to create a CAD loop drawing generation error report for loop
numbers for which you generated CAD loop drawings.
2. In the tree view pane, right-click a loop for which you want to generate the CAD
loop generation error report.
3. On the shortcut menu, point to Reports and click CAD Loop Drawing
Generation Errors.

Macros in SmartPlant Instrumentation: An Overview

A macro is a text string that is recognized by SmartPlant Instrumentation and is used
to extract data from a given item such as a loop, instrument, panel, strip, and so forth.
Each macro corresponds to specific information available in SmartPlant
Instrumentation database, for example, the color of a wire. SmartPlant
Instrumentation provides you with easy ways to search for the macros that need to be
placed on a drawing block or a symbol. The software also comes with a standard set
of macros that you can customize according to your needs
The type of data that the software can retrieve depends on whether you are working
with loop drawings or hook-up drawings. For loop drawings, you can retrieve data for
the following item types:
• Domain definitions
• Plant hierarchy items
• Documents
• Revision information
• Loop data and instrument tag numbers
• Wiring data (including connection information)
• Process data
• Specifications data
• Loop drawing data
• Hook-up drawing data
For hook-up drawings, you can retrieve data for the following item types:
• Domain definitions
• Plant hierarchy items
• Documents
• Revision information
• Instrument tag numbers
• Process data
• Hook-up drawing data
All of the standard SmartPlant Instrumentation macros are displayed on the Macro
Definitions dialog box.
You can use SmartPlant Instrumentation macros in:

• Enhanced reports — You can add macros to the various symbols

used to represent items that appear in enhanced reports using the
Symbol Editor, or you can add macros directly in an enhanced report
after generation. For further details, see Using Macros: An Overview
in the Enhanced Report Utility User's Guide.
• CAD drawings — To display data in CAD drawings, you must add
them to the blocks that are used in generating the drawings. For
further details, see Using Macros in CAD Blocks: An Overview, page
1037.
Related Topics
• Customizing Macro Definitions: An Overview, page 1040
• SmartPlant Instrumentation Macro Structure, page 1031
• Standard Functions, page 1045
• Working with User-Defined Macro Functions: An Overview, page
1043

SmartPlant Instrumentation Macro Structure

You select the SmartPlant Instrumentation macros that you want the software to
recognize in hook-up drawings or in loop drawings by defining custom macro names
on the Macro Definitions dialog box for the appropriate drawing type. To see the
entire list of SmartPlant Instrumentation macros, you can generate a macro report in
the Loop Drawings module. For details, see Generate a Macro Report, page 1036.
Certain SmartPlant Instrumentation macros that include a group level have the
following structure:
[Macro_name.x]
The letter `x' designates the group level. The group level depends on the number of
macros in a group. The software creates a group when several macros of the same
macro type are associated with a tag number. For example, when associating several
tag categories with a tag number, the system combines all the TAG_CAT macros into
a TAG_CAT.x group so that you set a separate level for each macro: TAG_CAT.1,
TAG_CAT.2, TAG_CAT.3, and so forth.
For CAD drawings only, if desired, you can associate each macro with a macro
function, which determines how the software performs string manipulation on the
target data. For example, a macro function can retrieve the entire target data string or
just part of the data string and display it on the generated drawing. Associating a
macro function with a macro is optional. For details, see Working with User-Defined
Macro Functions: An Overview, page 1043.
The structure of a macro including a user-defined macro function is as follows:

[Macro_name.F1]
where F1 is the macro function abbreviation. If you set a macro function as a default,
the software automatically adds the abbreviation of the function to the macro in the
actual CAD drawings (SmartSketch, AutoCAD and MicroStation). If you do not set
a macro function as default, you need to add the macro function abbreviation
manually on the drawing.
Notes
• The separator in a macro string is a period (.), therefore within a macro
name segment, periods are not allowed.
• Some of the wiring macros have a different structure. For details, see
Wiring Macro Conventions .

Loop Title Block Macros

This topic lists and describes macros used in a loop drawing title block.
Macro Name Description

DWG_NAME Document number
DWG_DESC Drawing description
Revisions
These macros have the structure [MACRO_NAME.XX.F1] where XX is the revision
number (max. value =5), and F1 is the abbreviation for a user-defined function
(optional).

DWG_REV_NUM Drawing revision number
DWG_REV_DESC Revision description
REV_DRAWN_BY Revision by
REV_APPR_BY Approved by
REV_CHK_BY Checked by
DWG_REV_DATE Revision approval date
CURR_REV_NUM Last active revision
Approvals
VEN_PROP_BY Proposed by (vendor)
VEN_PROP_DATE Proposal date (vendor)
VEN_DSGN_BY Designed by (vendor)
VEN_DSGN_DATE Designed date (vendor)
VEN_DRWN_BY Drawn by (vendor)
VEN_DRWN_DATE Drawn on date (vendor)
VEN_CHK_BY Checked by (vendor)
VEN_CHK_DATE Check date (vendor)
VEN_APPR_BY Approved by (vendor)
VEN_APPR_DATE Approval date (vendor)
CL_CHK_BY Checked by (client)
CL_CHK_DATE Check date (client)


CL_ENGR_BY Instrument Eng. check (client)
CL_ENGR_DATE Inst. Eng. check date (client)
CL_APPR_BY Approved by (client)
CL_APPR_DATE Approval date (client)
Document References
You can display references to documents in the title block using the macros
REF_NAME and REF_DESC. It is possible to retrieve to the loop up to ten
references.
To extract the references, use the formats:
[REF_NAME.XX.F1] to get the document number, and [REF_DESC.XX.F1] to get

the document description. The XX segment denotes a two digit number ranging from
1 to 10 and F1 is the abbreviation for a user-defined function (optional).
If you have more than one document number, in the title block, the software sorts the
document numbers by name and displays them in ascending order. For example, if
you have document numbers Document A, Document C, Document B, and Document
A1, the software sorts them as follows:
Document A, Document A1, Document B, Document C
If you need to display only a specific document number , in the macro name
REF_NAME.XX.F1, substitute the XX segment with 01 to display the first number
sorted by name, 03 to display the third number, and so forth.
Drawing Generation Time and Date

DATE Date of generation
TIME Time of generation

Wiring Module Macros - Conventions

To retrieve wiring information, SmartPlant Instrumentation uses macros that are
identified by their macro name, together with appropriate parameters needed to
retrieve specific tag data.
When you create a tag number and a matching device panel, the software creates a
group that includes all the wires associated with that specific tag. Each wire can
belong to one group only. Once you connect a cable with the device panel, the
software sorts the wires into different group levels. Every connection of a wire to a
terminal is assigned a group sequence that maps and numbers the connections
starting with the value `1' that is usually on the device panel side.
The following diagram is an example that explains the meaning of wire groups.
Before you can start to build typical wiring drawing blocks, you need to know:
• How to identify typical wiring routing.

• The number of routing levels, usually determined by the number of
wires connected to the device-panel, but this may be different if, for
example, a power supply is involved.
• The group sequence that each wire and terminal connection has in the
current typical routing.

Syntax
The syntax used for wiring macros is as follows:
[Macro_name.x.y]
where the letter `x' designates the group level and the letter `y' designates the group
sequence.
Examples
The following examples show how the wiring macro syntax is used to retrieve
specific data for a terminal and for a wire:
• To retrieve the number of the terminal at Group Level 1 and Group

Sequence 3, the required macro is TERM_NUM.1.3.
• To retrieve the color of the wire at Group Level 2 and Group Sequence
2, the required macro is W_CLR.2.2.
Notes
• When retrieving data for a wire, you may use the group sequence
corresponding to either of the wire ends, so for example, to extract the
wire name for the wire at Group Level 2 whose ends have sequence
numbers 3 and 4, you may use either macro W_TAG.2.3 or
W_TAG.2.4.
• Control system macros do not require the 'y' (group sequence)
parameter.
• If you generate a loop drawing with tag numbers that have incomplete
wiring, the macros will not be able to retrieve all the needed wiring
information since propagation is bi-directional: from the field device
and from the Control System.
• The software does not order wire sequence numbers sequentially until
the propagation process finds signal continuity between the field
device and the Control System.
• Special macros exist to extract data related to an overall shield. The
macro for a wire that is used as an overall shield has the format
[OSHW_TAG.x.y.] and the macro for a terminal to which an overall
shield is connected has the format [OSHT_NUM.x.y.]. For these
macros to function properly, the following conditions must be met:
• The polarity of the wire must be designated as Shield.
• The level and sequence of at least one of the wires in the cable must be
defined.
• For CAD drawings only, if desired, you can associate each macro with
a macro function, which determines how the software performs string
manipulation on the target data. For example, a macro function can

retrieve the entire target data string or just part of the data string and
display it on the generated drawing. Associating a macro function
with a macro is optional.
The general format of a wiring macro that includes a user-defined
macro function is [Macro_name.x.y.F1].
For further details, see Working with User-Defined Macro Functions:
An Overview, page 1043.
Generate a Macro Report

1. Start the Hook-Ups or Loop Drawings module.
2. Click Reports > Macros.
3. On the Macro Report Print Request dialog box, do one of the following:
• Click No grouping if you want to generate a report in which all the
macros are displayed in alphabetical order.
• Click Group by item type if you want to generate a report in which
the macros are grouped alphabetically by item type.
Tip
• When you group the macros by item type, the software organizes the
report pages according to the module titles.
4. Click OK to generate the report.

Using Macros in CAD Blocks: An Overview

A macro enables you to perform a number of automated actions in a predefined order.
When using a CAD application, macros are used to retrieve data from the database to
a predefined location on the drawing layer. The macros are assigned per block and
the text that they retrieve is eventually displayed as part of the block.
You can assign one or more macros to each block. Some macros are used for
retrieving data for instruments with the same function. For example, flow
transmitters, flow elements, and I/P transducers have a common function. Therefore
the same macros are used to retrieve the data for each of these instruments. The
macros required for each of these instruments are the tag prefix (TAG_PRFX),
instrument type (FUNC_ID), tag number (TAG_NUMC), and tag suffix
TAG_SUFF).
The diagrams below display a loop drawing that was generated along with its related
macros. This example illustrates how the same macros can be used to extract the
same or different data for different tag numbers - the Tag Prefix and Tag Number are
identical for each of the three instruments. However, the instrument type is different,
although represented by the same macro.
Note
• For the instruments in this example, the tag suffix was not used.
Loop Drawing with Macros Generated Loop Drawing
If you have used the standard drawing blocks supplied with SmartPlant
Instrumentation, or if you created your own drawing blocks with the predefined

macros, SmartPlant Instrumentation recognizes these macros when generating the

loop drawings, and you do not need to make any modifications to them. However,
you may want to modify macros in the following circumstances:
• If your drawings include macro names other than the predefined ones,
you can customize the default macro definitions as required. For
details, see Customizing Macro Definitions: An Overview, page 1040.
• If you want to modify certain display formatting of the macros, you
can specify user-defined macro functions. For details, see Working
with User-Defined Macro Functions: An Overview, page 1043.
• If you want to use an external data source other than the SmartPlant
Instrumentation database for displaying information defined by a
macro, you can connect to the appropriate database and use the macros
defined in that database. For details, see Using External Macro Data
Sources: An Overview, page 1049.
Related Topics
• Blocks in SmartPlant Instrumentation: An Overview, page 988
• Macros in SmartPlant Instrumentation: An Overview, page 1029

Insert Macros in an AutoCAD Drawing Block

1. Draw an image using the appropriate CAD application.
2. Perform the following actions for each command line prompt. If you have
finished drawing and want to perform these actions immediately, use the
supported ATT AutoLISP function or do the following:
a. Set AutoCAD system variable AFLAGS = 8
b. For AutoCAD 2000 – 2004, make sure that the AutoCAD system variable
SDI=0.
c. Perform the following actions at the command line prompts:
Command line prompt Action
ATTDEF Press Enter
Attribute modes Press Enter
Attribute Tag: Type in [macro name] and press Enter
Attribute prompt: Press Enter.
Default attribute value Type in [macro name] and press Enter
Justify/Style/<Start point>: Position cursor and click once to define
the bottom left position of the string.
Height: Position cursor and click once to
determine the height of the macro text.
(The height of the macro text is also
dependent on the current font size.)
Rotation angle <0>: Type in a number to represent the angle of
rotation of the macro text from the
horizontal (the default is 0).
Tip
• You can have AutoCAD automatically enter most of the above
parameters by using the ATT AutoLISP application. This application
is automatically installed if you select AutoCAD as your default CAD
interface. By using the ATT application you only need to enter the
macro name once, and enter the start point, height and rotation
parameters.
Related Topics
• Define Insertion Points for Blocks, page 995

Customizing Macro Definitions: An Overview

The database contains a number of default macros predefined for convenience of use
and uniformity. If needed, for any default macro, you can assign one or more custom
macro names or change the macro description on the Macro Definitions dialog box.
You can also associate a macro function with a particular macro name.
Notes
• Other users working in the same domain or in the same project (when
the domain type is Operating owner) can use your customized macro
definitions.
• A macro name can contain a maximum of 30 characters.
• If you want to assign a macro function to a macro directly on a
drawing, you can add a function abbreviation of up to 4 characters to
the macro. The total number of allowed characters, including
separators (periods) is 50.
• To see the entire list of SmartPlant Instrumentation macros, you can
generate a macro report for the type of drawings you are working with
(hook-ups or loop drawings). For more details, see Generate a Macro
Report, page 1036.
Related Topics
• Create a New Macro Definition, page 1041
• Delete a Macro Definition, page 1042
• Using Macros in CAD Blocks: An Overview, page 1037

Create a New Macro Definition

1. From the Hook-Ups or Loop Drawings module, do one of the following:
• Click Tables > Macro Definitions.
• Click .
2. Select the desired macro by choosing the item type and property, and where
applicable, the relation between a specified item type and its parent. To do this,
make a selection from each of the lists at the top of the dialog box.
3. In the Macro definition details data window, select the desired macro definition.
Tip
• If there are a large number of macro definitions in the Macro
definition details data window, under Find macro definition, select a
column heading and then type a value. For example, if you select
Function as a column heading and type a macro function value, in the
data window, the software locates the macro definition to which that
macro function belongs.
4. To create a customized macro definition, do one or more of the following:
a. Under Macro Name, type the desired user name for your macro.
b. Click in the Description field and change the description as desired.
c. Under Function, select a function to modify the appearance of the retrieved
data.
5. To add another customized macro definition, click New and repeat the previous
step.
6. Click Apply to accept your customized macro definitions.
Related Topics

Delete a Macro Definition

• Click .
3. In the Macro definition details data window, select the row containing the macro
definition that you want to delete.
Tip
4. Click Delete.
Related Topics

Working with User-Defined Macro Functions: An

Overview
You can perform string manipulation on retrieved data by assigning user-defined
functions to the macro that retrieved the data. You create user-defined macro
functions on the basis of SmartPlant Instrumentation standard macro functions.
The macro function affects the display formatting of the data which the macro returns
after generation. For example, you can specify a user-defined function that removes
all the spaces in the retrieved values and displays the remaining characters as upper
case.
You can apply functions to macros directly on the CAD drawing or in the database.
Priority for Macro Functions

The order of priority for macro functions is as follows:
1. CAD drawing level — A macro function that you specify at the CAD drawing
level has the highest priority for execution. In this case, you type the macro
function abbreviation directly in the generated drawing in your CAD application.
At this level, you can define one function per macro.
2. Database level — The next highest level of priority for execution is when you
define a function with a specific macro.
3. Database level — The lowest priority for execution is given when you define a
default function. To learn how to set a macro function as default, see Create a
User-Defined Macro Function.
Macro Function Syntax
If you want to apply the highest macro function priority do the data retrieval, you can
associate a function with a macro directly on the CAD drawing block using the
function abbreviation. The function abbreviation is a string with maximum of 4
characters, the first of which must be a letter. The general structure of a macro with a
function is:
[Macro_name.F1]
where F1 is the macro function abbreviation.
The general format of a wiring macro that includes a user-defined macro function is:
[Macro_name.x.y.F1]

Example
The following is an example of a macro with a function:
W_CLR.1.1.RS
In this example, the macro name is W_CLR.1.1 and the macro function is RS
(remove spaces).
Notes
• Use a period (.) as the separator to separate the individual macro
segments.
• The software uses the macro function parameters.
• When using a macro function at the database level, you should not
define that macro function on the drawing block or in the generated
drawing. For the software to recognize macro functions defined at the
database level, on the Preferences dialog box, under Loop Drawings
> General, select the Use macro functions check box. If you set a
macro function as default, the software automatically adds the
abbreviation of the function to the macro in the actual CAD drawings,
and you do not need to add it with every block and macro. If you do
not set a macro function as default, you need to add the macro function
abbreviation manually on the drawing.
Related Topics
• Macros in SmartPlant Instrumentation: An Overview, page 1029

Standard Functions
A standard macro function is a function that is supplied with the software and
contains a set of predefined commands. You can associate a standard function with
SmartPlant Instrumentation macros or specify a combination of standard functions to
create a user-defined macro function.
SmartPlant Instrumentation has six standard macro functions. The following table
shows how each of the standard functions modifies the macro string.
Function Description Resulting String Comments

None Original string FT - 100 a[space][space]
Trim Trims trailing spaces FT - 100 a Does not affect
internal spaces
Upper Changes characters to FT - 100 A[space][space]
upper case
Lower Changes characters to ft - 100 a[space][space]
lower case
Substr (3,5) Returns a substring of - 10 In this
the original string example, the
substring starts
from 3rd
character and
extends to 5
characters
including the
starting
character
RemSpace (1) Clears internal spaces FT – 100 In this
when exceeding the a[space][space] example,
maximum number of where internal
allowed spaces. spaces exist, a
maximum of 1
space is
allowed. Does
not affect
trailing spaces.
RemSpace (0) FT-100a[space][space] No internal
spaces allowed

Standard Function Parameters

Some standard functions require additional parameters in their definitions:
Function Parameters Explanation

Substr Start position
Length The position of the first character of
the sub-string from the start of the
string to be displayed, and the number
of characters to be displayed in the
sub-string
RemSpace Max. contiguous spaces Maximum number of internal spaces
allowed in the string
Note
• You cannot change the code of standard macro functions.
Related Topics
• Working with User-Defined Macro Functions: An Overview, page
1043
Create a User-Defined Macro Function

1. In the Loop Drawings or Hook-Ups module, click Tables > User Defined Macro
Functions.
2. On the User-Defined Macro Functions dialog box, click New to open the User-
Defined Macro Function Properties (New) dialog box.
3. Type a name and abbreviation for the new macro function, and, if desired, a
description.
4. To superpose a standard function, do the following:
a. Click Insert to open the Standard Macro Functions dialog box.
b. Select a standard function and click OK.
c. If you selected a standard function that can accept parameters, specify
appropriate values in the fields. For details, see Standard Functions, page
1045.
Tip
• The user-defined macro function operates in the macro string
according to the order of the standard functions superposition. Use
Move Up and Move Down to change the order of the standard
functions.
5. Click OK to confirm your changes and close the User-Defined Macro Function
Properties (New) dialog box.


• Select Set macro function as default to apply the specified macro
function to all existing macros.
• Clear Set macro function as default to be able to associate the
specified macro function with a specific macro.
Related Topics
• Delete a User-Defined Macro Function, page 1048
• Modify a User-Defined Macro Function, page 1047
Modify a User-Defined Macro Function

Functions.
2. On the User-Defined Macro Functions dialog box, select the row with the macro
function you want to modify, and click Properties to open the User-Defined
Macro Function Properties dialog box.
3. Modify the macro function properties as desired.
4. To superpose or change a standard function, do the following:
a. Click Insert to open the Standard Macro Functions dialog box.
b. Select a standard function and click OK.
c. If you selected a standard function that can accept parameters, specify
appropriate values in the fields. For details, see Standard Functions, page
1045.
Tip
• The user-defined macro function operates in the macro string
according to the order of the standard functions superposition. Use
Move Up and Move Down to change the order of the standard
functions.
5. Click OK to confirm your changes and close the User-Defined Macro Function
• Select Set macro function as default to apply the specified macro
function to all existing macros.
• Clear Set macro function as default to be able to associate the
specified macro function with a specific macro.
Related Topics
• Delete a User-Defined Macro Function, page 1048

Delete a User-Defined Macro Function

Functions.
2. On the User-Defined Macro Functions dialog box, select the row with the macro
function you want to delete.
3. Click Delete.
Related Topics
• Modify a User-Defined Macro Function, page 1047

Using External Macro Data Sources: An Overview

You can use macros from an external source with the macros in your domain. This
means that macro sources that are both external and internal in relation to SmartPlant
Instrumentation are used when you generate a loop drawing.
Working with external macro sources includes the following steps:

1. Establishing a connection to an external data source from which SmartPlant
Instrumentation can retrieve macro data.
2. In the Domain Explorer, assigning the connected external data source to the loop
numbers for which you want to generate loop drawings.
Important
• Before you start working with external macro data sources, make sure
that the external source data naming and structure conventions comply
with the SmartPlant Instrumentation macro conventions. For details,
see External Macro Structure Conventions, page 1051 and External
Macro Naming Conventions, page 1050.
Related Topics
• Assigning an External Macro Data Source, page 1056
• Connecting to an External Data Source, page 1052

External Macro Naming Conventions

The macro names for external macros in a drawing must be identical to the names in
the external database file or table.
Notes
• To be able to use an external macro source, you need to establish a
connection to the macro source in the Define External Macro Source
dialog box.
• In your target drawing blocks or symbols, you need to add the E_
prefix to the name of the macro that you want to use to retrieve data
from the external macro source.
For example, if a drawing contains an external macro named PROCESS which is
used to retrieve the string `Flow', the macro label must be written as E_PROCESS.
This means that after generation, every occurrence of the label E_PROCESS in the
drawing will be replaced with the value Flow.
Related Topics
• External Macro Structure Conventions, page 1051

External Macro Structure Conventions

SmartPlant Instrumentation has set a few basic requirements regarding the structure
of external data sources from which you add macros to your loop drawings.
Therefore, before you use an external macro make sure that its structure complies
with SmartPlant Instrumentation conventions. The structure has to include the tag
number (cmpnt_name) as the first (leftmost) column, and occupying the rest of the
columns, the desired macros and their retrieval values.
The following table is an example of an external source structure (the table headers
below exemplify column names):
cmpnt_name macro1 macro2 macro3

108-PI -2212 Pressure Bar Indicator
108-FE -2225 Flow Ft3/s Element
In the above example, using the macro macro1 in a loop drawing generated for
instrument tag 108-PI-2212, will display the retrieved value Pressure instead of the
macro1 string. You can create the above structure by using any text editing
application (for Text format files), dBase (*.dbf) editing tools, or any other
appropriate database editing utility. For further details, see the user's guide for your
database platform.
Important
• The name of the first (leftmost) column name must always be
cmpnt_name (representing the tag number).
Related Topics
• External Macro Naming Conventions, page 1050

Connecting to an External Data Source

The first stage is connecting to the appropriate source data form whose macro data
you want to use. After connecting to the database or the database file you can
generate CAD drawings using the retrieved macros as required.
You can connect to any of the following database platforms and files:
• Oracle (only if you have selected Oracle as your current database

platform during Setup or you installed an Oracle client manually)
• Microsoft SQL Server (only if you have select SQL Server as your
current database platform during Setup or you installed a SQL Server
client manually)
• Sybase Adaptive Server Anywhere (only if you have selected Sybase
Adaptive Server Anywhere as your current database platform during
Setup or you installed a Sybase Adaptive Server Anywhere client
manually)
• Microsoft Access
• *.dbf
• ASCII delimited files
• Excel worksheets
• Text files
The currently available database profiles (in the Data Source list) are those that you
have installed with the installation and those that you have manually installed.
Note
• You can connect to database platforms (Oracle, SQL Server or Sybase
Adaptive Server Anywhere) other than your current database platform
but you have to comply with the external database platform
requirements.
For example, If your current database platform is Sybase Adaptive Server
Anywhere and you want to import data from an Oracle database platform, you
must have Oracle client installed and running on your computer. See Internal
Setup Utility to learn how to configure your environment to connect to database
platforms other than your current database platform.
Related Topics
• Connecting to an ODBC Profile, page 1054
• Connecting to Database Platforms Other Than ODBC, page 1055
• External Macro Structure Conventions, page 1051

Prerequisites for Connecting to a dBase ODBC

Profile
You can generate loop drawings in SmartPlant Instrumentation using your dBase
(.dbf) external macro source. Prior to connecting to dBase (.dbf) external macro
source, you need to create a dBase ODBC profile in accordance with the driver
requirements of your Windows system.
The following prerequisites apply:
• In your ODBC Data Source Administrator, select the ODBC driver in

accordance with your Windows system:
• For Windows XP — use Microsoft dBase Driver
• For Windows 2000 — use PB Intersolv 2.12 32-BIT dBASEFILE
(*.dbf)
• Create an ODBC profile using your Windows ODBC Data source
Administrator. For further details, see the user's guide for your
database platform.
Related Topics
• Connecting to an ODBC Profile, page 1054

Connecting to an ODBC Profile

This procedure describes the steps required to connect to a database file (for example,
.dbf, ASCII, and so forth) using the ODBC profile. This way you can generate your
CAD drawings using macros from an external macro source.
The following file types are available:
• dBase (.dbf)
• Text files
Note
• If you want to connect to dBase (*.dbf), you must create an ODBC
profile in accordance with your Windows system. For more details,
see Prerequisites for Connecting to a dBase ODBC Profile, page 1053.
Connect to an ODBC Profile

1. Click Actions > Define External Macro Source.
2. On The Define External Macro Source dialog box, from the Database type list,
select ODBC.
3. From the Data source list, select the source database file profile, for example,
.dbf, ascii files, and so forth.
4. Click Browse and select macro source file.
Related Topics

Connecting to Database Platforms Other Than

ODBC
This procedure describes the steps required to connect to a database platform such
as Oracle or SQL Server. To connect to an external database platform, you must have
access rights to the database server as well as the appropriate database drivers. You
must also have the appropriate settings in the configuration files (for example, .ini
files) and in the Windows registry.
Connect to Database Platforms Other Than ODBC

1. Click Actions > Define External Macro Source.
2. In The Define External Macro Source dialog box, from the Database type list,
select the source database platform: Oracle or SQL Server.
3. In the Server box, type the name of the server that you use to connect to the
database server:
• <alias name> — if you connect to Oracle
• <server name> — if you connect to SQL Server
4. In the Database schema logon name box, type the logon name required to
connect to the source domain in the database server.
5. In the Database schema logon password box, type the logon password required
to connect to the source domain in the database server.
Related Topics

Assigning an External Macro Data Source

This procedure enables you to assign an external macro data source to one or more
loop numbers.
Notes
• To be able to use an external macro source, you need to establish a
connection to the macro source in the Define External Macro Source
dialog box.
• In your target drawing blocks or symbols, you need to add the E_
prefix to the macros which you want to use to retrieve data from an
external macro source.
Assign an External Macro Data Source to One or More Loop

Numbers
• In the tree view pane, right-click a desired loop.
• Items pane, select and right-click several loops.
3. On the shortcut menu, point to Actions and click Assign External Macro
Source.
4. Under the Macro Source column, do one of the following:
• If your macro source is an ODBC profile, type the exact path and the
file name of the source database file.
• If your macro source is a specific table on Oracle or SQL Server, you
need to type the exact table name.
Tip
• If you want to assign the same macro source to all the loop numbers
displayed in the Assign External Macro Source dialog box, select a
row with the desired macro source and then select Apply same source
to all displayed loop numbers.
Related Topics
• Using External Macro Data Sources: An Overview, page 1049

Hook-Ups in SmartPlant Instrumentation

In SmartPlant Instrumentation, you can create, view and edit installation details for all
prepared instrument drawings (hook-ups) within a domain. You can perform various
actions using the Hook-Ups module, in the Reference Explorer, and the Domain
Explorer.
In the Hook-Up Item Libraries folder of the Reference Explorer, you define your
item libraries, create and manage hook-up items. You need to set one specific library
as the active item library, which becomes your <plant> default library. The
completeness of this library is up to the user.
In the Hook-Ups folder of the Domain Explorer, which depicts the hierarchy of
hook-up data, you can organize hook-ups in hook-ups types and associate hook-ups
with instrument tags and hook-up items. You can determine the name of each hook-
up and hook-up type based on your specific requirements. After that, you can
generate hook-up drawings using the Enhanced Report Utility or your CAD
application.
Using the Hook-Ups module options, you generate various hook-up reports and a Bill
of Material, define hook-up item manufacturers, make hook-up macro definitions,
and so forth.
Related Topics
• Hook-Up Drawing Generation: An Overview, page 1080
• Hook-Up Reports: An Overview, page 1096
• Managing Hook-Up Drawings Common Tasks, page 1082
• Managing Hook-Up Items and Libraries Common Tasks, page 1060
• Managing Hook-Ups Common Tasks, page 1070

Hook-Up Items: An Overview

A hook-up drawing is made up of individually marked parts called items. These
items have to be purchased. The service that a Bill of Material provides you with
depends upon how completely you fill in the hook-up item library. The minimum
amount of data required to provide is the item number. Entering more data is left to
your discretion.
SmartPlant Instrumentation allows you to define a large number of hook-up items and
group them in item libraries and sub-libraries. You create and manage item libraries
in the Reference Explorer. A new item library that you create automatically
contains a default sub-library, which you can use for assigning hook-up items if you
do not work with pipe specs. For more information on implementation of pipe specs
in SmartPlant Instrumentation, see Pipe Specs: An Overview, page 939. When
defining a new item in SmartPlant Instrumentation, you can enter a number of hook-
up item properties, such as item size, model, material, storage number, unit of
measure, and so forth. Also, it is possible to define hook-up item manufacturers in
the Item Manufacturers the supporting table and then assign the appropriate
manufacture to the item.
You must set one item library as the active item library for your <plant>. After you
create hook-up items in this library, you can use the Domain Explorer options to
associate the appropriate sub-library with hook-ups, and then, associate specific items
with these hook-ups. After making the associations, you can generate Hook-Up Item
List reports and a Bill of Material. In the Bill Of Material, you can sort the items by
the item order. After associating hook-up items with a hook-up, the software
generates new sequence numbers automatically and allows you to sort the items by
their order of their assignment to a hook-up.
In the Reference Explorer, hook-up items are displayed in the Hook-Up Item
Libraries folder, under sub-libraries. In the Domain Explorer hook-up items are
displayed in the Hook-Ups folder, under hook-ups. Hook-up items are indicated with
the icon.
Related Topics
• Hook-Up Item Libraries and Sub-Libraries: An Overview, page 1059

Hook-Up Item Libraries and Sub-Libraries: An

Overview
An item sub-library is a term which refers to a part of an item library and contains a
specific set of hook-up item data and associations. You create and manage item
libraries in the Reference Explorer, where item libraries are indicated with the
icon. An item library can contain any number of user-defined sub-libraries that you
can use when working with pipe specs. A new item library that you create
automatically contains a default sub-library, which you can use for assigning hook-up
items if you do not work with pipe specs. For more information on implementation
of pipe specs in SmartPlant Instrumentation, see Pipe Specs: An Overview, page 939.
Sub-libraries are indicated with the icon.
You must set one item library as the active item library for your <plant>. After you
create hook-up items in this library, you can associate the appropriate sub-library with
hook-ups, and then, associate specific items with these hook-ups. In the Reference
Explorer, the active item library is indicated with the icon.
Related Topics
• Hook-Up Items: An Overview, page 1058

Managing Hook-Up Items and Libraries Common

Tasks
These tasks deal with creating and managing hook-up item libraries, sub-libraries,
and hook-up items in the Reference Explorer.
Create an Item Library

This procedure describes how to create a new item library. An item library contains
fittings and associations created on a domain level. Therefore, when you enter a
domain, you can have any number of relevant libraries. The number of libraries,
names, and completeness are all up to your requirements. An item library can also
contain any number of user-defined sub-libraries that you can use when working with
pipe specs. A new item library that you create automatically contains a default sub-
library, which you can use for assigning hook-up items if you do not work with pipe
specs. For more information, see Create an Item Library, page 1062.
Create User-Defined Sub-Libraries

Use this procedure to create user-defined sub-libraries in the library set as the active
item library. You can also assign pipe specs to user-defined sub-libraries. For more
information, see Create User-Defined Sub-Libraries, page 1063.
Set an Item Library As the Active Item Library

The active item library is the <plant> default item library. You must set a specific
library as the active item library to be able to assign the library items to hook-ups.
The information is filled in to pick out parts of a specific hook-up. You can also enter
description, material, rating, and so forth, to provide as much information as possible
for the Bill of Material that the software creates based on this data. For more
information, see Set an Item Library As the Active Item Library, page 1064.
Create a Hook-Up Item

Use this procedure to create a hook-up item under the default or user-defined sub-
library. For more information, see Create a Hook-Up Item, page 1064.
Create Hook-Up Items in Batch Mode

Use this procedure to create several hook-up items in the default sub-library of a
specific hook-up library. For more information, see Create Hook-Up Items in Batch
Mode, page 1065.
Sort Hook-Up Items in a Sub-Library

Use this procedure to sort the hook-up items defined in a specific sub-library. For
more information, see Sort Hook-Up Items in a Sub-Library, page 1066.

Associate Items with User-Defined Sub-Libraries

Use this procedure to assign items that exist in the default sub-library to a user-
defined sub-library. For more information, see Associate Items with User-Defined
Sub-Libraries, page 1066.
Remove Items from a User-Defined Sub-Library

Use this procedure to remove one or more items from a user-defined sub-library.
When removing the items, the software only dissociates them from that sub-library
but does not delete them from the parent hook-up item library. For more information,
see Remove Items from a User-Defined Sub-Library, page 1067.
Delete Hook-Up Items

Use this procedure to delete one or more hook-up items from a specific hook-up item
library. For more information, see Delete Hook-Up Items, page 1068.
Delete Hook-Up Sub-Libraries

Use this procedure to delete an empty user-defined sub-library from the parent hook-
up item library. For more information, see Delete Hook-Up Sub-Libraries, page
1069.
Related Topics
• Hook-Ups in SmartPlant Instrumentation: An Overview, page 1057

Create an Item Library

1. Press F8 to open the Reference Explorer, and right-click the Hook-Up Item
Libraries folder.
2. On the shortcut menu, click New > Item Library.
3. Type a unique name for the item library and an optional description.
4. Click OK.
Tips
• On creating the item library, the software automatically creates the
default sub-library under the library.
• You can create a hook-up library by duplicating an existing library.
When duplicating the library, the software also duplicates all the sub-
libraries and the items that are associated with the sub-libraries. If a
library contains a large number of sub-libraries and hook-up items, the
duplication process might take time.
Related Topics

Create User-Defined Sub-Libraries

1. Press F8 to open the Reference Explorer, and expand the hierarchy to the item
library level in the Hook-Up Item Libraries folder.
2. Right-click the item library.
3. On the shortcut menu, click New > Item Sub-Library.
4. Type a unique name for the item sub-library and an optional description.
Tip
• You can click Pipe Specs and assign pipe specs to the sub-library you
are creating. If you have not defined pipe specs yet, you can create the
sub-library first and assign pipe specs at a later stage.
5. Click OK to create the sub-library.
Tip
• It is possible to create more than one sub-library by duplicating several
existing user-defined sub-libraries that you can select in the Items
pane. To display the sub-libraries in the Items pane, in the tree view
pane, select the parent item library. When duplicating a user-defined
sub-library, the software also duplicates all of the hook-up items that
exist in that sub-library. You cannot duplicate the default sub-library.
Related Topics

Set an Item Library As the Active Item Library

1. In the Reference Explorer, expand the Hook-Up Item Libraries folder.
2. Right-click a library that you require.
3. On the shortcut menu, click Actions > Set As Active item Library.
Tips
• You can only set one library as the active item library for your
<plant>. If another item library has been set as the active item library,
the software dissociates the hook-ups from the previous active library
and assigns the default sub-library of the new active library to all the
hook-ups in your <plant>.
• In the Reference Explorer, the library icon changes from to .
Related Topics
Create a Hook-Up Item

2. Double-click the item library to display the item sub-libraries.
Tip
• The default sub-library exists in every library that you create. In
addition, you can create user-defined sub-libraries if you want to
associate pipe specs to hook-ups.
3. Right click the default or user-defined sub-library.
4. On the shortcut menu, click New > Hook-Up Item.
5. Type a unique name for the hook-up item and define other properties as needed.
6. Click OK to create the hook-up item.
Tip
• If you created a new item in a user-defined sub-library, this item
automatically appears in the default sub-library too.
Related Topics
• Create Hook-Up Items in Batch Mode, page 1065

Create Hook-Up Items in Batch Mode

2. Double-click the item library to display the item sub-libraries.
Tip
• The default sub-library exists in every library that you create. In
addition, you can create user-defined sub-libraries if you want to
associate pipe specs to hook-ups.
3. Right click the default sub-library.
4. On the shortcut menu, click Actions > Batch Item Creation.
5. Under Number of items to create, use the spinner to enter the number of the
hook-up items you want to create under the default sub-library.
6. In the Prefix box, type an optional prefix you want to assign to the batch of the
items you are about to create.
7. In the Start from number box, type the starting number you want to append to
the name of the first item in the batch.
Tip
• If you leave the Start from number box empty, after you click OK,
the software automatically appends 0 (zero) to the name of the first
item in the batch.
8. In the Increment by box, use the spinner to change the incrementing value as
needed.
Tip
• The default value in the Incremented by box is 1. When using the
default value, to ensure item name uniqueness within the current
default sub-library, the software increments every subsequent item
number in the batch of items by one digit. you can change this value
as needed. For example, if your want to create three items with prefix
MyItem, the Start from number value 5, and the Increment by
value 2, the software creates the following items: MyItem5,
MyItem7, and MyItem9.
9. Click OK to open the Hook-Up Item Properties dialog box, where you can
define properties for each item and complete the item creation.
Related Topics

Sort Hook-Up Items in a Sub-Library

1. In the tree view of the Reference Explorer, select and right-click a sub-library.
2. On the shortcut menu, click Sort.
3. From the Item type list, select Hook-Up Item.
4. Under Available Property, select a property you want to use for sorting hook-up
items, for example Item Number.
5. Drag this property to the Sort Property pane, select the check box and click OK.
Tip
• The software sorts the items that start with a numeric character first.
For example, if you sort by item number items whose numbers are
5,1,A,4,AA,BB,A,AB,2,3, these items appear in descending order as
follows: 1,2,3,4,5,A,AA,AB,B.
Related Topics
Associate Items with User-Defined Sub-Libraries

following:
• In the tree view pane, select an item library and then, in the Items
2. On the shortcut menu, click Actions > Associate Items with Sub-Libraries.
Tips
• On the dialog box that opens, the software displays all the items
available in the default sub-library of the library you selected. You
can set a filter to display only those items that you require for
association. In the filter that you require in not available in the Filter
available items list, you can click and define a new filter.
• In the dialog box panes, you can double-click a column header in the
to sort the items in ascending order. Double-click again to sort the
items in descending order.
• In the dialog box panes, there is a vertical bar that you can drag to the
right and view your data in a split display. To find the vertical bar,
place the cursor to the left of the left scroll box arrow so that the cursor

changes its shape as shown:
.
3. Under Available items, select one or more hook-up items and do one of the
following:
• Drag the selected items to the Associated items pane.
Explorer, click Next to display another sub-library and associate hook-up items
as you require.
Tip
• You can associate the same items with more than one user-defined
sub-library.
Related Topics
Remove Items from a User-Defined Sub-Library

following:
• In the tree view pane, select an item library and then, in the Items
2. On the shortcut menu, click Actions > Associate Items with Sub-Libraries.
Tips
available in the default sub-library of the library you selected. You
can set a filter to display only those items that you require for
association. In the filter that you require in not available in the Filter
available items list, you can click and define a new filter.

.
3. Under Associated items, select one or more hook-up items and do one of the
following:
• Click Dissociate.
• Drag the selected items to the Available items pane.
Explorer, click Next to display another sub-library and dissociate hook-up items
as you require.
Related Topics
Delete Hook-Up Items

sub-library level in the Hook-Up Item Libraries folder.
2. In the tree view pane, do one of the following:
• Double-click the default sub-library from which you want to delete a
specific item, and then, select and right-click a specific item you want
to delete.
• Select the default sub-library from which you want to delete one or
more items, and then, in the Items pane, select and right-click items
you want to delete.
Tips
• The software only allows you to delete those items that are not
associated with hook-ups.
• If you created user-defined sub-libraries, the software automatically
deletes the items from all the sub-libraries that exist in the library.
You can also perform item deletion from a user-defined sub-library.
Related Topics

Delete Hook-Up Sub-Libraries

1. Press F8 to open the Reference Explorer, and double-click the Hook-Up Item
Libraries folder.
2. Select an item library to display its sub-libraries in the Items pane.
3. In the Items pane, select and right-click one or more user-defined sub-libraries.
Tip
• You can only delete empty user-defined sub-libraries that exist in the
library.
Related Topics

Managing Hook-Ups Common Tasks

These tasks deal with creating and managing hook-ups and hook-up types in the
Domain Explorer. Also, these tasks describe various association procedures you
need to perform, for example, association of instrument tags to hook-ups, association
of items to hook-ups, and so forth.
Create a Hook-Up Type

This procedure describes how create a hook-up type. A hook-up type is a common
name of group of hook-ups that share distinguishing characteristics common to one
kind of instrument. These characteristics set one hook-up type apart from another
type, for example Flow, Temperature, Level, and so forth. You can only create one
hook-up type at a time. For more information, see Create a Hook-Up Type, page
1072.
Create Hook-Ups
Use this procedure to add one or more hook-ups to existing hook-up types. A hook-
up is a graphical representation of an assembly drawing — a drawing prototype.
Adding a hook-up to a hook-up type is a prerequisite for assigning instruments tags to
hook-ups. For more information, see Create Hook-Ups, page 1072.
Associate Hook-Up Types with Instrument Types

Use this procedure to assign one or more hook-up types an instrument type. Your
database can contain a seemingly endless number of tag numbers. To make the task
of attaching multiple instruments to a specific hook-up type manageable, use a filter
that allows you to assign any instrument type in the current domain to your hook-up
type.. For more information, see Associate Hook-Up Types with Instrument Types,
page 1073.
Associate Instrument Tag Numbers with Hook-Ups

Use this procedure to assign one or more tag numbers to one or more hook-ups. The
hook-ups can belong to the same or different hook-up types. For more information,
see Associate Instrument Tag Numbers with Hook-Ups, page 1074.
Move Hook-Ups to Another Hook-Up Type

This procedure enables you to move all hook-ups from one or more hook-up types to
another existing hook-up type. For more information, see Move Hook-Ups to Another
Hook-Up Type, page 1075.
Associate Hook-Ups with a Sub-Library

Use this procedure to associate a hook-up with a user-defined sub-library or to
change the existing hook-up sub-library assignment.

You can associate a hook-up with a sub-library when performing the following
activities:
• Adding a new hook-up to a hook-up type — You can assign any new
hook-up to any sub- library.
• Editing properties of an existing hook- up
• Duplicating a hook-up
When editing or duplicating hook-up properties, you can change the existing
association of a hook- up sub-library under the following conditions:
• If the hook-up has associated instrument tags with pipe spec data, the
target user-defined sub-library must also have pipe specs suitable for
association of these tags.
• The target user-defined sub-library must contain all hook-up items that
are associated with the hook-ups.
For more information, see Associate Hook-Ups with a Sub-Library, page 1075.
Associate Items with Hook-Ups

This procedure enables you to associate one or more items with hook-ups. You can
only associate those items that exist in the sub-library assigned to the hook-ups that
you select in the Domain Explorer. In hook-up drawings that you generate, the
associated items are displayed as the identifying. For more information, see
Associate Items with Hook-Ups, page 1076.
Dissociate Items from Hook-Ups

Use this procedure to dissociate one or more items from a hook-up. You must
dissociate an item from a hook-up prior to deleting this item from the active item
library. For more information, see Dissociate Items from Hook-Ups, page 1077.
Dissociate Tag Numbers from Hook-Ups

Use this procedure to dissociate one or more instrument tags from a hook-up. You
must dissociate all instruments from a hook-up prior to deleting this hook-up. For
more information, see Dissociate Tag Numbers from Hook-Ups, page 1078.
Delete Hook-Ups
This option enables you to delete a hook-up which is not associated with any tag
numbers. If an association exists, first dissociate the tag numbers from this hook-up
and then delete the hook-up. For more information, see Delete Hook-Ups, page 1079.
Delete Hook-Up Types

This option enables you to delete one or more hook-up types which are not associated
with any hook-ups. To delete a hook-up type that contains hook-ups, first delete the
hook-ups or move them to another hook-up type. For more information, see Delete
Hook-Up Types, page 1079.

Create a Hook-Up Type

1. Press F7 to open the Domain Explorer, expand the hierarchy and right-click the
Hook-Ups folder.
2. On the shortcut menu, point to New and click Hook-Up Type.
3. In the Hook-Up Type Properties dialog box, type a unique hook-up type name
and an optional description.
4. Click OK.
Related Topics
Create Hook-Ups
1. Press F7 to open the Domain Explorer and do one of the following:
• Right-click the Hook-Ups folder.
• Double-click the Hook-Ups folder and then, in the Items pane, select
and right-click the hook-up type to which you want to add a new hook-
up.
2. On the shortcut menu, click New > Hook-Up.
3. If you right-clicked the Hook-Ups folder, from the Hook-up type list, select the
target hook-up type.
4. In the appropriate boxes, enter a unique name for the new hook-up and an
optional description.
5. Type a unique name for the item sub-library and an optional description.
6. From the Item sub-library list, select a sub-library to which you want to assign
the hook-up.
Tip
• If you do not work with user-defined sub-libraries, the software
assigns the hook-up to the default sub-library automatically. If you
work with user-defined sub-libraries, we recommend that you read the
topic Associate Hook-Ups with a Sub-Library, page 1075.
7. Beside Drawing block file name and path, click Browse to navigate to the
drawing block file name and path.
Tips
• Click View to open the selected drawing in the CAD application
installed on your computer.

• The path setting that appears in the Generation output path box is the
path that you specified in the Generate Hook-Up Drawings dialog
box. The software only displays the path if you already generated a
hook-up drawing for the source hook-up.
8. Click OK to create the hook-up.
Tip
• It is possible to create more than one hook-up by duplicating several
existing hook-ups that you can select in the Items pane. To display
the hook-ups in the Items pane, in the tree view pane, select the parent
hook-up type or the Hook-Ups folder. When duplicating a hook-up,
the software also duplicates all of the hook-up items that are associated
with the source hook-ups.
Related Topics
Associate Hook-Up Types with Instrument Types

2. In the tree view pane, do one of the following:
• Select and right-click a specific hook-up type.
• Select the Hook-Ups folder and then, in the in the Items pane, select
and right-click one or more hook-up types.
3. On the shortcut menu, click Actions > Associate with Instrument Types.
Tips
• On the dialog box that opens, the software displays all the instrument
types defined in the current domain. You can associate the same
instrument type with more than one hook-up type.
4. Under Available instrument types, select one or more instrument types and do
• Drag the selected items to the Associated instrument types pane.
5. If you selected more than one hook-up type in the Domain Explorer, click Next
to display another hook-up type and associate instrument types as you require.

Associate Instrument Tag Numbers with Hook-Ups

type level in the Hook- Ups folder.
• In the tree view pane, select a hook-up and then, In the Items pane,
select and right-click one or more hook- ups.
• In the tree view pane, select the hook- up hierarchy root node to
display all the existing hook-up types in the Items pane, and then, in
the Items pane, right-click one or more hook-up types.
Tip
• When selecting a hook-up type or several hook-up types, you can
associate tags with multiple hook-ups that belong to different hook-up
types. If you select a specific hook-up, you can only assign tag
numbers to the selected hook- up.
3. On the shortcut menu, click Actions and click Associate Tag Numbers with
Hook-Ups.
4. Under Instrument type assigned to hook-up type, select an instrument type by
which you want to filter tag numbers in the Available tag numbers pane.
Tips
.
• Under Available tag numbers, tags displayed in italics indicate tags
that are already assigned to another hook-up. You can still associates
these tags with the current hook-up. Click the Hook-Ups button above
the Available tag numbers pane to display tag numbers available for
association with hook-ups and also display existing hook-up
associations.
• If the specified hook-up is assigned to a user-defined sub-library with
pipe specs, the software filters the tag numbers so that only tag
numbers with the appropriate pipe spec data are displayed. The
software only displays tag numbers whose pipe spec data fits the pipe
specs assigned to the sub-library to which the hook-up belongs.

• You can display the available tag numbers either on the highest or
lowest level of your plant hierarchy defined by the Domain
Administrator. The default highest level is Plant. The default lowest
level is Unit.
5. Under Available tag numbers, select one or more tags and do one of the
following:
• Drag the selected tags to the Associated tag numbers pane.
6. If you selected more than one hook-up or hook-up type in the Domain Explorer,
click Next and make associations for another hook-up.
Related Topics
• Generate a Hook-Up Tag List Report, page 1101
Move Hook-Ups to Another Hook-Up Type

1. Press F7 to open the Domain Explorer, and double-click the Hook-Ups folder to
display all the existing hook-ups types and hook-ups in the Items pane.
2. In the Items pane, select and right-click hook-ups that you want to move to
another hook-up type.
3. On the shortcut menu, click Actions > Move Hook- Ups.
4. On the dialog box that opens, select the target hook-up type and click OK.
Related Topics
Associate Hook-Ups with a Sub-Library

1. Press F7 to open the Domain Explorer, and double-click the Hook-Ups folder.
• In the tree view pane, right-click a specific hook-up.
• In the Items pane, select and right-click one or more hook-ups.
4. On the Hook-Up Properties dialog box, from the Item sub-library list, select a
desired sub-library.
Tips
• The Item sub-library contains all sub-libraries you defined in the
active item library in the Reference Explorer, where the active library
is indicated with the icon. If you set another library as the active

item library, the software automatically assigns the default sub-library

of the new active item library to all the existing hook-ups.
• If you assigned the hook-up to one of the user-defined sub-libraries,
you can click Pipe Specs to display the pipe specs you associated with
the selected user-defined sub-library in the Reference Explorer.
Related Topics
Associate Items with Hook-Ups

• In the tree view pane, select a hook-up type and then, in the Items
pane, select and right-click one or more hook- ups.
• In the tree view pane, select the Hook-Ups folder to display all the
existing hook-up types and hook-ups in the Items pane, and then, in
the Items pane, right-click one or more hook-up types or hook-ups.
3. On the shortcut menu, click Actions > Associate Items with hook-Ups.
Tips
available in the library you set in the Reference Explorer as the active
item library.
.
4. Under Items available for association, select one or more hook-up items and do
• Drag the selected items to the Associated items pane.

Tip
• After associating hook-up items with a hook-up, the software
generates new sequence numbers automatically and displays the
numbers in the Order column, where you can sort the items by their
order of their assignment to a hook-up. You can type a new sequence
number if needed. You can open a Bill Of Material and sort the items
by the item order. For more information, see Sort Data in a Bill of
Material, page 1100.
Related Topics
• Generate a Hook-Up Item List Report, page 1100
Dissociate Items from Hook-Ups

• In the tree view pane, select a hook-up type and then, in the Items
pane, select and right-click one or more hook- ups.
3. On the shortcut menu, click Actions > Associate Items with hook-Ups.
Tips
• On the dialog box that opens, under Associated items, you can
double-click a column header in the to sort the items in ascending
order. Double-click again to sort the items in descending order.
• In the Associated items pane, there is a vertical bar that you can drag
to the right and view your data in a split display. To find the vertical
bar, place the cursor to the left of the left scroll box arrow so that the
cursor changes its shape as shown:
.
4. Under Associated items, select one or more hook-up items and do one of the
following:
• Click Dissociate.
• Drag the selected items from the Associated items pane to the Items
available for association pane.

Dissociate Tag Numbers from Hook-Ups

type level in the Hook- Ups folder.
• In the tree view pane, select a hook-up and then, In the Items pane,
select and right-click one or more hook- ups.
• In the tree view pane, select the hook- up hierarchy root node to
display all the existing hook-up types in the Items pane, and then, in
the Items pane, right-click one or more hook-up types.
3. On the shortcut menu, click Actions and click Associate Tag Numbers with
Hook-Ups.
Tips
.
4. Under Associated tag numbers, select one or more tags and do one of the
following:
• Drag the selected tags to the Available tag numbers pane.
5. If you selected more than one hook-up or hook-up type in the Domain Explorer,
click Next and dissociate tag numbers from another hook-up.
Related Topics

Delete Hook-Ups
• In the tree view pane, select a specific hook-up you want to delete.
• In the tree view pane, select a hook-up type, and then, in the Items
Tip
• When deleting hook-ups, the software automatically dissociates all the
hook-up items and instrument tags.
Related Topics
Delete Hook-Up Types

• In the tree view pane, right-click a hook-up type that does not have
hook-ups.
• In the Items pane, select and right-click several hook-up types that do
not have hook-ups.
Related Topics

Hook-Up Drawing Generation: An Overview

You can generate a hook-up drawing using either the Enhanced Report Utility or an
external CAD application such as SmartSketch, AutoCAD, or MicroStation.
Generated drawings contain the hook-up block drawing, the list of assigned tag
numbers, and hook-up items associated with the current hook-up.
CAD Hook-Up Drawing Generation Scenario

1. On the Preferences dialog box, on the Hook-Ups > File Locations page, define
the CAD paths for hook-up drawings.
2. If you require a global border and logo, in your CAD application, prepare a
drawing border and logo, and then, enable the use of it in SmartPlant
Instrumentation. For details, see Assign Border and Logo Blocks to Hook-Up
Drawings, page 1088.
3. In your CAD application, create a general drawing (optional). You only need to
create such a drawing if you intend to use the General drawing option of
SmartPlant Instrumentation when generating a hook-up drawing that contains
more than one page. Then, on the SmartPlant Instrumentation Preferences dialog
box , on the Hook-Ups > General page, specify the general drawing that you
want to appear on the second and all other subsequent pages of the hook-up
drawing you will generate.
Tip
• A generated hook-up drawing contains more than one page if the
number of tag numbers associated with the selected hook-up is greater
than the number of macros that can be accommodated on the first
hook-up drawing page. Your general drawing will appear on the
second and all other subsequent pages of the hook-up drawing
generated from SmartPlant Instrumentation.
4. On the Preferences dialog box, on the Hook-Ups > General page, set the
revision display order.
Tip
• You can display a number of revisions in the title block of a hook-up
drawing. Each revision is represented by a numbered macro and the
revisions are displayed in the order of the macro numbering, beginning
with the first revision (ascending order) or the last revision
(descending order). If the total number of revisions is greater than the
number of lines available for display in the drawing and you want to
see the latest revisions, you should select to display the revisions in

5. In your CAD application, create a hook-up drawing template using your CAD
application so that this template includes the tag number and hook-up item macros
as well as the title block.
Important
• Make sure the macro names you enter in the drawing template match
the macro names you defined on the Macro Definitions dialog box in
the Hook-Ups module.
6. If you want to edit the hook-up drawing identifying fields, associate the document
and revision numbers, in the Domain Explorer, open the Hook-Up Drawing
List dialog box and define data accordingly.
7. In the Domain Explorer, open the Generate Hook-Up Drawings dialog box and
set the generation options as you require.
8. Generate a hook-up drawing from the Generate Hook-Up Drawings dialog box.
Enhanced Hook-Up Drawing Generation Scenario
1. On the Preferences dialog box, on the Enhanced Reports > Hook-Up > View
page, select the options you want to see in your drawing.
2. On the Enhanced Reports > Hook-Up > File Locations page, set the file paths
for the various options.
3. If required, change the text appearance by changing the settings on the Fonts
page.
4. On the Enhanced Reports > Hook-Up > Title Block page, select the title block
you require for your drawing.
5. On the Enhanced Reports > Hook-Up > Pagination and Revisions page, set the
revision display order.
Tip
• You can display a number of revisions in the title block of a hook-up
drawing. Each revision is represented by a numbered macro and the
revisions are displayed in the order of the macro numbering, beginning
with the first revision (ascending order) or the last revision
(descending order). If the total number of revisions is greater than the
number of lines available for display in the drawing and you want to
see the latest revisions, you should select to display the revisions in
6. If you want to edit the hook-up drawing identifying fields, associate the document
and revision numbers, in the Domain Explorer, open the Hook-Up Drawing
List dialog box and define data accordingly.
7. In the Domain Explorer, open the Generate Hook-Up Drawings dialog box and
set the generation options as you require.
8. Generate a hook-up drawing from the Generate Hook-Up Drawings dialog box.

Managing Hook-Up Drawings Common Tasks

These tasks deal with generating hook-up drawings using a CAD application or the
Enhanced Report Utility, maintaining revisions, editing hook-up drawing identifying
fields that appear in the title block, and so forth. For a complete list of hook-up
reports, see Hook-Up Reports: An Overview, page 1096.
Apply a Drawing Generation Method to Hook-Ups

Use this procedure to apply a drawing generation method to one or more hook-ups
manually. This feature is useful if you intend to generate hook-up drawings in a
mixed mode, that is, generate several CAD hook-up drawings and several enhanced
hook-up drawings in one generation session. You generate CAD hook-up drawings
using your CAD application (SmartSketch, AutoCAD, or MicroStation), whose paths
you specified on the Preferences dialog box. You generate enhanced hook-up
drawings using the Enhanced Report Utility, which comes with the SmartPlant
Instrumentation software package. For more information, see Apply a Drawing
Generation Method to Hook-Ups, page 1084.
Set Default Generation Method for Hook-Up Drawings

Use this procedure to set the default generation method that the software can use
automatically when your hook-up selection contains hook-ups that do not have a
generation method applied manually. For more information, see Set Default
Generation Method for Hook-Up Drawings, page 1084.
Edit Hook-Up Drawing Identifying Fields

Hook-up drawing properties appear in the title block fields. These fields contain
identifying information about the drawing name, page number, and file name, and
also information about revisions, approvals, and references to other documents. You
can modify the property information using the options in the Hook-Up Drawing List
dialog box.
For each hook-up drawing, SmartPlant Instrumentation displays the hook-up name
and hook- up description. You can use this procedure to edit the hook-up name,
description, and the output file name. For more information, see Edit Hook-Up
Drawing Identifying Fields, page 1085.
Make Approvals for Hook-Up Drawings

This procedure enables you to make client and vendor approvals for hook-up
drawings. For more information, see Make Approvals for Hook-Up Drawings, page
1086.
Maintain Hook-Up Drawing Revisions

The revision feature is used to keep track of the changes made to the hook-up
drawing during its lifetime. It is important and useful to have a chronological

description of the changes, dates of change, and a list of persons who approved them.
Using this procedure, you can add, edit, and delete revisions.
The revision feature is used to keep track of the changes made to the hook-up
drawing during its lifetime. It is important and useful to have a chronological
description of the changes, dates of change, and a list of persons who approved them.
Using this procedure, you can add, edit, and delete revisions. For more information,
see Maintain Hook-Up Drawing Revisions, page 1086.
Add Document References in Hook-Up Drawings

This procedure enables you to make a reference to a drawing and add this reference to
the title block of the hook-up drawing. For more information, see Add Document
References in Hook-Up Drawings, page 1087.
Assign Border and Logo Blocks to Hook-Up Drawings

This procedure allows you to set SmartPlant Instrumentation to use a specific border
block and logo block every time you generate a CAD hook-up drawing. Blocks that
you set as default general blocks must belong to the shipped general block types, that
is, Border and Logo block types available in the Drawing Block Types folder of the
Domain Explorer. For more information, see Assign Border and Logo Blocks to
Hook-Up Drawings, page 1088.
Update Paths for Hook-Up Drawings and Block Files

Use this procedure to update in the database paths for existing hook-up drawings and
block files. You can update paths globally for block files associated with hook-ups,
for logo and border blocks, and for hook-up drawings that you generated. For more
information, see Update Paths for Hook-Up Drawings and Block Files, page 1089.
Generate CAD Hook-Up Drawings

Use this procedure to generate one or more hook-up drawings using you CAD
application. For more information, see Generate CAD Hook-Up Drawings, page
1090.
Generate Enhanced Hook-Up Drawings

Use this procedure to generate one or more hook-up drawings using the Enhanced
Report Utility. For more information, see Generate Enhanced Hook-Up Drawings,
page 1092.
Generate Hook-Up Drawings in Mixed Mode

Use this procedure to generate several hook-up drawings according to the generation
method applied to the source hook-ups. For more information, see Generate Hook-
Up Drawings in Mixed Mode, page 1093.
Related Topics
• Hook-Up Drawing Generation: An Overview, page 1080

Apply a Drawing Generation Method to Hook-Ups

1. Press F7 to open the Domain Explorer and then double-click the Hook-Ups
folder.
2. In the Items pane, select and right-click one or more hook-ups.
3. On the shortcut menu, click Apply Generation Method.
4. Select one of the following:
• CAD— Allows you to and assigns the indicator to the selected hook-
ups.
• Enhanced Report— Allows you to and assigns the indicator to the
selected hook-ups.
Tips
To view an existing generation method assignment, you can right-click the
appropriate hook-up and click Properties to open the Hook-Up Properties
dialog box.
• To clear the current generation method for one or more hook-ups,

select and right-click the required hook-ups, and then, on the shortcut
menu, click Actions > Clear Generation Method.
Related Topics
Set Default Generation Method for Hook-Up Drawings

2. Click Hook-Ups > General.
3. From the Default generation method list, one of the following methods:
• CAD — Generates hook-up drawings using your CAD application
and allows you to use the CAD Options tab.
• Enhanced Report— Generates hook-up drawings using the
Tip
• The default generation method that you set appears on the Generate
Hook-Up Drawings dialog box.
Related Topics

Edit Hook-Up Drawing Identifying Fields

• In the tree view pane, select a hook-up type and then, In the Items
3. On the shortcut menu, click Actions > Hook-Up Drawing List.
4. On the Hook-Up Drawing List dialog box, select a row and click Edit.
5. In the Document field, type a name for the drawing document.
Tip
• If you type an existing document name, the software prompts you to
confirm the multiple use of the name.
6. In the Document Description field, type a description.
7. To change the default output file name, do one of the following:
• In the Output File Name field, type a different file name over the
default name.
• Beside the output file name string, click to set a name of an
existing file as the output file name for the current hook-up drawing.
Tip
• The default output file name is the same as the hook-up name. If there
are any spaces in the hook-up name, the software replaces the space
with an underscore (_). The file name ends with an underscore (_) and
a two-digit sequence number representing the page number of a multi-
page drawing. For example, flow_transmitter_03.dwg. When the
drawing consists of a single page, the file name ends with _01.
8. Repeat the appropriate steps of this procedure for any other hook-up drawing.
Related Topics

Make Approvals for Hook-Up Drawings

4. On the Hook-Up Drawing List dialog box, click Approvals and then enter the
client and vendor data as needed.
Related Topics
Maintain Hook-Up Drawing Revisions

4. On the Hook-Up Drawing List dialog box, select a desired row and click
Revisions.
P0, P1, P2... for preliminary revisions or 0, 1, 2 /A, B, C, and so forth. for normal
serial revisions).
Tip


• Click a field of an existing row to update the existing revision data.
• Click New to add new revision data, and then type new revision data
values.
Tip
• As a time saver and a forget-me-not precaution, take advantage of
using a default revision method. The software automatically adds a
new line with the next logical character and date each time you click
New after you select the initial method.
7. If necessary, click Delete to delete any previous revisions that are no longer
needed.
Tip
• You can also maintain revisions in batch mode using global revisions.
For more information, see Global Revisions: An Overview, page 76.
Related Topics
Add Document References in Hook-Up Drawings

4. On the Hook-Up Drawing List dialog box, click References open the Document
References dialog box.
5. To insert a new document reference, do the following:
a. Click New to open the Drawing Reference Properties dialog box.
b. Select a value from the References list.
c. Type the name and description in the appropriate boxes.
d. Click OK to return to the Document References dialog box.
6. To edit a manually inserted drawing reference, do the following:

a. Select a desired row and click Properties to open the Drawing Reference
b. Edit the name and description.
c. Click OK to return to the Document References dialog box.
Tip
• To delete a reference, select a row, and click Delete.
Related Topics
Assign Border and Logo Blocks to Hook-Up Drawings

1. In the Domain Explorer, expand the hierarchy of the Drawing Block Types
folder.
2. Right-click the Border block type, and then, on the shortcut menu, click New >
Block.
3. Define the new border block as you require.
4. Right-click the Logo block type, and then, on the shortcut menu, click New >
Block.
5. Define the new logo block as you require.
Tip
• In hook-up drawings, you can only use the blocks created in default
Border and Logo general block types. Blocks belonging to user-
defined general block types, which you create for loop drawings, do
not appear in hook-up drawings.
6. On the File menu, click Preferences > Hook-Ups > General.
7. Select Use global border/logo.
8. In the Hook-Ups module menu bar, click Associations > Default General
Blocks.
9. On the Default General Blocks dialog box, select the border and logo blocks
from the lists.
Related Topics

Update Paths for Hook-Up Drawings and Block Files

Note
• The paths that you specify do not overwrite the settings specified for
new block files and output drawings on the Hook-Ups > File
Locations page of the Preferences dialog box.
1. Open the Hook-Ups module.
2. Click Actions > Update Paths for Existing Drawings and Blocks.
3. Under Path for associated block files, do one of the following:
• Click Apply to drawings in the domain or project to apply the new
path to all the <plants> in the current domain, or to the current project
• Click Apply to drawings in the current <plant> only to apply the
new path to the current <plant> only.
4. Type the full path to the folder where you keep your drawing blocks files or click
5. Under, Path for generated hook-up drawings do one of the following:
• Click Apply to blocks in the domain or project to apply the new
path to all the <plants> in the current domain, or to the current project
• Click Apply to blocks in the current <plant> only to apply the new
path to the current <plant> only.
6. Type the full path to the folder where you keep your generated hook-up drawings
or click Browse to navigate to the desired folder.
Related Topics

Generate CAD Hook-Up Drawings

Note
• A complete hook-up drawing generation scenario is described in the
Help topic Hook-Up Drawing Generation: An Overview, page 1080
hook-up type level in the Hook-Ups folder.
2. In the tree view pane, select a hook-up type.
Tip
• In the Domain Explorer, you can also select hook-up types instead of
hook- ups. In this case, you can generate hook-up drawings that
belong to all the hook-ups that are assigned to the selected hook-up
types.
4. On the shortcut menu, click Reports > Generate Hook-Up Drawings to display
the General tab of the Generate Hook-Up Drawings dialog box.
5. From the Generation method list, select CAD.
6. Click the CAD Options tab.
7. If you want to save the generated hook-up drawing as external CAD files, select
the Save file in format check box, and then beside the Target folder path box
click Browse to specify the folder. To select a folder, you have to select any file
that exists in that folder.
Tips
• In the Target folder path box, the software displays the default folder
you specified on the Preferences dialog box, in the Hook-Ups > CAD
File Locations page, in the Output drawing folder box.
• The file format that the software uses when saving a hook-up drawing
depends on your CAD application. If you use AutoCAD, the software
saves the drawing file in .dwg format. If you select MicroStation, the
software saves the drawing file in .dgn format.
• When using SmartSketch, you can save the drawings in any format
available in the list. From the box below Save file is format, select a
desired format. If you select SmartSketch, the software saves the
drawing file in .sym format.
• The output filename is the same as the hook-up name. If there are any
spaces in the hook-up name, the software replaces the space with an
underscore (_). The filename ends with an underscore (_) and a two-

digit sequence number representing the page number of a multi-page

drawing. For example, flow_transmitter_03.dwg.
8. If needed, select Send to plotter or printer to send the generated drawings to the
current CAD plotter or printer.
9. If you want to apply the macro functions associated with macros, select Use
macro functions.
10. For a multi-page hook-up drawing generation, under Drawing for subsequent
pages, select one of the following:
• Same as first— Allows you to display the generated hook-up
drawing on the first page as well as on all the subsequent pages as
well.
• General drawing — Allows you to display the generated hook-up
drawing on the first page and the general drawing on all the
subsequent pages. The general drawing is a predefined drawing that
you specified on the Preferences dialog box.
Tip
• The software generates a multi-page drawing automatically if the
drawing contains more than one page if the number of tag numbers
associated with the selected hook-up is greater than the number of
macros that can be accommodated on the first hook-up drawing page.
For a multi-page drawing, you can enter the page number of the first
generated page of the hook-up drawing in the Generate from page
box. For example, if you enter the value 2 and then generate a hook-
up drawing, the first page of the hook-up drawing displays the value 2.
A multi-page drawing is a drawing in which the number of tags
associated with the current hook-up is larger than the number of
macros that can be accommodated in the generated hook-up drawing.
Related Topics

Generate Enhanced Hook-Up Drawings

Note
Help topic Hook-Up Drawing Generation: An Overview, page 1080
Tip
types.
5. From the Generation method list, select Enhanced Report.
Tip
• Under Automatic save options for enhanced hook-up drawings,
you can select Save drawings automatically to overwrite the default
folder specified on the Preferences dialog box, Enhanced Report >
Hook-Ups > File Locations page. You can click Browse and specify
a different folder for saving the hook-up drawings automatically as
files at the time of generation.
6. Click OK to generate the drawings for the selected hook-ups.
Related Topics

Generate Hook-Up Drawings in Mixed Mode

Notes
• When generating hook-up drawings in mixed mode, you use the As
previously applied option of the Generate Hook-Up Drawings
dialog box. Mixed mode enables you to generate CAD hook-ups
drawings and enhanced hook-up drawings altogether: CAD hook-up
drawings for hook-ups whose generation method in the Domain
Explorer is indicated as C and enhanced hook-up drawings for hook-
ups whose generation method in the Domain Explorer is indicated as
E. You must first assign your hook-ups to the appropriate generation
methods. For details, see Apply a Drawing Generation Method to
Hook-Ups, page 1084.
Help topic Hook-Up Drawing Generation: An Overview, page 1080.
Tips
types.
• For hook-up drawing generation in mixed mode, you selection can
include hook-ups assigned to the CAD generation method, hook-ups
assigned to the Enhanced Reports method, and also hook-ups that are
not assigned to any generation method.
5. Click the CAD Options tab and define options for CAD hook-up drawings as you
require.
Tip
• You must first set generation options for CAD hook-up drawings
because after you select As previously applied on the General tab,
the CAD Options tab becomes disabled. For example, on the CAD
Options tab, you can select the Send to plotter or printer check box
if you want to print out the generated CAD hook-up drawings at the
time of generation. This check box is cleared by default.

6. Click the General tab.

7. From the Generation method list, select As previously applied.
Tips
• After you select As previously applied, the CAD Options tab and the
Automatic save options for enhanced hook-up drawings become
disabled. When generating the drawings, the software saves the output
files to the default folders whose paths you specified on the
Preferences dialog box individually for CAD drawings and enhanced
hook-up drawings, which are generated by the Enhanced Report
Utility.
• If you hook-up selection in the Domain Explorer includes hook-ups
that are not assigned to any method, the software applies the method
displayed in the Default generation method box. You define the
default generation method on the Hook-Ups > General page of the
Preferences dialog box.
8. Click OK to generate the hook-up drawings for the selected hook-ups.
Related Topics
Create a New Macro Definition

• Click .
3. In the Macro definition details data window, select the desired macro definition.
Tip
4. To create a customized macro definition, do one or more of the following:
a. Under Macro Name, type the desired user name for your macro.
b. Click in the Description field and change the description as desired.

c. Under Function, select a function to modify the appearance of the retrieved

data.
5. To add another customized macro definition, click New and repeat the previous
step.
6. Click Apply to accept your customized macro definitions.
Related Topics
Delete a Macro Definition

• Click .
3. In the Macro definition details data window, select the row containing the macro
definition that you want to delete.
Tip
4. Click Delete.
Related Topics

Hook-Up Reports: An Overview

The following hook-ups reports are available in SmartPlant Instrumentation:
• Bill of Material — Displays data used in a Bill of Material.

• Hook-Up Tag List — Displays instrument tag numbers assigned to
hook-ups.
• Hook-Up Item List — Displays hook-up items assigned to hook-ups.
• Library Items — Displays items defined in the item libraries. If an
item library contains user-defined sub-libraries, the items are
displayed in the report per sub-library.
• Hook-Up Macros — Displays all SmartPlant Instrumentation macros
used in hook-up drawings. The report displays the macro name,
description, name used in SmartPlant Instrumentation and, if
applicable, the macro function.
According to the report type, you can generate reports either using the Reports menu
of either Domain Explorer, the Reference Explorer, or the Hook-Ups window.
The following table lists the report-specific options:
Access to Bill of Material Hook-Up Hook-Up Library Hook-Up

Report Tag List Item List Items Macros
Domain Allows you to Allows Allows N/A N/A
Explorer select all or selected you to you to
hook-up types, or select all select all
hook-ups in the or or
Hook-Ups folder. selected selected
hook-up hook-up
types, or types, or
hook-ups hook-ups
in the in the
Hook- Hook-
Ups Ups
folder. folder.

Access to Bill of Material Hook-Up Hook-Up Library Hook-Up

Report Tag List Item List Items Macros
Reference N/A N/A N/A Allows N/A
Explorer you to
select all
or
specific
libraries
or sub-
libraries
in the
Hook-Up
Item
Libraries
folder
Hook-Ups Allows you to open Allows Allows Allows Allows you
Module previously you to you to you to to click
window generated Bills of open open click Reports >
Materials Bill of previously previously Reports Hook-Up
Material by generated generated > Macros
selecting the Hook-Up Hook-Up Library and group
document number Tag List Item List Items to the macros
of the existing Bills reports by reports by generate by module
of Materials. selecting selecting a report to organize
the the of all the report
document document existing pages
number of number of hook-up according
the the items. to the
existing existing module
reports. reports. titles. If
you do not
group the
macros, the
report
displays all
the macros
in
alphabetical
order.
Related Topics
• Hook-Up Reports Common Tasks, page 1098

Hook-Up Reports Common Tasks

These tasks deal with generating and opening a print preview of a Bill of Material and
reports that show hook-up data, the associated instruments, and hook-up items. For a
complete list of hook-up reports, see Hook-Up Reports: An Overview, page 1096.
Generate a Bill of Material

This procedure describes how to generate a Bill of Material (BOM), which is the
main purpose of the Hook-Ups module. Prior to generating a Bill of Material, you
need to define hook-up types and hook-ups in the Domain Explorer, and then,
associate hook-up items and instruments to the hook-ups. For more information, see
Generate a Bill of Material, page 1099.
Sort Data in a Bill of Material

Use this procedure to sort data in a Bill of Material print preview. For more
information, see Sort Data in a Bill of Material, page 1100.
Generate a Hook-Up Item List Report

Use this procedure to generate a report that displays hook-up items associated with
the hook-ups you select in the Domain Explorer. For more information, see
Generate a Hook-Up Item List Report, page 1100.
Generate a Hook-Up Tag List Report

Use this procedure to generate a report that displays instrument tag numbers
associated with the hook-ups you select in the Domain Explorer. For more
information, see Generate a Hook-Up Tag List Report, page 1101.
Open Reports by Selecting Document Numbers

Use this procedure to open reports by selecting document numbers you created for the
current report type. To use this procedure, you must first generate reports and define
a document number for each report you want to make available for selection. For
example, you can generate five Hook-Up Item List reports for hook-ups belonging to
the FLOW hook-up type and define the Flow Hook-Up document number for each
report. Furthermore, you can generate four Hook-Up Item List reports for hook-ups
belonging to the LEVEL hook-up type and define the Level Hook-Up document
number for each report. You can then use this procedure to select all or some of the
defined document numbers and open the report print preview. For example, you can
select five Flow Hook-Up document numbers and open the print preview of five
Hook-Up Item List reports. For more information, see Open Reports by Selecting
Document Numbers, page 1101.
Related Topics

Generate a Bill of Material

Tip
hook- ups. In this case, you can generate a Bill of Material for all
hook-ups that belong to the selected hook-up types. If you select all
the hook-up types, you generate a Bill of Material for all the existing
hook-ups.
4. On the shortcut menu, point to Reports and click Bill of Material.
5. Click Yes to open the print preview of the new Bill of Material or click No to
send it to your default printer.
Tips
• In the Print Preview window, you sort the Bill of Material data as you
need and group the Bill of Material data by hook-up item
manufacturer.
• If you select the Edit mode check box, you can enter values in the For
Order field in the Bill of Material.
• You can select Print BOM together with the tag list to print out the
instrument tags associated with the hook-ups when printing the Bill of
Material. The Print Preview window does not show the instrument
tags.
• On the Print Preview window toolbar, clicking the revision icon
enables you to create the Bill of Material revision and define the
document number. After you define the document number, you can
then open the same report using the Reports > Reports by Document
Numbers option of the main Hook-Ups Module window.
• Clicking on the Print Preview window toolbar, allows you to save
the Bill of Material to an external file and see the changes in the Bill of
Material the next time you generate it.
Related Topics

Sort Data in a Bill of Material

1. In the Bill of Material print preview, from the Sort by list, select an option to
arrange the fields as you require.
Tip
• Each option in the Sort by list corresponds to a column header in the
print preview.
2. Select the Ascending order check box to display the fields in ascending order or
clear the Ascending order check box to display the fields in descending order.
Related Topics
• Generate a Bill of Material, page 1099
Generate a Hook-Up Item List Report

Tip
hook- ups. In this case, you can generate a report for all hook-ups that
belong to the selected hook-up types. If you select all the hook-up
types, you generate a report of all the hook-up items associated with
for the existing hook-ups.
4. On the shortcut menu, point to Reports and click Hook-Up Item List.
5. Click Yes to open the report print preview or click No to send it to your default
printer.
Tip
enables you to create the report revision and define the document
number. After you define the document number, you can then open
the same report using the Reports > Reports by Document Numbers
option of the main Hook-Ups Module window.
Related Topics

Generate a Hook-Up Tag List Report

Tip
hook- ups. In this case, you can generate a report for all hook-ups that
belong to the selected hook-up types. If you select all the hook-up
types, you generate a report of all the tags associated with for the
existing hook-ups.
4. On the shortcut menu, point to Reports and click Hook-Up Tag List.
5. Click Yes to open the report print preview or click No to send it to your default
printer.
Tip
enables you to create the report revision and define the document
number. After you define the document number, you can then open
the same report using the Reports > Reports by Document Numbers
option of the main Hook-Ups Module window.
Related Topics
Open Reports by Selecting Document Numbers

Note
• To use this procedure, you must first generate the appropriate hook-up
report in the Domain Explorer.
1. On the Hook-Ups module menu bar, click Reports > Reports by Document
Numbers, and then, select the appropriate report.
2. On the dialog box that opens, select one or more document numbers and click OK
to open the print preview of the reports.
Related Topics
• Generate a Bill of Material, page 1099
• Generate a Hook-Up Item List Report, page 1100
• Generate a Hook-Up Tag List Report, page 1101

Maintenance Module
Maintenance Module
The Maintenance module provides you with all the tools required to plan, carry out,
and document the breakdown and preventive maintenance associated with the
instruments in your plant.
Breakdown Maintenance
Breakdown maintenance features deal with the malfunction of equipment. You can
deal with problems on two levels:
• Work Requests
A work request can be initiated by most of the technical staff. A work request
describes a possible malfunction or repair that may be required in the future.
The work requests are then examined by the maintenance supervisor or
foreman who can approve them and then create an actual work order (repair).
• Repair Forms
A repair form is the actual repair or work that has been approved by the
maintenance supervisor or foreman. It indicates the repair date and describes
the nature of the problem as well as the work group that is assigned to carry
out the job. The repair form also includes, in a different section, the
information that is filled in by the person who performed the work,
malfunction cause and action taken, as well as the down and repair time.
Preventive Maintenance
Preventive maintenance features enable you to maintain and schedule periodic
maintenance activities that contain tasks and procedures.
Notes
• The Maintenance module is available only if it is included in the
software license that you purchased from Intergraph.
• You can issue new work requests, repairs, or preventive maintenance
work orders only from the Instrument Index module. Once you have
added maintenance records, you need to access the Maintenance
Activities Summary window for further handling of these activities.
Related Topics
• Performing Breakdown Maintenance, page 1103
• Performing Preventive Maintenance, page 1120

Maintenance Module
Performing Breakdown Maintenance

You create new work requests or repair forms from the Instrument Index module.
These procedures depend on the level of access rights granted to you (for details, see
Access Rights in the Maintenance Module, page 1110). Once a new work request or a
repair form has been created, it can only be accessed from the Maintenance module
Maintenance Activities Summary window. The maintenance supervisor can review
the work requests and use them to create repair forms. The repair form indicates the
work request number that was used to create it. The repair form also includes the
problem description. At this stage, it is also possible to indicate that calibration is
required. The supervisor then schedules this work for a certain date and assigns the
work group that will deal with it. The status of the job at that point is Scheduled.
After the maintenance work is carried out, the technician responsible for it can fill in
the rest of the repair information, and change its status to Done or close it. You can
customize additional statuses such as Hold, Turnaround, and so forth to cope with
situations and that comply with the conventions at your plant.
Note also that it is recommended to set the required Quality System and Criticality
prior to starting the Maintenance module.
The following is the recommended flow of activities for breakdown maintenance:
• Start the Instrument Index module and open an Instrument Index

Standard Browser view.
• Select the desired instruments (tag numbers) for which you want to
enter work requests and start the Calibration module.
• If the instruments require calibration, enter the required calibration
settings for the selected tag numbers (for details, see Defining
Calibration Settings, page 1140).
Caution
• Failure to define the calibration settings prior to starting the
Maintenance module results in the inability to enter the calibration
values when completing a Repair Form. (The Calibration As
Found/As Left dialog box will not be accessible.) Therefore, it is
essential that you enter the calibration settings for the selected tags
before you open Work Requests from the Instrument Index Standard
Browser view.
• Go back to the Instrument Index Standard Browser view and right-
click the selected tags.
• Associate the tag category and criticality as needed (for details, see
Associating Tag Category Criticality and Quality System.)

Maintenance Module
• In the browser view, right-click the selected tags and on the

Maintenance menu, click the Repair Form or the Work Request
Form option.
• Enter the desired repair or work request values.
• Start the Maintenance module to complete the entry of the required
repair or work request values.
Related Topics
• Creating Repair Forms, page 1125
• Filling Out Repair Forms, page 1126
• Opening a Work Request, page 1123

Maintenance Module
Starting the Maintenance Module

Note
• The Maintenance module is available only if it is included in the
software license that you purchased from Intergraph. Before starting
this module, check with the Domain Administrator to ensure that you
have been granted appropriate access rights for the tasks you will carry
out.
Start the Maintenance Module From Any SmartPlant

Instrumentation Module
• Do one of the following:
• Click Modules > Maintenance.
Start the Maintenance Module From an Instrument Index

Browser View
2. In the browser view, select and then right-click the tag numbers that require
maintenance.
3. On the shortcut menu, point to Maintenance and then click one of the following
options:
• Schedule Preventive Maintenance Activities
• Work Request Form
• Repair Form
Related Topics
• Filtering Maintenance Activities, page 1106

Maintenance Module
Filtering Maintenance Activities

Use this procedure to filter the maintenance records of the current domain displayed
in the Maintenance Activities Summary window. These include the following
types of records:
• Preventive maintenance
• Repair forms
• Work requests
Filter Maintenance Activities

1. Open the Maintenance Activities Summary window.
2. Under Process function, do one of the following:
• To display records for tags of all process functions, select the blank
row.
• To limit the records to tags of one process function, select the process
function of interest.
3. To limit the display of preventive maintenance records to a given preventive
maintenance code, select the code under Preventive maintenance code.
4. To limit the display of maintenance records to a given date range, do the
following:
a. Under From, enter the starting date.
b. Under To, enter the ending date.
5. Do one of the following under Data level:
• To limit the records displayed, select Plant, Area, or Unit.
• To not limit the records displayed, accept the default setting of
Domain.
6. To limit the display of maintenance records by tag category, select a value from
the Category list.
7. In the Maintenance records pane, do one of the following:
• To display records for all of the tags that have maintenance data, select
All Activities.
• To display records for selected tags, do the following:
• Click to open the tree.
• Select the tag for which you want to display maintenance records.

Maintenance Module
Note
• To clear all filter settings, click Reset.
Related Topics
• Starting the Maintenance Module, page 1105

Maintenance Module
Generating Maintenance Reports

This option enables you to select and generate a maintenance report. You can
generate the following reports:
• Scheduled Preventive Maintenance Report

• Summary of Failure Reason Report
• Summary of Repair Action Report
• Summary of Outcome Report
• Repair Details Report
Generate a Maintenance Report

1. Start the Maintenance module.
2. In the Maintenance Activities Summary window, on the Reports menu, click
the report that you want to generate.
3. In the Report Properties dialog box, in the Date range group box, do one of the
following to set the date range for the report:
• Select the User defined option and set a specific period by typing or
selecting the required dates from the From and To lists.
• Select the Predefined option to generate a report for the last, current
or next week, month, or year.
4. To filter the data level of the report, select Plant, Area, or Unit.
5. Click OK.

Maintenance Module
Preventive Maintenance Preliminary Activities

You have to define certain preliminary settings before you can start scheduling
preventive maintenance activities or issuing work requests and repair forms. These
preliminary settings include the following three definitions:
• Defining Preventive Maintenance Attachments, page 1111

• Defining Preventive Maintenance Tasks, page 1112
• Defining Preventive Maintenance Activities, page 1113
These definitions then serve as references for the actual maintenance procedures
carried out by the field maintenance personnel.

Maintenance Module
Access Rights in the Maintenance Module

There are several different access right levels in the Administration module that
control the data input for the Maintenance module. The access right levels are
arranged by the form types:
Level Item Description

<Plant> Supporting tables Ability to access, edit and delete
items from the supporting tables
of the module which controls the
forms.
<Unit> Module Access Ability to allow or deny access to
this module.
<Unit> Work Request – Technician Ability to add new work request
Forms from the Index module.
This option should be enabled to
all technical staff.
<Unit> Repair – Technician Ability to convert and schedule
the work request into an actual
work order.
<Unit> Repair – Supervisor Technician's option includes
filling in the repair data.
<Unit> Preventive Maintenance – Preventive Maintenance
Supervisor supervisor's option to schedule
PM activities, assign a work
group and schedule dates.
<Unit> Preventive Maintenance – Preventive Maintenance
Technician technician options include filling
out test results.

Maintenance Module
Defining Preventive Maintenance Attachments

This is the very first procedure that you have to carry out before you can schedule
preventive maintenance. An attachment is an external document that is provided to
the maintenance crew. An attachment can be a text document, a drawing, a sketch,
and so forth.
Here you define the preventive maintenance attachments, enter their descriptions and
associate them with an external file (a .doc file, a drawing, and so forth) that then
serves as a reference for the field maintenance personnel.
Define a Preventive Maintenance Attachment

2. In the Maintenance Activities Summary window, do one of the following:
• On the Tables menu, click Attachments.
• Click .
3. In the Attachments dialog box, click New to define a new attachment.
4. Click in the Name field and type the attachment name or code that will then serve
as a reference for the task.
5. In the Description field, type an appropriate description.
6. Click Browse to associate the current attachment with an external file which can
be a drawing, a text file, or a vendor's document, and so forth.
7. Click View to view the external file to make sure it is the correct one.
8. Click Save and then Close to return to the Maintenance Activities Summary
window.
Related Topics

Maintenance Module
Defining Preventive Maintenance Tasks

After defining the preventive maintenance attachments, you have to define the
appropriate maintenance tasks that will be carried out. The tasks are associated with
the attachments you have defined and then they will be included in the appropriate
maintenance activities.
Define a Preventive Maintenance Task

• Click Tables > Preventive Maintenance Tasks.
• Click .
3. In the Preventive Maintenance Tasks dialog box, click New to define a new
task.
4. Click in the Task field and type the new task name.
5. Click in the Attachment field and select the appropriate attachment with which
new task is to be associated.
6. Click in the Note field and type any note you deem fit for the current task.
window.
Related Topics

Maintenance Module
Defining Preventive Maintenance Activities

Defining the preventive maintenance activities is the last preliminary activity that you
have to carry out before you can start scheduling a PM job. You define the
preventive maintenance activities after defining the preventive maintenance tasks and
attachments. Each activity can hold a number of tasks which are in turn associated
with the defined attachments. You select the defined tasks in the sequence they are to
be performed. The defined activity also contains other default scheduling
information, such as the down/repair time, the interval and frequency for the current
PM activity, the required calibration values, and so forth.
Define a Preventive Maintenance Activity

• On the Tables menu, click Preventive Maintenance Activities.

3. In the Preventive Maintenance Activities dialog box, click New to define a new
activity.
4. Click in the PM code field and type a new preventive maintenance code for the
current activity.
5. Click in the Typical Instrument field and select the appropriate typical
instrument from the list. If the required option is not available, click Typical
Instrument.
6. Click in the Description field and type an appropriate description for the current
activity.
7. Click in the Note field and type any appropriate note if necessary. Use the
horizontal scroll bar to make the Note field visible.
8. In the Associated preventive maintenance tasks section, click Add to include a
task with the activity.
9. Click in the Task field and select the appropriate task from the list. You can
assign more than one task to the same activity. Click Add to add more tasks as
required. Note that each task must be unique. If the required task is not available,
click Tasks.
The software assigns the new task a sequence number. The appropriate
attachment is selected and it appears in the Attachment field.
10. Enter the default scheduling data as needed by selecting the appropriate
scheduling settings from the Default scheduling and Estimated maintenance
time sections.

Maintenance Module
Tip
• Selecting the Calibration Required check box enables you to enter
calibration values when filling out the Preventive Maintenance details.
This option becomes available in the Preventive Maintenance
Activity Details dialog box if you have defined the required
calibration settings for the current tag before you started the
Maintenance module.
window.
Related Topics

Maintenance Module
Scheduling Maintenance
Now that you have defined all your required maintenance attachments, tasks, and
activities, you can select a tag or a number of tags and schedule them for
maintenance. As the Maintenance module is closely connected with the Instrument
Index module, you schedule tag maintenance activities from an Instrument Index
Standard Browser view and then return to the Maintenance Activities Summary
window to continue your maintenance operations.
Schedule Maintenance
1. With the Maintenance Activities Summary window open, click on the Main
toolbar to start the Instrument Index module.
2. On the Actions menu, click Browse Index or click on the Instrument Index
module toolbar.
3. In the Instrument Index Standard Browser view, select the instrument for
which you want to schedule maintenance. You can select multiple tag numbers if
needed.
4. Right-click the selected tags to open a shortcut menu, point to Maintenance and
select Schedule Preventive Maintenance Activities.
5. From the PM code list, select the appropriate preventive maintenance code to
associate the selected instruments with the required PM code, or click .
6. From the Assigned workgroup list, select the work group to which the
preventive maintenance activity will be assigned. If the required work group is
not available in the list, click .
7. From the Priority list, select the required job priority.
8. Set the starting date, frequency, and the PM interval. By default, these values are
taken from PM definition.
9. In the Limit by section, select either the Date or the Number of PM Activities
option button to choose whether you want to set the number of times this PM
activity to be carried out or be limited by a time period.
10. In the Scheduling Options section, select how you want to fine-tune the
scheduling:
• No changes — the scheduling will remain as you defined it in the
Start date, Frequency, Interval, and Limit by options.
• Schedule jobs for— fine-tune the scheduling by selecting a specific
day of the week, for example every Tuesday of the month.
• Schedule jobs for each— fine-tune the scheduling by selecting a
specific day of the month, for example every 15th of the month.

Maintenance Module
11. Click Preview to display the scheduling in the Preview data window.
Tip
• You can also fine-tune the scheduling by editing the PM dates in the
Preview data window. Click on the required PM date and modify the
date as needed. All the changes will be implemented after you click
Generate.
12. Click Generate and then click Close.
13. Go back to the Maintenance Activities Summary window by selecting it from
the Window menu.
14. In the Maintenance Activities Summary window, click to display the new
PM records that you have just scheduled for selected instruments.
Related Topics
• Entering Preventive Maintenance Details, page 1118
• Extending Existing Scheduling, page 1117

Maintenance Module
Extending Existing Scheduling

This option allows you to extend the existing scheduling of maintenance for a
selected tag.
Extend the Existing Scheduling of Maintenance

2. In the Maintenance Activities Summary window, filter the records as needed.
3. Highlight the required row in the Preventive Maintenance data window and do
• On the Actions menu, click Extend.
• Click .
4. In the Extend Scheduling dialog box, do the following:
a. In the Take scheduling data from group box, select one of the following:
• Last preventive maintenance activity— fetch the scheduling
data from the last PM activity.
• Preventive maintenance code defaults— fetch the scheduling
data from the PM codes.
b. In the Limit scheduling by group box, select one of the following:
• Date— Sets the scheduling limited by date. Use the spinner to set
the required date.
• Number of activities— Sets the scheduling limited by the number
of activities. Enter the number of activities in the field provided.
5. Click Generate.
6. Click Close after the record generation is complete.
Related Topics
• Scheduling Maintenance, page 1115

Maintenance Module
Entering Preventive Maintenance Details

Once preventive maintenance has been scheduled, the repair technician can enter the
PM details and create a work request if that activity has failed. The technician can
indicate the starting and the completion dates, the service and the down time, enter
the maintenance results, failure reason if needed, and the repair action. Note that if a
value is not available in any of the lists in the Work Activity Details window, you
can access the required supporting table on the Tables menu.
Enter Preventive Maintenance Details

2. In the Maintenance Activities Summary window, filter the records that you
want to display.
3. Highlight the required row in the Preventive Maintenance pane and do one of
the following:
• On the Actions menu, click Open.
• Click .
4. In the Work Activity Details window, from the Work Status list, select the
required work status if you need change the displayed one.
Tip
• The following parameters in this window are not accessible to the
repair technician and can be modified only by the maintenance
supervisor:
• PM code
• Priority
• Created by
• Creation Date
• Last preventive maintenance
• Interval
• Frequency.
• Assign the required work group by selecting the required option
from the Maintenance staff (scheduled) list.
• Modify the automatically generated work order number if required.
• Modify the scheduled date if needed.
• Enter the start and completion dates, service, and down time.

Maintenance Module
• From the Maintenance staff (actual) list, select the repair

technician.
• Select the required PM result from the Results list.
• If the maintenance result is Failed, select the failure reason and
repair action.
Tip
• The Failure reason and Repair action lists are available only if
the maintenance result is Failed.
Tip
• Type any additional notes you might require in the Note data
window.
• Select the Calibration Required check box and click to open
the Calibration Data Entry window where you enter the required
calibration values. Note that the Calibration Data Entry window
is accessible only if you have entered appropriate calibration
settings for the selected instrument before entering PM activity
details.
• To change the work status, select the required option from the
Work status list.
• Click and create a work request if needed.
• Click Yes when prompted for SmartPlant Instrumentation to create
a work request automatically.
Tip
• SmartPlant Instrumentation prompts you to create a work
request when a maintenance activity fails. This happens when
you select Failed from the Results list in the Work Activity
Details window.
• Click Close the Work Activity Details window to return to the
Maintenance Activities Summary window.
Related Topics

Maintenance Module
Performing Preventive Maintenance

Before scheduling new preventive maintenance (PM) activities, you have to predefine
preventive maintenance attachments, tasks, and activities.
Scheduling new preventive maintenance work orders is done only from the
Instrument Index module (unless you are extending an already assigned PM job).
Once a PM work order has been scheduled, you open the Maintenance Activities
Summary window for further handling of these activities where you fill in the
maintenance details or reports.
To define the raw PM activities, tasks and attachments, you need to access the
Maintenance module and start to define the tasks from the lowest level – the
àttachment'. An àttachment' describes a set of instructions to the technical staff. An
attachment can be associated with any external document (a `Word' file, a scanned
image, or manufacturer maintenance document). Typical attachments define safety
precaution instructions, technical instructions for bypassing a process, the actual set
of instructions required to carry out the activity itself, restoring the process back to its
operational status, and so forth.
A task is a set of instructions associated with an attachment. You can associate a

single attachment with multiple PM activities. A task can include the attachment and
a description.
Once you define the attachments and tasks, you can introduce a new PM activity.
Each PM activity can hold several tasks in the sequence they were added. At this
stage, it is also advisable to associate a PM code with a particular typical instrument
(for example, transmitter, transducer, control valve, switch, and so forth.) This is very
useful for report generation and other statistics. Moreover, a PM activity contains
additional default information, such as the required calibration values, the
down/repair time that an average maintenance job will take, the interval and
frequency for each PM job.
Once all the required attachments, tasks, and activities have been defined, the
preventive maintenance supervisor can schedule these activities to the selected tags
from an Instrument Index Standard Browser view. At this stage, the PM activities are
ready to be further processed and be filled in by the maintenance crew in due time.
The following is the recommended flow of activities for preventive maintenance:
• Start the Maintenance module and define the raw PM activities, tasks,
and attachments.
• Start the Instrument Index module and open an Instrument Index
Standard Browser view.
• Select the required tag numbers for which you want to schedule a PM
job and start the Calibration module.

Maintenance Module
• If the instrument requires calibration, enter the appropriate calibration

settings for the selected tags.
Caution
• Failure to define the calibration settings prior to starting the
Maintenance module result in the inability to enter the calibration
values when entering preventive maintenance details. (The
Calibration As Found/As Left dialog box will not be accessible.)
Therefore, it is essential that you enter the calibration settings for the
selected tags before you schedule a PM job from the browser view.
• Go back to the Instrument Index Standard Browser view and right-
click the selected tags.
• Associate the tag category and criticality as needed.
• On the shortcut menu, click Maintenance > Schedule Preventive
Maintenance Activities.
• Create the new schedule for the PM activity.
• Start the Maintenance module and fill out the PM activity details as
desired.
• At this stage, you can also issue work requests and open repair forms
for the required instrument if needed.
Tip
• When saving PM activity details, SmartPlant Instrumentation prompts
you to create a work request if the result of the PM activity is Failed.
Clicking Yes creates the Preventive Maintenance record and opens the
Work Request dialog box where you can create a repair form.
Related Topics
• Preventive Maintenance Preliminary Activities, page 1109

Maintenance Module
Issuing a New Work Request

You can issue new work requests only from the Instrument Index Standard Browser
view or from the Work Activity Details window if the activity result was Failed.
This option is on the lowest access rights level and there are no restrictions on its
access. Note that some options are not available (for details, see Access Rights in the
Maintenance Module, page 1110).
Issue a New Work Request

2. Select the required tag number for which you want to issue a work request.
Caution
• Do not select multiple tag numbers in the browser view. This option is
available for single instruments only.
3. Right-click the selected tag to open a shortcut menu. Point to Maintenance and
click Create Work Request.
4. In the Create Work Request dialog box, modify the work request number if
needed – the software fills in the values automatically.
5. Select the Typical Instrument and the Work Request Reason from the lists.
6. Type the required work request title.
7. Type the appropriate problem description if needed.
8. Click Save and then Close to return to the browser view.
Tip
• You cannot generate a repair form in this case.
Related Topics

Maintenance Module
Opening a Work Request

You can open work requests from an Instrument Index Standard Browser view or
from the Maintenance Activities Summary window. However, you can issue new
work requests only from the Instrument Index Standard Browser view or from the
Work Activity Details window if the activity result was Failed. It is recommended
that you create a new work request from the browser view and then open this new
work request record in the Maintenance Activities Summary window. Due to the
access rights restrictions, some of the work request features are disabled if accessed
from the browser view.
If you have been granted full access rights and you are the maintenance supervisor,
you can first issue a new work request in the Instrument Index Standard Browser
view and then open it in the Maintenance Activities Summary window. This
enables you to create a repair form. Repair form creation is not available when
issuing a new work request, which is only possible from the Maintenance Activities
Summary window. It is not possible to create a repair form from the work request
because all work requests have to be reviewed by the supervisor.
When you issue or open a work request, SmartPlant Instrumentation automatically

assigns this record a work request number that you can modify if needed.
Open an Existing Work Request

2. In the Work requests pane, select the required records and click .
Tip
• All work requests have the WR notation preceding the work request
number.
3. In the Work Request window, modify the work request number and title if
needed these are filled in automatically by SmartPlant Instrumentation. If you
leave the Word request title field blank, the software fills it after you select a
typical instrument and a work request reason.
4. Modify or select the typical instrument and the work request reason from the lists.
If the required option is not on the list, on the Tables menu, click Typical
Instruments or Work Request Reasons as needed.
5. Type the appropriate problem description if needed.
6. To generate a repair form, on the Actions menu, click Repair Form.

Maintenance Module
Tips
• This option is not available if you opened the Work Request dialog
box from an Instrument Index Standard Browser view.
Tip
• This option is accessible only if you have been granted the appropriate
access rights (for details, see Access Rights in the Maintenance
Module, page 1110).
window.
Related Topics
• Issuing a New Work Request, page 1122

Maintenance Module
Creating Repair Forms

You can issue a new repair form from an Instrument Index Standard Browser view.
This can be done by a repair supervisor with appropriate access rights (for details, see
Access Rights in the Maintenance Module, page 1110). Note that the repair options
are not available at this stage. Subsequently, you can open this repair form from the
Maintenance Activities Summary window where you can fill out the repair options.
Also, it is possible to create a new repair form from the Work Request window when
opening a work request from the Maintenance Activities Summary window. You
can then open the newly created repair form from the Maintenance Activities
Summary window.
Create a New Repair Form

2. Select the required tag number for which you want to issue a work request.
3. Right-click the selected tag to open a shortcut menu. Point to Maintenance and
click Repair Form.
4. In the Repair (scheduled) group box of the Repair Form window, modify the
scheduled date and the work order number if necessary.
Tip
• The Repair (actual) options are not available at this stage. The
Repair options contain the actual work order information.
5. Select a work request reason from the list. If the required option is not available
in the list, click the required option on the Tables menu.
6. Type the work request title and the problem description.
7. Set the repair priority by selecting the required option from the Priority list.
8. From the Maintenance staff (scheduled) list, select the appropriate work group
from the list or accept the displayed one. If the required option is not available,
click the required option on the Tables menu.
window.
In due time, a repair technician can open this repair form from the Maintenance
Activities Summary window and fill out the information under Repair (actual).
Note
• A repair form that you create from a work request retains WR
identification number.

Maintenance Module
Filling Out Repair Forms

The following procedure describes how to fill out a repair form.
Note
• To add entries to supporting tables that you need below, on the Tables
menu, click the relevant menu command.
Fill Out a Repair Form

2. In the Repairs pane, select the required records and click .
3. In the Repair (scheduled) group box of the Repair Form window, do the
following:
a. Update the work status from the Work Status list.
b. Modify other values as needed.
4. In the Repair (actual) group box, set the start and completion dates.
5. Set the down and repair time.
6. To perform calibration, do the following:
a. Select the Calibration required check box.
b. On the Actions menu, click Calibration.
c. Follow the calibration flow of activities (for details, see Calibration Flow of
Activities, page 1133).
7. From the Maintenance staff (actual) list, select the person who is assigned to
carry out the repair.
8. From the Failure reason list, select the failure reason of the instrument
9. From the Outcome list, select the required item that describes the effect of the
current failure, for example partial or complete unit shutdown, and so forth.
10. From the Repair Action list, select the value that describes what action has been
taken to repair the failure.
11. In the Comments data window, type a brief comment if needed.
12. When done, click Save and then Close to return to the Maintenance Activities
Summary window.
Related Topics
• Issuing a New Work Request, page 1122

Maintenance Module
Maintenance Event Records: An Overview

For an instrument existing in As-Built or in an Engineering company domain it is
possible to create records of repairs, tests, inspections, calibrations, and so forth.
These records are called maintenance event records. It is possible to associate several
maintenance event records with a particular instrument, provided that this instrument
belongs to one of the following tag classes: Conventional, Fieldbus, HART, or
Profibus. A user with full Calib. & Maint. Events access rights can create
maintenance event records. After a record is created, it is considered active until a
supervisor user with. full Calib. & Maint. Event Supervisor rights marks the record as
complete. Completed records are automatically saved to the database. Only a
supervisor can delete completed maintenance event records.
Maintenance event record creation and management is performed in the Domain

Explorer. In the Domain Explorer, all maintenance event records appear under
instruments, in the Maintenance Events folder. Active records are indicated with the
icon . Completed records are indicated with the icon
When creating a record, the software specifies a name for the record automatically,
according to the preferences that you set on the Preferences dialog box. For details
of the preferences options, see Calibration and Maintenance > General
(Preferences), page 166. The maximum length of the record name can be sixty
characters. Before a record is complete, a user with full Calib. & Maint. Events
access rights can update the record name by changing the event date.
When creating a maintenance event record, you must select a form whose process
function is the same as the process function of the source instrument. You need to
familiarize yourself with various options of the Specifications module to be able to
define and manage forms compatible with maintenance event records. For more
details about forms, see Spec Forms: An Overview, page 821. There is one shipped
form designed for displaying maintenance event records for level instruments:
Displacer Level Switch (form number 93). You need to restore this form first. This
form page contains non-editable fields from the Component table. When
regenerating a page for such a form, you can add editable fields from the
Work_Activity table, and also add non-editable fields from the Calibration_Setting,
Component, PD_General, and Spec_Sheet_Data tables. If you want to create
maintenance event records for instruments whose process function is other than
Level, you need to use the Change Process Function options of the Page Editor.
For details, see Select a Different Process Function for a Page, page 798.
A page on which you base maintenance event records does not have a title block and,
therefore, does not contain any revision data or document number. You cannot use
comparison options with maintenance event records. You can create, open and
complete one record at a time. It is possible to open and print out several completed
records at a time.

Maintenance Module
Flow of Activities for Defining a Project

Administrator
This topic describes the flow of activities for defining and managing maintenance
event records in SmartPlant Instrumentation.
1. Grant Access Rights for Opening and Completing Maintenance Event

Records
The Domain Administrator needs to define access rights for users working with
maintenance event records in As-Built or in an Engineering company domain. These
access rights allow a regular user to create maintenance event records and update the
record names. Such a user must have full Calib. & Maint. Events access rights. After
a record is created, it is considered active until a supervisor user marks this record as
complete. A supervisor user can delete the record if it becomes obsolete. Such a user
must have full Calib. & Maint. Event Supervisor access rights. Before granting
access rights, the Domain Administrator needs to assign these users to different user
groups because access rights in SmartPlant Instrumentation are granted per group.
For details about access rights, see the Administration module Help, Access Rights
Common Tasks in the Administration Module User's Guide, Domain and Project
Administration, Access Rights.
2. Set a Date Format for Maintenance Event Record Names

Use this procedure to set a date format that the software applies to names of
maintenance event records when you create such records in the Domain Explorer.
This procedure can be only be performed by a user that have rights to set or modify
preference settings of SmartPlant Instrumentation. For details, see Set a Date Format
for Maintenance Event Record Names, page 1129.
3. Create a Maintenance Event Record

Use this procedure to create a maintenance event record. This procedure can only be
performed by a user with full Calib. & Maint. Event Supervisor access rights. For
details, see Create a Maintenance Event Record, page 1130.
4. Complete a Maintenance Event Record

Use this procedure to mark a maintenance event record as completed. This procedure
can only be performed by a user with full Calib. & Maint. Events access rights. For
details, see Complete a Maintenance Event Record, page 1131.
Related Topics

Maintenance Module
Set a Date Format for Maintenance Event Record Names

2. In the tree view, click Calibration and Maintenance > General.
3. In the Maintenance event date format box, enter a valid date format using one
of the following examples:
Date Format Example
mm-dd-yy 01-30-07
mm-dd-yyyy 01-30-2007
dd-mm-yy 30-30-07
dd-mm-yyyy 30-30-2007
d-mmm-yy 30-Jan-07
mmm-yy Jan-07
Tips
• SmartPlant Instrumentation only support date formats that are listed in
this table.
• You can use one of the following characters as separators: dash (-),
slash (/), space, comma, semicolon, colon, or dot.
Related Topics
• Flow of Activities for Defining a Project Administrator, page 1128

Maintenance Module
Create a Maintenance Event Record

instrument level in the Instruments folder.
2. Click an instrument for which you want to create a maintenance event record.
Tip
• The instrument that you select must belong to one of the following
classes: Conventional, Fieldbus, HART, or Profibus.
3. Right-click the Maintenance Events folder and on the shortcut menu click New
> Maintenance Event Record.
Tip
• You can create one maintenance event record at a time.
4. Under Maintenance event date, define the date of the event.
Tip
• When you define the date, the software automatically displays the
record name in the Record name box, according to the preferences
you set. For details, see Calibration and Maintenance > General
(Preferences), page 166.
5. In the Maintenance event description box, type and optional description.
Tip
• The description does not appear automatically on the record sheet. To
display the description on the record sheet, you need to regenerate the
form page on which the record is based and add the wa_prob_desc
field in the page.
6. Under Form number, select a form whose process function is the same as the
process function of the source instrument.
7. Click OK to create the record and display it in the Maintenance Events folder
with the icon .
Related Topics

Maintenance Module
Complete a Maintenance Event Record

instrument level in the Instruments folder.
2. Click an instrument containing active maintenance event records, which are
indicated with the icon .
3. Click the Maintenance Events folder to display the existing records.
4. Right-click a specific record and then, on the shortcut menu, click Actions >
Open Document.
5. On the Maintenance Event Record window menu bar, click Actions > Mark as
Complete.
Tips
• In the Domain Explorer, completed records are indicated with the
icon .
• After a record is marked as completed, you cannot update any settings
for the record, only open a record print preview or delete the record.
• To delete obsolete records, right-click one or more records in the
Domain Explorer and then, on the shortcut menu, click Delete.
Alternatively, click Properties and then delete the selected records
one by one from the Maintenance Event Properties dialog box. All
records in your selection must be either active or completed.
Related Topics

Calibration Module
Calibration Module
The Calibration module allows you to keep track of the calibrations made to the
instruments in your plant. This way you can monitor the calibration history of each
instrument and compare it with new calibration values.
You can specify a large variety of calibration parameters such as calibration ranges,
trip point values, and alarms. You can also keep a history record of tag calibration
values. The calibration user interface allows you to easily compare current measured
values with the appropriate specifications. This interface also enables you to
simultaneously maintain the calibration data of a group of selected tags.
You can also calculate the error of tags in a given loop.
Note
• The Calibration module is available only if it is included in the
software license that you purchased from Intergraph.
Related Topics
• Calibration Flow of Activities, page 1133

Calibration Module
Calibration Flow of Activities

The flow of activities is as follows:
Defining Calibration Settings, page 1140

The first step in creating the tag calibration history is to define calibration settings,
which determine the calibration points for the selected instrument tags.
Entering Calibration Data, page 1150

Having specified the calibration settings, you can enter calibration data — the
parameter values before the calibration (As Found) and after the calibration (As Left).
Maintaining Calibration History, page 1160

The calibration history options allows you to browse through the calibration entry list
of a selected tag. This option also allows you to view the selected calibration entry
data, modify it, or add a new calibration entry for the selected tag.
Generating Calibration Reports, page 1164

You can view and print out reports of calibration settings, calibration data, and
calibration history.

Calibration Module
Starting the Calibration Module
Start the Calibration Module

• Click Modules > Calibration or on the Main toolbar, click .
• Open an Instrument Index Standard Browser view, select the tag
numbers that require calibration, and do one of the following:
• Click Modules > Calibration.
Accessing Calibration Windows

When you start the Calibration module, you can access the following calibration
windows:
• Calibration Settings
• Calibration Data Entry
• Calibration History
You can also open the Calibration Reports dialog box for defining filter conditions
when generating a calibration report.
Access a Calibration Window

1. Start the Calibration module and do one of the following:
• On the Calibration toolbar, click the appropriate icon.
• On the Actions menu, select the desired option.
2. On the Enter Tag Number dialog box, type the tag number of the desired
instrument or click Find to search for specific instrument tags.
Related Topics
• Defining Calibration Settings, page 1140
• Entering Calibration Data, page 1150
• Maintaining Calibration History, page 1160

Calibration Module
Searching for Tag Numbers in the Calibration

Module
This option enables you to find tag numbers in the Calibration module using search
parameters in the Find Tag dialog box. Entering search parameters 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: underscore ( _ ) for single
characters, and percent ( % ) for multiple characters.
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.
search parameters in the Search results data window of the Find Tag dialog box.
Note
• The following procedure describes how to find tags using search
parameters. If needed, you can also find tag numbers without defining
any search parameters.

Calibration Module
Search For Tag Numbers In The Calibration Module

1. With the Calibration Module window open, do one of the following:
• On the Actions menu, do one of the following:
• Click Settings to find the required tag numbers and display
them in the Calibration Settings window.
• Click Data Entry to find the required tag numbers and display
them in the Calibration Data Entry window.
• Click History to find the required tag numbers and display
them in the Calibration History window.
• On the Calibration module toolbar, click , , or .
2. On the Enter Tag Number dialog box, click Find.
3. If needed, select Search by category to find only tag numbers that you have
associated with tag categories in the Instrument Index module.
Tips
• Search tag numbers by category if you have created user-defined
tag categories and associated tag numbers with these categories.
You can also type a category in the Category field to narrow your
search to tags associated with this category only. Use wildcards
and not case-insensitive characters if needed.
• When searching for tag numbers by tag category, you can narrow
down your search by typing a specific tag category or loop name,
or by selecting the required instrument type and process function.
Note that you cannot use certain search parameters together with
the tag category parameter. These fields become view-only.
4. Define you search criteria using the required combination of the following
search parameters:
Tag number Type the whole tag number you 101-FT – 2225/1 or use a
are looking for. Include any wildcard: 101-FT%
prefix, suffix, and separator
characters. You can use wildcards
if needed.
Process function Select a process function to narrow Flow Pressure
your search to tags belonging to
this process function.

Calibration Module

Instrument type Select an instrument type to D/P Type Flow Element
narrow your search to tags (FE), Mass Flow
belonging to this instrument type. Transmitter (FT)
Status Select a tag status to narrow your An existing device, a new
search to tags associated with this instrument, a relocated
status. device
Location Select a tag location, for example: Equipment room, junction
Field, to narrow your search to box
tags for which you have defined
this location.
I/O Type Select an I/O type to narrow your AO (analog output) DI
search to tags for which you have (Digital input)
defined this I/O type.
Prefix Type the tag number prefix to find 101
all the tag numbers that contain
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
Number Type the numeric segment of a tag 2315
number to find all the tag numbers
that contain this numeric segment.
You can also use wildcards if
needed.
Suffix Type the suffix segment of the tag 1 ( the number following
number to find all the tags that the slash (/) in tag number
contain this suffix. Do not type 101-FT – 2225/1)
the slash character before the
suffix. You can also use wildcards
if needed.
Equipment Select the 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.
5. If desired, select Look in all units to look for the defined search criteria in all
the units of the current plant.
6. Click Find to display the tag numbers in the Search results data window.

Calibration Module
Tip
criteria fields and enlarge the Search results data window to
display more tag rows. Clear this check box to return to normal
view.
7. Select the required tag numbers in the Search results data window.
Tip
• You can also select the Select all check box to select all the
displayed tag numbers.
8. Click OK to open the appropriate window (Calibration Settings,
Calibration Data Entry, or Calibration History) and proceed with the
Calibration module activities.

Calibration Module
Copying Existing Process Data

If you are defining calibration settings for a tag number associated with process data,
you can copy existing maximum and minimum process data range values into the
Variable Min and Variable Max fields in the Ranges section; you can also copy
existing alarm and trip data into the appropriate Alarms / Trips section.
Copy Existing Process Data

1. Open the desired instrument tag in the Calibration Settings window.
2. Click Options > Copy Process Data.
3. On the Copy Process Data dialog box, click OK.
Tips
• You can edit the data in the Process Data module only.
• The copied data overwrites your previous settings in the Calibration
Settings window.
Notes
• If you defined multiple process data cases for the current tag, the data
displayed in the Process Data pop-up window is determined by the
governing case. For details, see Multiple Process Data Cases, page
1190.
• The software copies the Min and Max values beside Required range
to the Variable minimum and Variable maximum fields in the
Ranges section as well as the alarm and trip data in the calibration
settings Alarm / Trips section.
Related Topics
• Defining Alarm / Trip Settings, page 1142
• Defining General Calibration Settings, page 1141
• Defining the Set Point, page 1143

Calibration Module
Defining Calibration Settings

The calibration settings for an instrument tag are the prerequisite of the calibration
procedure. They serve as a reference for the calibrations performed on the selected
tag. If settings already exist for an instrument tag, you can modify them. You enter
parameter values such as range, alarm settings, and trip point settings. These values
will later serve as reference values for any calibrations you will perform on the device
associated with that tag.
Define Calibration Settings

1. Start the Calibration module.
• Click Actions > Settings.
• Click .
3. On the Enter Tag Number dialog box, type the desired tag number or click Find
to search instrument tags.
Tip
• If you selected multiple tag numbers, click (on the Actions menu,
click List Tags) and then click a tag number to define the settings for
that instrument.
4. Define the general calibration settings.
5. Define the alarm / trip settings.
6. Define the set point.
7. Click Save to save the settings.
Related Topics
• Copying Existing Process Data, page 1139

Calibration Module
Defining General Calibration Settings

General calibration settings include the instrument calibration ranges, errors/points
settings, custom settings, and the display scale definition.
Define General Calibration Settings

• Click .
3. In the Calibration Settings window, click the General Settings tab and enter
values in each section by typing or selecting from the lists.
Tips
• If you are defining calibration settings for a tag number associated
with process data, you can copy existing process data minimum and
maximum range values (for details, see Copying Existing Process
Data, page 1139).
• The Measuring Point parameter is available for calibration types that
require a single calibration point only.
• The fields in the Set values group box are available only if under
Error calculation type you selected Switch set point.
4. To define custom fields, click the Custom Fields tab.
Tips
• The Domain Administrator can enable or disable the use of custom
fields in the Calibration module.
• The custom fields in the Calibration Settings window are
independent of the custom fields in the Calibration Data Entry
window.
5. When done, click Save .
Tip
• You are now ready to define the alarm / trip settings for the current tag
number.
Related Topics
• Clearing the Calibration Ranges, page 1144

Calibration Module
Defining Alarm / Trip Settings

You enter the required alarm / trip settings in the appropriate Point data window.
You can specify up to six trip or alarm indication points. For each point, you select a
unit of measure, enter the point values and direction, and type a brief description.
Define the Alarm / Trip Settings

• Click .
3. In the Calibration Settings window, click the General Settings tab and scroll to
the Alarm / Trips section.
4. In the First Point region, type the desired values or select them from the lists.
When done, define other calibration points as needed.
Tip
• If you are defining calibration settings for a tag number associated
with process data, you can copy existing process data minimum and
maximum range values (for details, see Copying Existing Process
Data, page 1139).
5. Click Save to save all your calibration settings.
Related Topics

Calibration Module
Defining the Set Point

After defining the alarm and trip settings, you can also define the set point of the
selected instrument. You can either define the set point to be identical to one of the
alarm / trip points that you have already defined, or you can define the set point
manually.
Define the Set Point

1. Open the desired instrument tag in the Calibration Settings window.
2. In the Set Point section, from the Point list, select one of the following:
• 1st Point, 2nd Point, 3rd Point, and so forth (any defined calibration
point up to the 6th point): The set point will be identical to the selected
alarm/trip point and the rest of the fields in this data window become
unavailable. Note that this option is possible only after making your
alarm/trip definitions.
• Free: You can define the set point yourself.
• None: You can make no set point definitions.
3. Type the rest of the values as desired or select them from the lists.
4. Click Save to save all your calibration settings.
Related Topics

Calibration Module
Clearing the Calibration Ranges

This option is useful if you discontinue calibration of an instrument or if you need to
clear the values of the input ranges. Note that this option does not clear the output
signal values.
Clear the Calibration Ranges

1. In the Calibration Settings window, click Options > Clear Calibration
Settings.
2. At the prompt, click Yes to confirm the deletion.
Managing Action Codes

An action code is a code associated with a description of a solution of a calibration
failure. You can customize your own action codes that will become available for
selection on the Data Entry tab from the Action code list in the Codes section.
Manage Action Codes

1. In the Calibration Data Entry window, click Tables > Action Codes.
2. On the Action Codes dialog box, do one of the following:
• Click New to add a new value.
• Highlight an existing action code.
Tip
• If you have a large number of result code values, and you want to find
one of them quickly, in the Find an action code box, start typing an
action code string. The software finds and highlights the matching
row in the data window as you type.
3. Type the desired action code and its description in the appropriate columns.
Tip
• You can permanently delete a customized action code by highlighting
a row and clicking Delete. The software subsequently removes the
deleted action code from the Action code list in the Codes section.
4. Click OK to accept the values and close the dialog box.

Calibration Module
Managing Damage Codes

A damage code is a code associated with a description of a calibration failure. You
can customize your own damage codes that will become available for selection from
the Diagnostic code list in the Codes section.
Manage Damage Codes

1. In the Calibration Data Entry window, click Tables > Damage Codes.
2. On the Damage Codes dialog box, do one of the following:
• Highlight an existing damage code.
Tip
• If you have a large number of damage code values, and you want to
find one of them quickly, in the Find a damage code box, start typing
a damage code string. The software finds and highlights the matching
row in the data window as you type.
3. Type the desired damage code and its description in the appropriate columns.
Tip
• You can permanently delete a customized damage code by
highlighting a row and clicking Delete. The software subsequently
removes the deleted damage code from the Diagnostic code list in the
Codes section.
Related Topics
• Managing Action Codes, page 1144
• Managing Result Codes, page 1147

Calibration Module
Managing Diagnostic Codes

A diagnostic code is a code associated with a description of a calibration failure
cause. You can customize your own diagnostic codes that will become available for
selection from the Diagnostic code list in the Codes section.
Manage Diagnostic Codes

1. In the Calibration Data Entry window, click Tables > Diagnostic Codes.
2. On the Diagnostic Codes dialog box, do one of the following:
• Highlight an existing diagnostic code.
Tip
• If you have a large number of diagnostic code values, and you want to
find one of them quickly, in the Find a diagnostic code box, start
typing a diagnostic code string. The software finds and highlights the
matching row in the data window as you type.
3. Type the desired diagnostic code and its description in the appropriate columns.
Tip
• You can permanently delete a customized diagnostic code by
highlighting a row and clicking Delete. The software subsequently
removes the deleted diagnostic code from the Diagnostic code list in
the Codes section.
Related Topics
• Deleting a Calibration Result Entry, page 1161
• Managing Damage Codes, page 1145
• Managing Result Codes, page 1147
• Viewing and Modifying Calibration Results, page 1162

Calibration Module
Managing Result Codes

A result code is a code associated with a description of a calibration result.
SmartPlant Instrumentation provides three predefined standard result codes Passed,
Failed, and None. You can customize your own result codes in addition to the
standard ones if required. The customized result codes will then become available for
selection on the Data Entry tab from the Result code list in the Codes section.
Note
• The standard result codes Passed, Failed, and None cannot be edited
or deleted and, therefore, do not appear in the Result Codes dialog
box.
Manage Result Codes

1. In the Calibration Data Entry window, click Tables > Result Codes.
2. On the Result Codes dialog box, do one of the following:
• Highlight an existing result code.
Tip
• If you have a large number of result code values, and you want to find
one of them quickly, in the Find a result code box, start typing a
result code string. The software finds and highlights the matching row
in the data window as you type.
3. Type the desired result code and its description in the appropriate columns.
Tip
• You can permanently delete a customized result code by highlighting a
row and clicking Delete. The software subsequently removes the
deleted result code from the Result code list in the Codes section.
Related Topics
• Managing Diagnostic Codes, page 1146

Calibration Module
Managing Test Equipment Data

Use this option to define, edit, and delete your test equipment data. Test equipment is
equipment you use for calibrating and recalibrating instrument tags.
After you define your test equipment, it becomes available in the Test Equipment
data window, where you can select the equipment used for calibration of a particular
instrument tag.
Then, in the Calibration History window, you can track the calibration history
results for the tag that has been calibrated using this equipment and view detailed
information of test equipment history data for each calibration record. This
information is retrieved from the Test Equipment supporting table.
Manage Test Equipment Data

1. In the Calibration Data Entry window, click Tables > Test Equipment.
2. On the Test Equipment dialog box, do one of the following:
• Highlight an existing test equipment value.
Tip
• If you have a large number of test equipment values, and you want to
find one of them quickly, in the Find a test equipment box, start
typing a string for the test equipment name. The software finds and
highlights the matching row in the data window as you type.
3. In the appropriate columns, type the following:
a. Type the required equipment name, description and serial number in the
appropriate fields.
b. In the Test Date field, select or type the date of testing this equipment.
c. In the Tested By field, type the name of the employee who tested this
equipment.
d. In the Accuracy field, type the accuracy of this equipment, and from the
UOM field, select the accuracy unit of measure.
Tip
• You can permanently delete an item of test equipment by highlighting
a row and clicking Delete. The software subsequently removes the
deleted test equipment from the lists in the Test equipment section.

Calibration Module
Caution
• After you delete a record, it is permanently deleted from the Test
Equipment supporting table and will no longer be available in the Test
Equipment data window lists.
4. Click OK to save the settings and close the dialog box.
Related Topics
• Calibration and Maintenance > General (Preferences), page 166
• Selecting Test Equipment, page 1152

Calibration Module
Entering Calibration Data

This is the second stage in building a tag's calibration history. When you record the
calibration results, you add a new calibration result entry to the tag's calibration
history.
You can record the calibration results for a selected tag only after you have defined
that tag's calibration settings.
Enter Calibration Data

1. In the Calibration Settings window, do one of the following:
• Click Actions > Data Entry.
• Finish entering the tag's calibration settings and click Save . You
are prompted to open the Calibration Data Entry window for the
current tag.
2. In the Calibration Data Entry window, on the module toolbar, click Refresh
.
3. Click the Data Entry tab and enter values in each section by typing or selecting
from the lists.
4. Do the following for each of the points that you defined for the current tag in the
Calibration Settings window:
a. In the Calibration Data Entry window, in the Alarms / Trips section, click
First Point, Second Point, Third Point, Fourth Point, Fifth Point, or Sixth
Point.
b. Under As Found, type the value before calibration.
c. Under As left, type the value after calibration.
d. In the Codes section, enter general calibration information as you require.
e. From the Result Code list, select the desired standard result code, or custom
result code predefined in the Result Code dialog box.
f. If from the Result code list you selected Failed or any other option that
indicates a calibration result failure, from the Diagnostic code list, select a
calibration diagnostic code for this kind of failure.
g. If from the Result code list you selected Failed or any other option that
indicates a calibration result failure, from the Action code list, select an action
code associated with a solution description for this kind of failure.

Calibration Module
h. If from the Result code list you selected Failed or any other option that
indicates a calibration result failure, from the Damage code list, select a
damage code associated with a solution description for this kind of failure.
Tip
•If a desired Result, Diagnostic, Damage, or Action code is not
available from the list, you can define additional codes by selecting
the appropriate item on the Options menu.
i. Enter additional values, and a short note if needed.
5. Click the Result Points tab and type the pre-calibration values in the As Found
column.
Tips
• Values highlighted in red exceed the permissible error.
• Values highlighted in cyan exceed the intermediate error tolerances,
but do not exceed the permissible error.
6. After calibration of the instrument, type the values in the As Left column.
Tips
• Any As Found or As Left values still highlighted in red show that this
instrument's calibration failed. When you save the updated data, the
software prompts you to create a Work Request (Performing
Breakdown Maintenance, page 1103).
• To enter data for custom fields, click the Custom tab.
fields. Note that the custom fields in the Calibration Settings
window are independent of the custom fields in the Calibration Data
Entry window.
7. Click Save .
8. To browse through the tags that you selected, click or .
Related Topics
• Calibration Error Calculations, page 1155
• Managing Test Equipment Data, page 1148

Calibration Module
Selecting Test Equipment

Test equipment is equipment you use for calibrating and recalibrating instrument tags.
Selecting test equipment enables you to view its detailed information in the
Calibration History window. You will be able to see this information when viewing
calibration history results for this instrument tag. Selecting test equipment also
allows including test equipment detailed information in the Instrument Calibration
Results report.
For the current instrument tag, you are allowed to select the same equipment up to
four times (you may need to do so when using the same equipment for different
calibration purposes). Then, in the Calibration History window, you can see
detailed information about the test equipment that has been used for each calibration
entry. This information is retrieved from the Test Equipment supporting table.
Note
• If the Test Equipment lists contain no data, you can customize test
equipment data in the Test Equipment dialog box. (for details, see
Managing Test Equipment Data, page 1148).
Select Test Equipment

2. In the Calibration Data Entry window, in the Test equipment section, select the
required predefined test equipment from the First test equipment, Second test
equipment, Third test equipment, and Fourth test equipment lists.
Tip
• The data in all the lists is identical. Therefore, if you have used the
same test equipment for calibrating the current tag, you can select this
equipment from these lists up to four times.
3. Click Save .
Tip
• You can now open the Calibration History window to view the
instrument tag history with detailed test equipment information, or
generate a report that will contain detailed information about the
selected test equipment.
Related Topics
• Managing Test Equipment Data, page 1148

Calibration Module
Loop Error Calculation: An Overview

The loop error feature offers you three different methods to calculate the total error of
a selected loop: normal, absolute, and root mean square. The calculation is performed
per loop based on one or more instrument tags belonging to the loop.
The error is measured at several points that you predefine in the Calibration Settings
window. The error is calculated at the default point that you define in the
Preferences dialog box. The loop error is measured relative to the largest tolerance
value of all the calibration data for the tags that are included in the loop error
calculation.
Related Topics
• Calculating Loop Error, page 1158
• Setting Tags for Loop Error Calculation, page 1156

Calibration Module
Loop Error Calculation Common Tasks

When performing a loop error calculation, you need to perform the tasks indicated in
this section.
Caution
• To make a valid loop error calculation, make sure that your calibration
and calculation have been time stamped on the same day.
• Set the value of the loop error calculation method and the loop
calculation point on the Preferences dialog box.
• Define the calibration settings for the selected tags. Tags have their
predefined settings which you enter in the Calibration Settings
window. When you calculate the loop error of a specific loop you
should use the settings to include at least one tag that belongs to the
designated loop (Setting Tags for Loop Error Calculation, page 1156).
• Enter calibration data for the selected tags in the loop (Entering
Calibration Data, page 1150.
• Select the desired calculation method and perform the actual
calculation (Calculating Loop Error, page 1158).
• Generate a loop error report (Generating Calibration Reports, page
1164).

Calibration Module
Calibration Error Calculations

This section describes how the software calculates the calibration errors.
As Found and As Left Errors (% of Span) Calculation

The following formula is used to calculate the As Found and the As Left errors (% of
Span):
Where i = calibration point number
As Found and As Left Errors (% of Reading) Calculation

The following formula is used to calculate the As Found and the As Left errors (% of
Reading):
Where i = calibration point number
Error Calculation of Square Root Extraction

Calibration errors for differential pressure flow instruments that require a square root
extraction are calculated according to the following formula:
Example:
out.signalmin = 4 mA
out.signalmax = 20 mA
out.signal range = out.signalmax – out.signalmin = 16mA
% of Input Output Value

0 4 + (16 * 0) = 4
25% 4 + (16 * 0.5) = 12
50% 4 + (16 * 0.707) = 15.3137
75% 4 + (16 * 0.866) = 17.8564
100% 4 + (16 * 1) = 20

Calibration Module
Setting Tags for Loop Error Calculation

This procedure explains how to set tags associated with a certain loop for inclusion in
the loop error calculation.
Important
• You must calibrate the tags before you perform the actual loop error
calculation.
• You can also set the tags for inclusion from a view that you create in
the Browser module. If you use a browser view to set the tags, make
sure that you include the Tag Number, Loop Number, and
Calibration Required columns.
Set Tags for Loop Error Calculation

2. On the Preferences dialog box, do the following:
a. In the tree view, click Calibration > General.
b. From the Calculation method list, select the desired loop calculation method.
Select Ask user if you want the software to prompt the user for the method at
the time of performing the loop error calculation.
c. Beside Calculate at point, enter a value between 1 and 100.
Tip
• The value is set by default to 75%.
• Click .
5. On the Enter Tag Number dialog box, type a tag number or click Find to find
the required instrument tags.
Tips
• You must select at least one tag for each loop that you want to
calculate.
• If you selected more than one tag, click Actions > List Tags and then
click the desired tag number to define the settings for that instrument.
6. In the Calibration Settings window, in the Errors / Points section, from the
Include in loop error list, select Yes.

Calibration Module
7. Define all the remaining settings as needed.

8. Click Save to save the settings.
Tip
• You can now start entering calibration data by selecting Yes when
prompted after saving the data. Click No when prompted to start the
data entry to continue to define calibration settings for another tag
number.
Related Topics

Calibration Module
Calculating Loop Error

After you set tags for loop error calculation, use this procedure to do the following:
• Select tags from a given loop for loop error calculation

• Select a loop error calculation method
• Perform the loop error calculation
Calculate the Loop Error

1. In the Calibration Module window, click .
2. On the Enter Tag Number dialog box, click Find to open the Find Tag dialog
box.
3. Under Search parameters, set conditions to filter the tag display as necessary
and click OK.
Important
• To ensure that an instrument tag is included in a loop error calculation,
in the Calibration Settings window, you must set Include in loop
error for that tag to Yes (for details, see Setting Tags for Loop Error
Calculation, page 1156).
• For all instrument tags that are included in a loop error calculation,
you must specify the Tolerance units of measure value as %.
4. Under Search results, select the tags that you want to include in the loop error
calculation, and click OK.
5. In the Calibration Data Entry window, enter the calibration data for the tags that
you selected.
6. Do one of the following to navigate among the tags that you selected for error
calculation:
• On the module toolbar, click to open the Tag List pop-up window,
and click the tag for which you want to enter calibration data.
• On the module toolbar, click Next to display the next tag or click
Previous to display the previous tag.
Tip
• You have to enter the calibration data for all the tags that you want to
include in a loop error calculation on the same day that you intend to
perform the calculation. If you enter tag calibration data more than
once on a calculation day, the calculation is performed using the
results that deviated the most from the predefined tolerance.

Calibration Module
7. Click Options > Loop Error.

8. If a message appears with a list of tag numbers that are not yet calibrated, do the
following:
a. In the Calibration Data Entry window, enter the calibration data for the
desired tag numbers.
b. Click Options > Loop Error.
9. On the Loop Error Calculation Method message box, select the desired
calculation method.
Caution
• The calculation method that you set here cannot be changed later.
Make sure that you set the optimal calculation method for the selected
loop.
10. Click OK.
11. On the Loop Error Result dialog box, after you view the results, click Close.
Related Topics
• Setting Tags for Loop Error Calculation, page 1156

Calibration Module
Maintaining Calibration History

This option allows you to view a tag calibration entry settings and results. Using this
option, you can easily browse through the displayed entries and select a calibration
record to view or delete.
You can view calibration history for a specific instrument tag Calibration History
window, which has the following tabs:
• Data History– contains the existing calibration history records for the
current tag.
• Result Points History– displays the result points for the selected
record.
• Custom Fields – allows you to define custom fields for the history.
Tips
fields in the Calibration module.
• The custom fields in the Calibration History window are independent
of the custom fields in the Calibration Settings and Calibration Data
Entry windows.
Related Topics

Calibration Module
Deleting a Calibration Result Entry

Use the following procedure to delete a calibration result entry. Note that you cannot
delete the calibration settings even if you delete all the calibration result entries.
Delete a Calibration Result Entry

1. Open the desired instrument tag in the Calibration History window.
2. If more than one history record exists for the selected instrument tag, click
Previous or Next to navigate to the desired record.
3. Click Delete .
4. At the prompt, click OK to delete the selected calibration history entry from the
database.
5. Click Save .
Related Topics

Calibration Module
Viewing and Modifying Calibration Results

You can modify the calibration results when viewing a selected calibration history
record in the Calibration History window.
View Or Modify the Calibration Results

1. Open the desired instrument tag in the Calibration History window.
2. If more than one history record exists for the selected instrument tag, click
Previous or Next to navigate to the desired record.
3. In the Calibration History data window, click the Result Points History tab.
4. Click to allow editing of the As Found and As Left result code values.
Tip
• If you want to disregard the calibration results for a particular tag,
from the Result code list, you can select the value Bad Result.
5. When done, click Save .
Related Topics
• Generating Calibration History Reports, page 1165
• Generating Calibration Reports, page 1164

Calibration Module
Calibration Reports
The following list describes some of the reports that are available in the Calibration
module.
Report Name Description

Check List - By Loop Displays a check list of input and output
ranges and data used for calibrating all the
instruments of the loops selected by the
report filter.
Check List - By Tag Displays a check list of input and output
ranges and data used for calibrating all the
instruments selected by the report filter.
History Event Details
Calibration Results Generates a summary of the selected tag's
calibration results, calibration settings, a
graphic representation of the error
percentage, and test equipment used for
calibrating this tag.
Instrument Calibration Results Report Generates a summary of the selected tag's
calibration results, calibration settings, a
graphic representation of the error
percentage, and test equipment used for
Alarm / Trip Points Summary Generates a summary of the trip and alarm
point data of all selected tags.
Calibration Results Report Displays the calibration results without
the graphs.

Calibration Module
Generating Calibration Reports

Use the following procedure to generate calibration reports.
Generate Calibration Reports

1. In the appropriate Calibration module window, on the Reports menu, click the
menu option for the report that you want to generate.
2. If a filter dialog box opens, do the following, as available:
a. In the Date range group box, do one of the following to set the date range for
the report:
• To set a specific date range, select Specified dates, and then in the
From and To lists enter the date range.
• To generate a report for the [previous, current, or next] [week,
month, or year], select Predefined period, and then in the lists to
the right, select the options that you need.
b. In the Filter by group box, use the options to set a filter condition for the
report that you are generating.
3. Click OK.
Notes
• For reports by tag or by loop, click to search for the items that you
want.
• The loop error report can be displayed even if a loop error calculation
was not performed on that day; however, the report is only of an
earlier calculation date. The default calculation method that the report
depends upon is Normal values. However, if you select a calculation
method other than Normal for a certain loop the calculation report
changes respectively.
• To generate a calibration equipment report, type the name of the
equipment, with or without wildcards, in the Calibration equipment
field. If you do not enter a value for calibration equipment, you can
click OK and select the desired item from the Select Test Equipment
dialog box.
Related Topics
• Generating Calibration History Reports, page 1165
• Printing and Saving Documents: An Overview, page 101

Calibration Module
Generating Calibration History Reports

The following calibration reports are available only from the Calibration History
window:
Report Name Description

Instrument Calibration Results A summary of calibration settings,
calibration results, a graphic presentation
of the error percentage for the selected
tag, and test equipment used for
Alarm / Trip Points Summary A summary of trip and alarm point data of
all instruments.
Generate Calibration History Reports

1. Open the Calibration History window.
• Click Reports > Calibration Results
• Click Reports > Alarm / Trip Points Summary
3. At the Print Preview Request prompt, do one of the following:
• To display the report preview, click Yes.
• To print the report without preview, click No.
Related Topics
• Generating Calibration Reports, page 1164
• Printing and Saving Documents: An Overview, page 101

Calibration Module
Working with the Fluke Interface

This interface allows you to exchange calibration data with Fluke Documenting
Process Calibrator models 743B and 744. By means of wizards, you can download
(export) tag number data to the calibrator, and after collecting the calibration data,
you can upload (import) calibration data into SmartPlant Instrumentation for all of the
calibrated tag numbers.
Note
• If you are working on a Citrix console to which a Fluke Calibrator is
connected, to enable the software to detect the calibrator on the serial
port located on the client machine, you must first map the serial port to
the client machine as follows:
1. Within the Citrix console, at the server location, click Start > Run.
2. On the Run dialog box, in the Open box, type:
3. cmd
4. At the command prompt, type:
5. net use
• summary of the mapping between local and remote ports similar to the
following should appear:
6. If the desired port, for example COM 1, does not appear in the summary, then
type:
7. net use COM1: \\Client\COM1:
8. At the command prompt, type net use again and check that the desired serial port
is now included in the mapping.

Calibration Module
Downloading Data from SmartPlant Instrumentation

1. Connect the Fluke Documenting Process Calibrator to your computer's COM port
and switch on as described in the Fluke Users Manual.
2. Open the Calibration module and from the Calibration Settings window, define
the source and output value ranges and units of measure for the desired tag
numbers.
Tip
• When performing a calibration for a thermocouple using the Fluke
calibrator as an external power supply, you must enter the following
data using the custom fields indicated:
3.
Custom Field Property Acceptable Value
CALIB_SET_UDF_C16 Loop power 24V / 28V
CALIB_SET_UDF_C17 Thermocouple type E/N/J/K/T/B/R/S
/C/L/U
CALIB_SET_UDF_C18 Thermocouple source mode Linear MV / Linear T
4. Click Actions > Fluke Interface.

5. Click Next.
6. On the Connection Options page, define your connection setting and click Test.
Tip
• If the connection test is successful, an appropriate message appears in
the Connection result box. If the connection fails, check the physical
connections and if necessary, select a different communication port
and retry.
7. Click Next to go to the Activity Selector page.
Tip
• If you first want to clear the calibrator, click Flush calibrator
memory, ensure that the Upload default memlist and procedures
check box is selected, and then click Next. On completion of the
process click Back.
8. Click Download data from SmartPlant Instrumentation to the calibrator.
9. On the Tag Selection for Download page, select the Export check box beside
each tag that you want to download to the calibrator, and then click Next.
10. On the Download Data page, click Start to begin the download.

Calibration Module
Tip
• The progress bars indicate the current activity. You will also see an
indication on the calibrator that data is uploading to it.
Note
• This procedure downloads the following data to the Fluke calibrator:
• Tag number.
• Component_ID value – this is a unique value that SmartPlant
Instrumentation automatically generates on creation of a tag number.
This number is displayed in the Fluke calibrator interface as the tag
serial number. Do not modify this number, either from the calibrator
or from the SmartPlant Instrumentation database.
• Source maximum and minimum range values and their units of
measure.
• Output measurement maximum and minimum range values and their
units of measure.
• Calibration strategy.
• Tolerance.
The following table shows a sample set of downloaded data values:
Tag Rang Rang Rang Outpu Outpu Outpu Strategy Toleranc

Numbe e e e t t t (Calibratio e
r Min. Max. UOM Signal Signal Signal n error
Min. Max. UOM type)
101-TT 100 200 °C 4 20 mA 3 1
-100 ↑&dar
r;
101-PT 0 10 Bar 4 20 mA 5 ↑ 1.5
-200 (G)
101-LT 0 1000 mm 4 20 mA 3 ↑ 2
-300

Calibration Module
Uploading Data from the Fluke Calibrator

1. After calibrating your instruments, connect the Fluke Documenting Process
Calibrator to your computer's COM port and switch on as described in the Fluke
Users Manual.
2. Open the Calibration module.
3. Click Actions > Fluke Interface.
4. Click Next.
5. On the Connection Options page, define your connection setting and click Test.
Tip
• If the connection test is successful, an appropriate message appears in
the Connection result box. If the connection fails, check the physical
connections and if necessary, select a different communication port
and retry.
6. Click Next to go to the Activity Selector page.
7. Click Upload data into SmartPlant Instrumentation from the calibrator.
8. Click Next.
9. On the Upload Data page, click Start to begin uploading data from the
calibrator.
Tip
• The progress bars indicate the current activity. You will also see an
indication on the calibrator that data is downloading from it.
10. On completion of the upload process, click Next.
11. On the Upload Summary page, view the tags for which the interface has
uploaded calibration data into SmartPlant Instrumentation.
12. Click Finish to complete the operation.
13. In SmartPlant Instrumentation, open the Calibration module and from the
Calibration History window, view the tag calibration data.

Process Data Module
Process Data Module

The Process Data module enables you to efficiently define process conditions for a
particular instrument or line. These process conditions then become the reference
point for the system. Process data for instruments relates to seven process functions:
Flow, Temperature, Pressure, Level, Analyzer, Control Valve, and Relief Valve. The
data - including the process units of measure - can be modified at any time when
desired.
Batch creation of process data sheets can be done by adapting existing instruments
and lines using an interface that allows process characteristics to be simultaneously
assigned to several instrument groups, thus ensuring system-wide integrity.
The Process Data module shares data with loop components that are associated with a
given process. Data is also shared with the Specifications, Calculations, and
Instrument Index modules, allowing all the data from these modules to be
incorporated into generated reports.

Process Data Module
Process Data Principles

SmartPlant Instrumentation enables you to store and manage process data for lines
and instruments.
To view process data for instruments, enter the tag number directly when prompted,
or use the search utility. To view lines, select the desired line in the Select Line
dialog box.
If instruments or lines have none or partial process data attached, you can do either of
the following:
• Enter new data.

• Modify existing data (including automatic conversion of units as
desired).
Notes
• When the Workflow option is activated, only instrument tags marked
Process Data Required are visible in process data sheets.
• Saving process data modifications makes them accessible to other
modules. When you generate a report that includes process data, you
can set SmartPlant Instrumentation to prompt you that the relevant
process data has been changed.
• You cannot generate process data sheets for virtual tags.
Related Topics
• Adding a New Line, page 1184
• Modifying Line Properties, page 1185
Start the Process Data Module

Before starting this module, check with the Domain Administrator to ensure that you
have been granted appropriate access rights for the tasks you will carry out.
• In any main SmartPlant Instrumentation window, do one of the

following:
• Click Modules > Process Data.

Process Data Module
Select a New Process Data Status

There are five statuses that relate to Workflow. For information on all five statuses,
see Process Data Statuses, page 100. The Select a New Process Data Status dialog
box becomes available for tags for which the instrument engineer, in the Workflow
Instrumentation / Process Data Browser, has set a status of Process Data Required.
To access this dialog box, a member of the process engineering group needs to open a
process data sheet for an instrument or line, modify some of the values, and click .
Status list — Accept the default Do not change status, or change the status to one
of the following:

Lock out from Instrument Tags marked for editing by the Set and changed by
process engineering group and process engineer
not available to the instrument
group.
Release to Instrument Tags available to the Set by process
instrument engineering group engineer. Can be
following release from the changed by instrument
process group. engineer.
Custom Fields
You use this section of a process data or calculation sheet for custom fields ,as
defined by the Domain Administrator. Note that the Domain Administrator can also
enable custom fields in the other sections of process data sheets for a given <plant>.
Opening an Instrument Tag in the Process Data Module

These procedures explain how to create, open, and define basic process data for an
instrument tag in the Process Data module. Although you usually create tags in the
Instrument Index module, the ability to create tags in the Process Data module allows
for efficient creation of complex analyzers, for example.
Note
• To create stream and component tags. For a complex analyzer, see
Defining a Complex Analyzer, page 1198.

Process Data Module
Create an Instrument Tag in the Process Data Module

1. In the Process Data window, on the module toolbar, click .
2. In the Enter Tag Number dialog box, type the name of the new tag number
and click OK.
3. If the Select Instrument Type dialog box opens (because there is more than
one record for a given instrument type acronym), select the desired instrument
type and click OK.
• Accept the displayed loop number and click OK.
• Type the loop number that you need and click OK.
• To create the tag number without a loop association, click Cancel.
5. In the Tag Number Properties dialog box, on the General tab, enter the
appropriate values.
Tips
• If you are creating a complex analyzer, do NOT at this point select
a line from the Line list.
6. Click OK.
Open an Instrument Tag in the Process Data Module

1. On the module toolbar, click .
2. In the Enter Tag Number dialog box, do one of the following:
• Type the desired tag number.
• Click Find to open the Find Tag dialog box and find a desired tag
number.
• Click OK.

Process Data Module
Define Basic Process Data for an Instrument Tag

1. Do one of the following to open a tag in the Process Data module:
• Create a tag.
• Open a tag that you created previously.
2. In the Process Data dialog box, do the following:
a. Select a fluid state.
b. If you are creating an analyzer, do one of the following from the Analyzer
type list:
• To create a simple analyzer, select Simple.
• To create a complex analyzer, select Complex.
c. Click OK.
3. If the Complex Analyzer Tag Manager dialog box opens, define the
complex analyzer (for details, see Defining a Complex Analyzer, page 1198.).
4. In the process data sheet for the tag that you opened, under Line number,
select the line number to which the tag is connected.
Tips
• If you confirm the prompt to copy the line data, all relevant line
properties and data are copied to the tag process data sheet that you
are editing.
• If you selected a line that you configured for a complex analyzer,
SmartPlant Instrumentation copies the data from the Line
Component table for that line into the ANALYZER /
COMPONENT PROPERTIES section of the data sheet.
5. Enter the remaining process data as needed.
6. If you are defining a complex analyzer, link analyzer stream component tags
with line components, see Linking Analyzer Stream Components with Line
Components., page Error! Bookmark not defined..
7. If you are defining a simple or a complex analyzer, in the ANALYZER
COMPONENT / PROPERTY section, enter values and units of measure in
the Repeatability, Accuracy, Minimum detection limit, and Range fields as
needed.

Process Data Module
Edit Instrument Process Data

This procedure explains how to edit the process data associated with an instrument
tag. You can edit instrument process data from the Process Data module or from the
Calculation module.
1. Open the process data sheet for an instrument tag from the Process Data module
or the Calculation module.
2. In the Process Data window, modify the process data as needed in the following
sections:
• GENERAL
• PROPERTIES
• ADDITIONAL PROPERTIES
• BASECONDITIONS
• API2540 STANDARD
• CUSTOMFIELDS
• NOTE
Tips
• If you are creating a multi-case tag, you can enter values for each case
that you create (for details, see Multiple Process Data Cases, page
1190).
• If the Domain Administrator enabled the use of process data custom
fields, the above sections can display such fields.
3. On the module toolbar, click to save the values.
Related Topics
• API 2540 Standard for Liquid Density Calculation, page 1202
• Fluid Definition, page 1217
• Modifying Instrument Base Conditions, page 1176
• Multiple Process Data Cases, page 1190

Process Data Module
Modify Instrument Base Conditions

Use this procedure to modify base condition values when entering data for Control
Valve, Relief Valve, or Flowmeter calculations, from the Process Data or Calculation
modules.
2. Scroll to the BASE CONDITIONS section.
3. Select a base pressure unit of measure, and beside Pressure type the base
pressure.
4. Select a temperature scale, and beside Temperature, type the base temperature.
5. According to the state that you selected under Fluid, select the desired basic
property as follows:
• If the state is solid/powder, do one of the following:
• Select Density @base, select a unit of measure, and type the
density value.
• Select Specific Gravity @base, and type the specific gravity
value.
• If the state is liquid, do one of the following:
density value.
value.
• If the state is water, do one of the following:
density value.
value.
• If the state is gas/vapor, do one of the following:
density value.
• Select Compressibility @base, and type the compressibility
value.
• If the state is steam, beside Compressibility @base, type the desired
value.
6. To save your changes, on the module toolbar, click .

Process Data Module
Copy Instrument Process Data from Another Instrument

This option allows you to copy instrument process data from any existing instrument
to the currently selected instrument.
1. Open the target process data sheet.
2. In the Process Data window, on the Edit menu, point to Copy and click From
Instrument.
3. In the Enter Tag Number dialog box, do one of the following:
• In the text box, type the source tag number.
• To search for the source tag, click Find.
Tip
• You can only copy data from a tag number of the same instrument
type.
4. To select a source case other than the governing case, do the following:
a. Click Change.
b. In the Select Case dialog box, from the Available cases list, select the source
case.
c. Click OK.
5. In the Enter Tag Number dialog box, click OK.

Process Data Module
Propagating Line Process Data to an Instrument

Tag
These procedures allow you to propagate relevant process data from a line to the
current tag. Before you perform either of these procedures, you can set a filter that
limits the fields that you propagate (for details, see Setting the Line-to-Tag Filter,
page 1180.
Notes
• The current procedures propagate line process data to a single tag. For
details of how to propagate line data to more than one tag, see Batch
Propagation of Line Data to Instrument Tags, page 1179.Preventive
Maintenance technician options include filling out test results.<Unit>
• Use the current procedures to propagate multi-case process data from a
line to a tag, since the batch procedure propagates process data from
the governing case only.
Propagate Process Data From the Current Line to the

Current Instrument
1. Open and edit the process data sheet for the instrument to which you want to
propagate process data from a line.
2. On the Edit menu, point to Copy and then click From Line.
Propagate Process Data From Any Line to the Current

Instrument
1. Open and edit the process data sheet for the instrument to which you want to
propagate process data from a line.
2. In the GENERAL section of process data sheet, from the Line number list,
select the line from which you want to propagate the process data to the current
tag.
Tip
• SmartPlant Instrumentation automatically propagates the relevant
process data from the line that you select to the current tag.
Related Topics
• Batch Propagation of Line Data to Instrument Tags, page 1179
• Setting the Line-to-Tag Filter, page 1180

Process Data Module
Batch Propagation of Line Data to Instrument Tags

This procedure allows you to propagate process data from a particular line to tags that
you select. Before you perform this procedure, you can set a filter that limits the
fields that you propagate (for details, see Setting the Line-to-Tag Filter, page 1180.).
Note
• This procedure propagates the governing case only. For details of how
to propagate all cases from a given line to a given tag, see Propagating
Line Process Data to an Instrument Tag, page 1178.
Propagate Line Data to a Batch of Instrument Tags

• Open the Process Data Module window.
• Open a process data sheet for a line.
2. On the Actions menu, click Propagate Line Data.
3. In the Propagate Line Data dialog box, from the Line number list, select the
source line from which you want to propagate the data to the tags.
4. Select the target tags by doing one of the following:
• To select a group of target tags, select one of the following options
from the Propagation method list:
• Include all tags
• Include all tag numbers with process data
• Include all tag numbers without process data
• To select target tags individually, click Find to open the Find Tag
dialog box, where you select the specific target tags.
5. In the Propagate Line Data dialog box, click Propagate.
Tip
• The propagated results are shown in the Processed tags data window
(a selected box in the Done column signifies successful processing of
data).
6. Click Close.
Related Topics
• Propagating Line Process Data to an Instrument Tag, page 1178
• Setting the Line-to-Tag Filter, page 1180

Process Data Module
Setting the Line-to-Tag Filter

This procedure enables you to set a process data line-to-tag filter. When you
propagate process data from lines to instruments, only the selected properties are
propagated. The current filter settings affect both of the following procedures:

Select Line Properties

1. In the Process Data Module window, on the Edit menu, click Select Line
Properties for Copying.
2. In the data window, clear the selection of fields that you do not want to copy from
lines to tags.
Tip
• If you want to select a few fields only for copying, select and then
clear the Select all check box to clear all the fields first.
3. Click OK.
Related Topics

Process Data Module
Process Data for Differential Pressure Instruments

Note
• After setting the default units of measure for the current unit in the
Units of Measure and Accuracy dialog box, you can select the
desired default unit of measure for Differential Pressure (DP
instrument).
Define Process Data for a Differential Pressure Instrument

1. Open the desired pressure instrument process data sheet.
2. From the Pressure type list, select Differential Pressure.
Tips
• The Pressure property label changes to Differential pressure.
• From the unit of measure flag lists throughout the process data sheet,
you can select the Differential unit of measure flag.
3. Under PROPERTIES and ADDITIONAL PROPERTIES, enter the appropriate
process data values.
4. Under ALARM, define the alarm and trip settings as needed.
Delete Instrument Process Data

This option enables you to delete instrument process data. Note that you cannot
delete any tags in the Process Data module. Tag numbers are deleted in the
Important
• The deletion process is irreversible. Once you have deleted the
process data, you cannot restore it!
1. With the Process Data Module window open, on the Edit menu point to Delete
Process Data and click Instrument.
2. In the Enter Tag Number for Deletion dialog box, do one of the following:
• In the text box, type tag for which you want to delete process data.
• To search for the tag, click Find.
3. Click OK.

Process Data Module
Calculating Physical Properties

The Fluid Properties Database allows you to calculate the properties of the chosen
material according to its pressure and temperature.
The calculated properties are:
For Liquid For Gas

Density and Specific Gravity Density and Specific Gravity
Vapor pressure Compressibility
Viscosity Viscosity
Liquid Heat Capacity Specific Heat Ratio
Note
• This option is not available for materials where the state is
solid/powder, nor for 2-phase flow.
Calculate the Properties of a Selected Material

1. Open the desired process data sheet.
2. In the Process Data window, from the Fluid name source list, select Database.
3. From the Fluid list, select the desired fluid.
4. In the PROPERTIES section, enter the appropriate pressure and temperature
values.
Notes
• SmartPlant Instrumentation calculates and displays changed values.
• SmartPlant Instrumentation uses the AIChE databank to calculate
physical properties; therefore your values must comply with the
AIChE temperature limits. Note that AIChE data does not provide
accurate calculation of density, compressibility, and specific gravity
for ethylene and propylene at critical pressure and temperature. For
this reason, the software implements the procedure described in
William C. Reynolds, SI, Department of Mechanical Engineering,
Stanford University.
• To calculate liquid density, on the Options menu, click Calculate
Liquid Compressibility.
• To calculate the steam properties, on the Options menu, click
Saturated Steam.

Process Data Module
Add a New Line Type

This option enables you to add a new line type to the Line Type list in the Select
Line dialog box.
1. In the Process Data Module window, on the module toolbar, click .

2. In the Select Line dialog box, next to the Line Type list, click .
3. In the Line Types dialog box, click New.
4. Type the new line type name and description in the appropriate fields.
5. Click OK.
Related Topics
• Changing the Line Type, page 1183
• Deleting a Line Type, page 1184
• Editing a Line Type, page 1183
Edite a Line Type

This procedure explains how to edit a line type.

2. In the Select Line dialog box, beside the Line type list, click .
3. In the Line Type dialog box, make the necessary changes.
4. Click OK.
Related Topics
• Adding a New Line Type, page 1183
• Changing the Line Type, page 1183
• Deleting a Line Type, page 1184
Change the Line Type

This procedure explains how to change the line type for a specific line.

2. In the Select Line dialog box, do one of the following:
• To display lines of all line types, select Show all line types.
• From the Line type list, select the current line type of the desired line.
3. In the data window, select the desired line, and click Change Type.
4. Select the new line type and click OK.

Process Data Module
Delete a Line Type

This option enables you to delete a line type. You cannot delete a line type if it
includes a record, i.e., if it is associated with a line.

2. In the Select Line dialog box, next to the Line Type list, click .
3. In the data window, select the line type that you want to delete, and click Delete.
4. Click OK.
Note
• Line numbers cannot be deleted in the Process Data module — only
process data. You can delete a line only in the Instrument Index
module.
Related Topics
• Editing a Line Type, page 1183
Add a New Line

Use this procedure to add a new line from the Process Data module.
1. In the Process Data Module window, do one of the following:
• On the process data toolbar, click .

• On the Edit menu, point to Open Process Data, and click Line.
2. In the Select Line dialog box, from the Line type list, select a line type.
Tip
• To create a new line type, click beside the Line type list.
3. Click New.
4. In the Line Properties dialog box, complete the data fields of the left column as
follows:
a. In the Line number box, type the desired value.
b. From the P&ID list, select the drawing associated with this line.
c. In the Stream name box, type the optional stream name.
d. From the Pipe material list, select the pipe material.
e. From the Pipe spec list, select the pipe spec, or click to open a dialog box
where you manage pipe specs.

Process Data Module
5. To complete the data fields of the right column, do one of the following:
• If under Pipe standard you select ANSI or DIN, this opens the Pipe
Data dialog box. Select one of the predetermined sets of values, and
click OK to transfer these values back to the Line Properties dialog
box.
• If under Pipe standard you select Other, enter the remaining right
column values manually.
6. In the Line Properties dialog box, click OK.
7. In the Select Line dialog box, click OK.
8. If the Process Data dialog box opens, select a fluid state and click OK.
9. In the Process Data for Line window, enter process data for the new line.
10. On the Actions menu, click Save Process Data.
Related Topics
• Managing Line Component Tables, page 1197
Modify Line Properties

You can edit line data in either the Process Data or the Instrument Index modules.
This procedure applies to the Process Data module.
• On the process data toolbar, click .

• On the Edit menu, point to Open Process Data and click Line.
2. In the Select Line dialog box, select the row containing the line data you want to
edit.
3. Click Properties to open the Line Properties dialog box.
4. Modify the appropriate values in the Line Properties dialog box as follows:
• Edit the line number name.
• Select another pipe material.
• Select another pipe standard.
• Select another pipe spec.
5. When done, click OK to return to the Select Line dialog box.

Process Data Module
Duplicate a Line
Lines folder.
2. Double-click the Lines folder to display the existing lines.
3. Right-click the loop you want to duplicate, and on the shortcut menu, click
Duplicate.
4. On the Line Properties dialog box, type the new line number.
Tip
• The data field on the Line Properties dialog box displays the line
name template which is based on the line 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 line in a different <unit> in
the current domain:
6. On the Line Properties dialog box, click OK.
7. The duplicated line has the same piping data as the line it was duplicated from,
however, you can change the pipe associated with the line as follows:
a. On the Line Properties dialog box, click Pipe Data.
b. Select the appropriate line and click OK.
Related Topics
View Line Process Data

This procedure allows you to view a line process data before editing it.

2. In the Select Line dialog box, select the desired line type from the Line type list
to filter the data screen. Select All Line Types check box to display all available
lines.
3. Highlight the desired line number and click OK.
4. If the Process Data dialog box opens, select a fluid state and click OK.
5. In the Process Data for Line window, click .
Related Topics
• Editing Line Process Data - Fluid, page 1188
• Editing Line Process Data - Selecting Pipe Standards, page 1187

Process Data Module
Editing Line Process Data - Selecting Pipe Standards

Use this procedure to edit the pipe and line properties section of the Process Data for
Line window. There are parameters that you set directly, and others that you set from
the Pipe Data dialog box.
• For all pipe standard options — ANSI, DIN, and Other— you edit
the following parameters directly: pipe material, pipe spec, and wall
thickness.
• If your current selection from the Pipe Standard list is Other, you
can also edit Line size and its unit of measure, and Line Int.
diameter
• If your current selection from the Pipe standard list is ANSI or DIN,
SmartPlant Instrumentation allows you to set additional fields from the
Line Properties dialog box that opens. If you closed this dialog box
and want to reopen it, on the Options menu, click Pipe Data.
• The method and effects of changing the pipe standard, and the impact
of these changes on the current parameters, are summarized in the
table below:
Change Action Result
ANSI DIN: Select ANSI or DIN Select Other See the first and fourth
ANSI / DIN to Select ANSI or DIN notes. See the second
Other: Other to and third notes. See the
ANSI / DIN: first and third notes.
Notes
• The Pipe Data dialog box opens for new parameter selections.
• If you change your Pipe standard selection from ANSI or DIN to
Other, the parameter fields become editable.
• If you change from ANSI or DIN to Other, SmartPlant
Instrumentation hides the Line schedule field. If you change from
Other to ANSI or DIN, this field appears.
• If you change from ANSI to DIN or from DIN to ANSI, your
selection in the Pipe Data dialog box changes all parameters except
for pipe material and pipe spec.

Process Data Module
Editing Line Process Data - Fluid

A fluid is a material characterized according to state, name, and phase.
• Fluid state: Indicates whether the fluid is a generic liquid, water, a

generic gas, steam, or solid/powder. Selecting the fluid opens the
properties section with the appropriate parameters for selection.
• Fluid name: When the User-defined option is selected from the list,
you can type the name of the fluid in the text box.
• Fluid phase: The phase indicates whether the fluid is single or 2-
phase. This selection is for information only.
Copy Line Data from One Line to Another

This option allows to copy line data from a selected line to another line or to a group
of lines. If you are creating a complex analyzer with multi-stream analysis for a
given physical line, you need to create multiple virtual lines, each representing a
stream. You can use this procedure to copy settings from one instance of such a line
to the others.
1. In the Process Data Module window, on the Actions menu, click Copy Line
Data.
2. Under Source lines, do one of the following from the Line types list:
• Select All Line Types.
• Select a specific line type.
3. Under Line number, select the source line.
4. Under Target lines, do one of the following from the Line types list:
• Select All Line Types.
• Select a specific line type.
5. In the data window, select the target lines.
Tips
• You can use the filter data field to locate a specific line. Type the
name of the desired line / P&ID / stream in the respective field and
click the Apply Filter button. SmartPlant Instrumentation highlights
the line you were looking for. Another possibility is to select the As
typed check box and then type the line/P&ID/Stream name in the
respective field. The data is filtered as you type.
• You can sort the rows according to a column by double clicking the
column's header.
6. Click Copy to copy the data to the selected target lines.

Process Data Module
Delete Line Process Data

This procedure enables you to delete process data for a given line.
Important
• Before deleting process data, note that deleted process data cannot be
restored.
1. With the Process Data Module window open, on the Edit menu, point to Delete
Process Data and select Line.
2. In the Select Line to Delete Process Data dialog box, do one of the following to
display in the data window those lines whose process data has been defined:
• From the Line type list, select the desired line type.
• Select the Show all line types check box to display all the existing
lines with process data.
3. Highlight the desired line in the data window.
4. Click OK.
Line Fluid Velocity

SmartPlant Instrumentation calculates the line fluid velocity according to the line
internal diameter and volumetric fluid flow at flow conditions.
If you enter fluid flow as mass or volumetric flow at standard / normal / base
conditions, SmartPlant Instrumentation will calculate volumetric flow at flow
conditions first (using density values) and then the line fluid velocity.
Note
• For flowmeters, fluid velocity at operating conditions is calculated
automatically according to fluid flow and line internal diameter. If the
mass flow value has been entered, density is required for fluid velocity
calculation.

Process Data Module
Multiple Process Data Cases

A given instrument or line is often used for more than one operating service. For
example, a dual-fuel control system might use a single supply line and control valve
to carry various fuels, gas or liquid. Each group of process data settings that you
enter for a given instrument or line is called a case.
Note
• Each case has a separate drawing with its own revisions. Each
drawing includes the case name as part of the drawing name.
In the Process Data or Calculation modules, use the following procedures to
implement multiple process data cases:
• Creating Process Data Cases, page 1191.

• Setting a Governing Case, page 1192.
• Deleting a Process Data Case, page 1194.
• Managing the Cases Supporting Table, page 1193.

Process Data Module
Creating Process Data Cases

Use these procedures to do the following:
• Enable cases for a tag or a line by assigning a case name to the current
process data
• Add additional cases to the tag or the line, thus creating multiple cases
Note
• Case names that you assign to a given line or tag can be duplicates of
names that you assign to cases in other lines and tags.
For either of these procedures, do one of the following:
• Open the process data sheet for an instrument tag from the Process
Data module or the Calculation module.
Enable Cases for the Current Tag Or Line

1. On the Actions menu, click Enable Case.
2. In the Enable Case dialog box, do one of the following to select a case name for
the current data:
• Select an existing case name from the Available cases list.
• To create a new case name, click to open a dialog box where you
can create new case names.
3. Click OK.
Add a Case for the Current Tag Or Line

1. On the Actions menu, click Add Case.
2. In the Add Case dialog box, do one of the following to select a name for the new
case:
• Select an existing case name from the Available cases list.
• To create a new case name, click to open a dialog box where you
can create new case names.
3. Click OK.
4. Enter and save process data for the case that you created.

Process Data Module
Set a Governing Case

A governing case is the set of process data values for a line or a tag that you select as
the active case. If for a given line or a tag you create more than one case, SmartPlant
Instrumentation requires that you select a governing case. If you define a single case,
the software automatically sets it as the governing case.
Use this procedure to select a governing case for a line or a tag.
Note
• Once you have enabled cases for line or a tag, if there is only one case,
SmartPlant Instrumentation automatically defines it as the governing
case. If you subsequently enable additional cases, the first case still
remains the governing case until you set a new governing case.
2. In the GENERAL section of the process data sheet, from the Case list, select the
case that you want to be the governing case.
3. On the Actions menu, click Set as Governing.
Related Topics
• Creating Process Data Cases, page 1191
• Deleting a Process Data Case, page 1194
• Managing the Cases Supporting Table, page 1193

Process Data Module
Manage the Cases Supporting Table

You use cases to enable multiple sets of process data for a given instrument or line.
Use these procedures to create, edit and delete case names and their descriptions.
You can manage the Cases supporting table from the Process Data module or the
Calculation module.
Note
• Case names that you assign to a set of process data for a given line or
tag can be duplicates of names that you assign to cases in other lines
and tags.
1. Do one of the following to open the Cases dialog box:
• In the Process Data Module window, on the Edit menu, click Cases.
• In the Calculation module, do the following:
a. Create a case for a given tag.
• In the Enable Case dialog box, click .
• In the Add Case dialog box, click .
2. To add a new case name, click New, and then type a unique case name and an
optional description.
3. To edit an existing case name, click a value that you want to edit, and modify
values as needed.
4. To delete a case name, select the record that you want to delete, and click Delete.
Tip
• SmartPlant Instrumentation does not allow you to delete a case name
that is currently used on any process data sheet.
Related Topics
• Deleting a Process Data Case, page 1194
• Setting a Governing Case, page 1192

Process Data Module
Delete a Process Data Case

Use this procedure to delete a process data case that you created for a line or a tag.
Important
• Deletion of a case is irreversible.
2. Click Actions > Delete Case.
Related Topics
• Managing the Cases Supporting Table, page 1193
• Setting a Governing Case, page 1192

Process Data Module
Process Analyzers
Process analyzers measure physical or chemical properties of a process flow.
SmartPlant Instrumentation supports two types of process analyzers — simple and
complex.
Simple Analyzers
A simple analyzer measures one physical or chemical property of a process fluid at
the point of measurement or fluid sampling.
Complex Analyzers
A complex analyzer also measures physical and chemical properties of a process flow
at the point of measurement or fluid sampling. However, you have the following
elements of flexibility in a complex analyzer:
• You can create multiple stream tags.

• For each stream tag, you can create multiple component/property tags.
You can use the complex analyzer methodology even where only a single component
/ property is measured, if the data sheet information requires specifying the complete
process fluid composition for all components.
Although the application determines whether you define some analyzers as simple or
complex, gas chromatographs are by their nature complex. Even if you consider one
stream only, in general you will want to utilize the ability of a gas chromatograph to
analyze various components/properties in the stream.
For procedures related to complex analyzers, see Flow of Activities for Complex
Analyzers, page 1196.
Related Topics
• Flow of Activities for Complex Analyzers, page 1196

Process Data Module
Flow of Activities for Complex Analyzers

To implement a complex analyzer, for example a gas chromatograph, use the
following flow of activities (click a link for details):
• Adding a New Line, page 1184.

Note
• For multi-stream analysis in a single physical line, create multiple
virtual lines, each representing a stream.
• Managing Line Component Tables, page 1197. for the line or multiple
virtual lines.
• Defining an Instrument Type of process function type Ànalyzer' for
your complex analyzer.
• Opening an Instrument Tag in the Process Data Module, page 1172.
• Defining a Complex Analyzer, page 1198.
• Linking Analyzer Stream Components with Line Components, page
1199.

Process Data Module
Managing Line Component Tables

For each line that you defined for a complex analyzer tag, you need to create a line
components table. This table lists the fluid components of this line, together with
their minimum, normal, and maximum concentrations.
The Line Components table that you create individually for each line is based on a
Fluid Components supporting table — which you also manage — that is available
for all lines.
For both procedures, open a process data sheet for the line for which you want to
create a Line Components table.
Manage the Fluid Components Supporting Table

Note
• You can also perform this procedure from the Process Data window.
1. On the Edit menu, click Fluid Components.
2. To create a new fluid component, click New.
3. Click a value that you want to edit and modify the value as needed.
Create A Line Components Table For The Current Line

1. On the Edit menu, click Line Components.
2. For each fluid component that you want to enable for the current line, do the
following:
a. Click New to add a new row.
b. Under Fluid Component, select an available fluid component.
c. Under Concentration Units, accept the default % or select the unit of
measure that you need.
d. Type values for minimum, normal, and maximum concentration.
3. Click OK.
Related Topics
• Defining a Complex Analyzer, page 1198
1199
• Process Analyzers, page 1195

Process Data Module
Define a Complex Analyzer

You use this procedure in the course of creating a complex analyzer tag. Before you
perform this procedure, do the following:
• Adding a New Line, page 1184.

• Managing Line Component Tables, page 1197. for each line.
• Defining an Instrument Type of process function Ànalyzer' for your
complex analyzer.
1. In the Process Data module, create a complex analyzer tag.
2. In the Complex Analyzer Tag Manager dialog box, do the following for each
stream tag that you want to define:
a. To the right of the Analyzer stream list, click Add.
b. In the Add Tag Number dialog box, type the number of the stream tag that
you want to create.
c. In the dialog boxes that open, define properties as needed.
Tip
• Associate a line with the stream tag either in the Tag Number
Properties dialog box or in the process data sheet for the given stream
tag.
3. For each stream that you added to the Analyzer stream list, do the following to
create component tags that correspond to every component of the stream:
a. To the right of Analyzer component/property, click Add.
b. In the Add Tag Number dialog box, type the number of the component tag
that you want to create.
c. In the dialog boxes that open, define properties as needed.
4. In the Complex Analyzer Tag Manager dialog box, click OK.
Related Topics
1199

Process Data Module
Link Analyzer Stream Components with Line Components

Use this procedure to link analyzer component tags with line components. You must
perform this procedure for every stream of a complex analyzer.
1. In the Process Data module, open the stream tag.
2. In the GENERAL section, from the Line number list, select the desired line.
3. In response to the prompt, click Yes to copy data from the line to the process data
sheet.
4. In the ANALYZER COMPONENT / PROPERTY section, do the following for
each tag in the Analyzer/component list:
a. Select the analyzer component tag.
b. From the Line component list, select the fluid component that you want to
link with the analyzer component tag.
c. Enter values and units of measure in the Repeatability, Accuracy, Minimum
detection limit, and Range fields as needed.
d. On the Actions menu, click Save Process Data.
Related Topics
• Defining a Complex Analyzer, page 1198
Add an Insulation Type

You can add a new insulation type if the desired one is not available in the Insulation
list of the ADDITIONAL LINE PROPERTIES section of the Process Data for
Line window.
1. In the Process Data Module window, on the Edit menu, click Insulation Types.
2. In the Insulation Types dialog box, click New to add a new data line, where you
type the new insulation type name and description.
3. Click OK.

Process Data Module
Enter and Edit a Pipe or Orifice Material

This option enables you to enter additional pipe and orifice materials as well as
modify the existing ones. You can select the desired ANSI group and enter or modify
the linear expansion coefficients. It is possible to define linear expansion coefficients
in different ways:
• One linear expansion coefficient for all temperatures.

• One linear expansion coefficient with a limitation on the minimum
temperature (Tmin) or maximum temperature (Tmax).
• Two linear expansion coefficients and border temperature. This option
allows you to use the first linear expansion coefficient for temperatures
lower than the border temperature and the second linear expansion
coefficient for temperatures higher than the border temperature.
• Two linear expansion coefficients, border temperature, and
minimum/maximum temperature. This option allows you to use the
first linear expansion coefficient for temperatures between minimum
and border temperature and the second linear expansion coefficient for
temperature between border and maximum temperature.
Note
• This option is also available in the Calculation module.
1. In any Process Data module window, on the Edit menu, click Pipe/Orifice
Material.
2. In the data window, click fields that you want to edit, and type or select the
desired values from the lists.
3. To enter a new material, click New, and then type or select the desired value from
the respective lists.
4. To delete a material, select the desired data row and click Delete.
5. Click OK to apply changes and close this dialog box.

Process Data Module
Defining or Modifying Pipe Specs

Pipe spec is a specification that defines various process conditions for a specific pipe.
Use this procedure to define a pipe spec to the Pipe Specs supporting table from the
Process Data module, or to modify properties of an existing pipe spec.
Create a New Pipe Spec Or Modify an Existing One

1. In the Process Data Module window, click to open the Select Line dialog
box.
• To create a new pipe spec, click New and type entries in the Pipe Spec
and Description boxes.
• To edit an existing pipe spec, click a field in a highlighted row and
modify the existing entry as needed.
Related Topics
• Deleting Pipe Specs, page 1201
Delete Pipe Specs

Use this procedure to delete a pipe spec from the Pipe Specs supporting table.
Note
• You cannot delete a pipe spec that is currently assigned to lines. First
edit the lines to which the pipes spec that you want to delete is
assigned.
1. In the Process Data Module window, click to open the Select Line dialog
box.
5. Select the pipe spec that you want to delete, and click Delete.
6. Repeat the previous step for each pipe spec that you want to delete.

Process Data Module
Set the Default Units of Measure

This option enables you to set the desired default units of measure for the currently
active <unit>. The units of measure and accuracy will appear on the process data or
calculation sheets and the specification forms of the selected tags. Remember that
you have to set default units of measure and accuracy separately for each <unit> in
the <plant>.
1. In the main Process Data window, on the File menu, click Units of Measure and
Accuracy.
2. For each desired parameter, select from the appropriate lists:
a. The level of accuracy.
b. The unit of measure, if applicable.
3. Type the appropriate default values for Ambient Temperature, Base Temperature,
Barometric Pressure, and Base Pressure.
4. Click OK.
Related Topics
• Converting Engineering Units of Measure Automatically, page 1204
• Copying Default Units of Measure from Another <Unit>, page 1204
API 2540 Standard for Liquid Density Calculation

This feature enables you to calculate liquid density at operating and base conditions
in accordance with the API 2540 standard. You can select one of the five product
groups:
• Crude Oils and JP 4.

• Jet Fuels, Kerosenes, and Solvents.
• Gasolines and Naphthenes.
• Lubricating Oils.
• Diesel Oil, Heating Oils, and Fuel Oils.

Process Data Module
Calculate Liquid Density According to the API 2540

Standard
2. In the process data sheet, make sure that the Liquid fluid state is selected.
3. Select the API 2540 option from the Fluid name source list.
4. Select the desired product group from the Fluid name list.
5. In the API 2540 STANDARD section, select one of the following:
• Density at reference temperature.
• Specific gravity at reference temperature.
• API settings for: minimum / normal / maximum
6. Enter the desired values in the appropriate fields according to the selected option.
7. If you selected Density at reference temperature or Specific gravity at
reference temperature, do one of the following:
• Type the reference temperature value in the Reference temperature
field.
• Click Default to enter the default reference temperature.
8. Click Calculate Density to calculate the density.
Tip
• The calculated values for Density and Specific Gravity are entered in
the Properties @Minimum, @Normal, and @Maximum fields.

Process Data Module
Convert Engineering Units of Measure Automatically

Three steps convert one engineering unit to another: first, click on the designated
Units field drop-down list. Then, select the new unit of measure. Finish by choosing
the new unit of measure. After the calculations are over, the results are displayed in
the property record item fields.
Note
• When converting from one engineering unit to another, the data value
changes in accordance with the new engineering unit.
1. With a process data sheet open, on the Options menu, click Automatic Unit
Conversion.
2. Click in the Units field of the engineering units you want to convert and select the
new engineering unit of measure.
Tip
• If you convert to Volumetric Flow engineering units, a dialog box
opens where you specify the measuring condition.
3. Select a condition, and click OK to display the results.
Tip
• If you convert to engineering units other than Volumetric Flow, results
are directly displayed in the property record item fields.
4. When finished, click to save the changes.
Related Topics
• Setting the Default Units of Measure, page 1202
Copy Default Units of Measure from Another <Unit>

You can define the default units of measure and accuracy by copying the definitions
from another existing unit. You can then make any modification. This shortens the
process of setting new default units of measure.
1. In the Units of Measure and Accuracy dialog box, click Copy From.
2. In the Open dialog box, navigate to the source <unit> from which you want to
copy the default data.
3. Click OK to copy the default unit of measure settings.
Related Topics
• Setting the Default Units of Measure, page 1202

Process Data Module
Import Process Data Files

You can import process data sheets for lines or instruments in .ipd (SmartPlant
Instrumentation process data) format after editing in the Process Data Editor,
provided the line or instrument exists in the SmartPlant Instrumentation database.
The .ipd format allows you to include multiple tags in a single file.
Note
• Use this procedure to import back into SmartPlant Instrumentation
process data for a tag that already exists in your SmartPlant
Instrumentation database.
1. In the Process Data Module window, on the Actions menu, click External
Process Data.
2. Under Item type, select Instrument.
3. Under Action, select Import.
4. Click Open.
5. In the dialog box that opens, navigate to the folder from which you want to import
the file.
6. Select the desired file and click Open.
Tip
• The software only accepts .ipd files that contain instrument data.
7. Under Search results, select the Select check box beside the instruments that you
want to import.
Tip
• The software only displays instruments that already exist in your
SmartPlant Instrumentation database.
8. Click Apply or OK.

Process Data Module
Import Line Process Data Files

Process Data.
2. Under Item type, select Line.
3. Under Action, select Import.
4. Click Open.
5. In the dialog box that opens, navigate to the folder from which you want to import
the file.
6. Select the desired file and click Open.
Tip
• The software only accepts .ipd files that contain line data.
7. Under Search results, select the Select check box beside the lines that you want
to import.
Tip
• The software only displays lines that already exist in your SmartPlant
8. Click Apply or OK.
Related Topics
• Exporting Process Data Files, page 1207

Process Data Module
Exporting Process Data Files

You can export process data sheets for lines or instruments in .ipd (SmartPlant
Instrumentation process data) format for use with the Process Data Editor. In this
way, you can allow an external party (contractor, engineering company, and so forth)
to modify your process data outside of SmartPlant Instrumentation. The .ipd format
allows you to include multiple tags in a single file.
Export Instrument Process Data Files

Process Data.
2. Under Item type, select Instrument.
3. Under Action, select Export.
4. Click Find, and in the Find Tag dialog box, under Search parameters, from the
Process function list, select a process function other than General, and then click
Find.
5. Select one or more of the tag numbers displayed, or click Select all.
6. Click OK.
7. In the External Process Data dialog box, under Search results, select the Select
check box beside the instruments that you want to export, and click Apply or OK.
8. In the dialog box that opens, navigate to the folder to which you want to export,
type a filename, and click OK.
Export Line Process Data Files

Process Data.
2. Under Item type, select Line.
3. Under Action, select Export.
4. Click Find, and in the Select Line for Export dialog box, do one of the
following:
• From the Line Type list, select a line type.
• Select the Show all line types check box.
5. Select one or more of the lines displayed, or click Select all.
6. Click OK.
7. In the External Process Data dialog box, under Search results, select the Select
check box beside the lines that you want to export, and click Apply or OK.

Process Data Module
8. In the dialog box that opens, navigate to the folder to which you want to export,
type a filename, and click OK.
Related Topics
• Importing Process Data Files, page 1205

Process Data Module
Principles of Generating Process Data Reports

SmartPlant Instrumentation generates process data reports by utilizing eight pre-
defined report templates with which the data of a SmartPlant Instrumentation item is
associated (one for line, and seven for instruments). A SmartPlant Instrumentation
item may be an Instrument or a Line. This is done through the association of a
SmartPlant Instrumentation item, (and its process function - if it is an instrument) to
its pre-defined template.
Each report is made up of a number of sections depending on the process function.

For example: General, Quality of Fluid, Operating Data, Instrument Data, Properties
Flow, Alarm and Trip Settings (for example, pressure & temperature instruments), a
Notes field, and Internal and External Revision fields.
Related Topics
• Generating a Process Data Report for One Instrument or Line, page
1209
• Generating Instrument Reports, page 1211
• Generating Line Reports, page 1210
Generating a Process Data Report for One

Instrument or Line
You can generate a process data report from an open process data sheet for the
current instrument or line only.
Note
• If you are generating a report for a multi-case instrument tag, this
option prints the current case.

Process Data Module
Generate a Process Data Report for the Current Instrument

Or Line
• Open a process data sheet for an instrument.
2. On the Actions menu, click Report.
3. If you open a print preview, do any of the following:
• Click to select a pre-set magnification, or enter a customized one to

fit your needs.
• Click to print the report, or to print all available reports.
Selecting the Printer Setup option from the File menu will allow you
to select the default printer.
• Click to save the report as an external file.
• Click to create or edit local revisions and drawing numbers.
Related Topics
• Generating Instrument Reports, page 1211
• Principles of Generating Process Data Reports, page 1209
Generate Line Reports

This option allows you to generate process data reports for more than one line and
case.
1. In the Process Data Module window, on the Reports menu, point to Line, and
• To print one process line per page, click Single Line.
• To print three process lines per page, click Three Lines.
Tip
• For lines that are multi-case, this option prints the governing case.
2. In the Select Line for Report dialog box, do one of the following:
• From the Line Type list, select a line type.
• Select the Show all line types check box.
3. Select the lines you want to include in the report.

Process Data Module
4. Click OK.
Related Topics
1209
Generate Instrument Reports

This option allows you to generate process data reports for more than one instrument
and case.
1. Start the Process Data module.
2. In the Process Data Module window, on the Reports menu, point to
Instrument, and do one of the following:
• To print one tag per page, click Single Tag.
• To print three tags per page, click Three Tag.
Tip
• For tags that are multi-case, this option prints the governing case.
3. In the Find Tag dialog box search for the tag number according to the criteria you
specify, or click Find for a list that you can choose from.
4. Select the tags to include in the report.
Tip
• For multi-case tags, select each case that you want to include in the
report.
5. Click OK.
Related Topics
1209

Process Data Module
Viewing and Editing Process Data Revisions

You use revisions to keep track of the changes made to your process data. It is
important and useful to have a chronological description of the changes, dates of
change, and a list of persons who approved them. You can add, edit, and delete
revisions. The Process Data module shares the following two types of revisions with
the rest of SmartPlant Instrumentation: local revisions and global revisions. There is
an additional type of revision available only in the Process Data module, which is an
external revision.
Related Topics
Work With External Process Data Revisions

Use this procedure to add, edit, or delete external revisions in the Process Data
module.
• Click .
• On the Actions menu, click External Revisions.
serial revisions).
Tip
3. Click New to add a new revision or click in a data field to update existing revision
data in that field.
Tip
• The By data field contains the current user's initials by default, if
Administrator. You can also edit this field if desired.
5. To delete revisions, do the following:
a. Select the revision you want to delete.
b. Click Delete.

Process Data Module
Tip
• As a time saver and a forget-me-not precaution, take advantage of
using a default Revision method. The software automatically adds a
new line with the next logical character and date each time you click
New after you select the initial method.
6. When done, click OK.
Related Topics
• Viewing and Editing Process Data Revisions, page 1212
View Process Data History

SmartPlant Instrumentation can indicate process data changes by comparing current
data with the data stored in the audit trail repository for the date range that you
specify. You can choose any or all of the following modes of emphasis:
• You can set a color to emphasize changes on the screen.

• You can set a shade of gray to emphasize the changed data in printed
reports and their previews.
• You can set bold and italic font style for emphasis on the screen and in
print.
Note
• History indication is available only if the System Administrator has
activated the audit trail functionality. When the audit trail
functionality is activated, each time that you save data after making
changes, the data is recorded in the audit trail repository.
1. In the Process Data module, open the desired tag.
2. On the Options menu, click History Options.
3. Select the date range for data history comparison, by doing one of the following:
• In the From and To data fields, type the appropriate dates.
• Select the appropriate dates using the spinner.
Tip
• To set the To data field value as today's date, click Today.
4. To set a font style to emphasize changes on the screen and in print, do one or both
of the following:
• Select Bold.
• Select Italic.

Process Data Module
5. To change the color used to display changes on the screen:

b. In the Color dialog box, choose the color that you require.
dialog box.
and their previews:
b. In the Grayscale dialog box, slide the bar to the desired position.
c. Click OK to save your new grayscale setting and return to the History
Options dialog box.
dialog box.
8. On the Options menu, click Mark Changes to mark changes in the current
process data sheet for the dates that you specified in the History Options dialog
box. Clear the check box to clear all history indications in the current process
data sheet.
Note
• To refresh the history indication in an open process data sheet, on the
Options menu, clear Mark Changes and then select the option again.

Calculation Module
Calculation Module
Overview
This module provides the capabilities to quickly perform calculations for Cv, noise,
orifice diameter, required discharge area, and other parameters for Control Valves,
Flowmeters, Relief Valves, and Thermowells.
The Calculation module employs the major international standards (ISA, ANSI, API,
ISO, and IEC 60534-2-1 (1998)), to perform complex control valve, flow element,
relief valve, and thermowell calculations quickly and effortlessly.
Calculation data originates mainly from the Process Data module, but also from the
Instrument Index module. You then open the relevant dialog box for the specified
instrument type, (control valve, flowmeter, relief valve, or thermowell), enter all the
parameters required for calculation, and initiate the calculation. After performing the
calculation, the relevant data may then be incorporated into generated reports and
specifications.
Notes
• The software does not support calculations for materials for which the
state is solid/powder, nor for 2-phase flow.
• If you need to add or modify process data, you can do this in the
Calculation module (for details, see Editing Instrument Process Data,
page 1175).
Related Topics
Start the Calculation Module

Before starting this module, check with the Domain Administrator to ensure that you
have been granted appropriate access rights for the tasks you will carry out.
• In any SmartPlant Instrumentation window, do one of the following:

• On the SmartPlant Instrumentation toolbar, click .
• Click Module > Calculation.

Calculation Module
Viewing and Editing a Calculation Item

Use this procedure to open individual control valve, flowmeter, relief valve, and
thermowell process data sheets for calculation.
Note
• You can also select a batch of instruments of a given process function
for calculation (for details, see Multiple Process Data Cases, page
1190).
Open a Process Data Sheet for Calculation

1. In the Calculation Module window, click Edit > Calculation, and then click one
of the following:
• Flowmeter
• Thermowell
• Control Valve
• Relief Valve
• Type the tag number that you want to calculate.
• Click Find to open the Find Tag dialog box, where you search for the
tag that you want to calculate.
3. Click OK to display the calculation Process Data window for the instrument that
you selected.
4. If you defined multiple process cases, from the Case list, select the case that you
want to calculate.
Related Topics
• Performing Calculations, page 1219

Calculation Module
Fluid Definition
When opening a tag in a process data sheet, you are required to define the fluid for
which a calculation will be carried out. You define the fluid by selecting the fluid
state, entering the fluid name or selecting it from one of the two property databases,
and setting the fluid phase.
Notes
• If this is a new tag that you just created in the Calculation module, the
PROPERTIES section of the window will be blank until you select
the required Fluid State.
• The software does not support calculations for materials for which the
state is solid/powder, nor for 2-phase flow.
Define the Fluid

want to calculate.
3. In the GENERAL section of the process data sheet, from the Fluid state list, do
• Accept the fluid state that you set when you first opened the tag in the
Process Data or Calculation module.
• Select a different fluid state.
4. From the Fluid name source list, select one of the following options, which the
software uses to calculate the item properties:
• Database – activates the Fluid Properties database after selecting the
required fluid from the Name list (for details, see Calculating Physical
Properties, page 1182).
• API2540 – calculates liquid density at operating and base conditions
in accordance with the API2540 standard. To learn how to use the
API 2540 Standard Properties database, see API 2540 Standard for
Liquid Density Calculation, page 1202).
• User-defined– define the fluid properties according to your own
standards.
Tip
• If you selected Solid/Powder as the material state, the Select from list
does not appear.

Calculation Module
5. In the Fluid name box, enter the fluid name.

6. From the Fluid phase list, select the required fluid phase.
Related Topics

Calculation Module
Performing Calculations
The calculation dialog boxes comprise the essence of the Calculation module. The
values that you enter in these dialog boxes together with the data in the process data
sheets serve as the basis of the calculations displayed on the screen. Calculation item
reports provide information that is more comprehensive.
Tip
• When you open a Calculation Item window and some of the process
data values are not filled in, you can click Highlight Process Data on
the Options menu to highlight all the fields that you must fill in to
carry out the calculation.
Related Topics
• Calculating a Control Valve, page 1230
• Calculating a Relief Valve, page 1227
• Calculating a Thermowell, page 1233
• Preparing for Flowmeter Calculation, page 1219
Preparing for Flowmeter Calculation

Use this procedure to enter the values common to all three types of flowmeter
calculation:
• Orifice flowmeter calculation

• Tube flowmeter calculation
• Restriction device calculation
When you reach the last step of the current procedure, click the link to the procedure
that you require to complete the calculation.
Notes
• By default, SmartPlant Instrumentation updates tag values from the
current unit of measure to their value in a new unit of measure that you
set. If on the Options menu you clear Automatic Unit Conversion,
the software changes the unit of measure without recalculating the
values. Therefore, to protect the integrity of your values, on the
Options menu, click Automatic Unit Conversion.
• To highlight the fields that are required for a calculation, on the
Options menu, click Highlight Process Data.

Calculation Module
Prepare for Flowmeter Calculation

1. Open a calculation data sheet for the flowmeter tag that you want to calculate.
want to calculate.
• Make sure that you enter process data in all of the fields that are
required for calculation, in the following sections of the data sheet

• Click Actions > Calculate.
5. In the Flowmeter Calculation dialog box, continue with one of the following
procedures:
Related Topics
• Editing Instrument Process Data, page 1175
• Orifice Flowmeter Calculation, page 1221
• Restriction Device Calculation, page 1225
• Tube Flowmeter Calculation, page 1223

Calculation Module
Orifice Flowmeter Calculation

This option enables you to calculate orifice flowmeter parameters based on the fluid
state values of the flowmeter and values retrieved from the Process Data module. In a
calculation data sheet for a flowmeter item, you can accept or modify these values, or
enter additional values. Then, in the Flowmeter Calculation dialog box, you
calculate orifice flowmeter parameters for a selected orifice flowmeter and view the
calculation results.
Calculate Orifice Flowmeter Parameters

1. Open the Flowmeter Calculation dialog box for the orifice flowmeter that you
want to calculate.
2. From the Flowmeter type list, select the required orifice flowmeter.
Tip
• The Quarter of Circle Orifice (also known as Quadrant Edge
Orifice) sizing is in accordance with the new edition of British
Standard (BS 1042: Section 1.2; 1989).
3. From the Sub type list, select the required sub type for the current orifice
flowmeter.
4. Type the required values in the fields next to the other two calculation options that
you haven't selected. SmartPlant Instrumentation will then use these values to
calculate the tube flowmeter parameters for the selected option.
5. Under Pipe, view the data in the Material field and the Linear expansion
coefficient field.
Tips
• The data in the Pipe material field is retrieved from the Process Data
module.
• The linear expansion coefficient value for the displayed pipe is the
standard value taken from SmartPlant Instrumentation database.
• From the Linear expansion coefficient list of units of measure, you
can select a required unit of measure for the current linear expansion
coefficient.
6. Under Orifice, from the Orifice material list, select the orifice material.
Tips
• The Orifice material list contains standard options provided with
SmartPlant Instrumentation. If the required orifice material is not in
the list, select from the list the MATERIAL NOT LISTED option

Calculation Module
and in the Linear expansion coefficient field type the required linear
expansion coefficient.
• If you select a standard option from the Orifice material list, you
cannot change the linear expansion coefficient value for the displayed
orifice material because this is the standard value taken from
SmartPlant Instrumentation database.
7. In the Diameter of bleed/vent hole field, type the required diameter of the
bleed/vent hole or accept the given value.
Tips
• When calculating the orifice flowmeter parameters for the Steam fluid
state, in the Water in steam, %wt field, type the percentage of water
in steam.
• If the value in the Full scale flow field has been changed, you can
click to get the values from the Process Data module.
8. Under Select calculate field, select one of the following options to calculate the
orifice flowmeter parameters:
• Orifice diameter
• Full scale flow
• Differential range
9. Click Calculate.
10. Examine the calculation results and possible calibration error messages.
Tips
• The units of pressure loss derive from the default units for Differential
Range (Flow) set in the Units of Measure and Accuracy dialog box.
• When sizing flowmeters for Liquids and Water, SmartPlant
Instrumentation checks whether Downstream pressure is greater than
Vapor pressure. If it is, the program continues sizing. If it is not,
critical flow takes place, and the program advises you to check the
input data.
11. To recalculate the orifice flowmeter parameters, enter the new data and click the
Calculate command button.
12. Click Close to return to the calculation data sheet.
Related Topics
• Principles of Generating Calculation Item Reports, page 1238

Calculation Module
Tube Flowmeter Calculation

This option enables you to calculate tube flowmeter parameters based on the fluid
state values of the flowmeter and the values retrieved from the Process Data module.
In a calculation data sheet for a flowmeter item, you can accept or modify these
values, or enter additional values. Then, in the Flowmeter Calculation dialog box,
you calculate the tube flowmeter parameters for a selected tube flowmeter, view and
print out the calculation results.
Calculate Tube Flowmeter Parameters

1. Open the Flowmeter Calculation dialog box for the tube flowmeter that you
want to calculate.
2. From the Flowmeter type list, select the tube flowmeter type.
3. From the Sub type list, select the tube flowmeter sub-type, if available.
4. Type the required values in the fields next to the other two calculation options that
you haven't selected. SmartPlant Instrumentation will then use these values to
calculate the tube flowmeter parameters for the selected option.
5. In the Tube group box, view the data in the Material field and the corresponding
linear expansion coefficient value in the Linear expansion coefficient field.
Tips
• The data in the Material field is retrieved from the Process Data
module.
standard value taken from the SmartPlant Instrumentation database.
coefficient.
6. In the Throat group box, select the required throat material.
Tips
• The Material list contains standard options provided with SmartPlant
Instrumentation. If the required throat material is not in the list, select
from the list the MATERIAL NOT LISTED option and in the
Linear expansion coefficient field type the required linear expansion
coefficient.
• If you select a standard option from the Material list, you cannot
change the linear expansion coefficient value for the displayed throat
material because this is the standard value taken from the SmartPlant

Calculation Module
• When calculating the tube flowmeter parameters for the steam fluid
in steam.
click to retrieve the values from the Process Data module.
tube flowmeter parameters:
• Throat diameter
• Full scale flow
• Differential range
8. Click OK to carry out and display the calculation results.
Tips
• The values of pressure loss in the results comes from the default values
for differential range flow set in the Units of Measure and Accuracy
dialog box.
• When sizing flowmeters for Liquids and Water, the software checks
whether Downstream pressure is greater than Vapor pressure. If it
is, the program continues sizing. If it is not, critical flow takes place,
and the program advises you to check the input data.
10. To recalculate the tube flowmeter parameters, enter the new data and then click
Calculate.
11. Click Close to return to the calculation data sheet, where you can click to
generate a report for the current calculation result. Error messages also appear in
a calculation report.
Related Topics

Calculation Module
Restriction Device Calculation

This option enables you to calculate the restriction device parameters based on the
fluid state values of a flowmeter and values retrieved from the Process Data module.
In a calculation data sheet for a flowmeter item, you can accept or modify these
values, or enter additional values. Then, in the Flowmeter Calculation dialog box,
you calculate the restriction device parameters and view the calculation results.
Calculate the Restriction Device Parameters

1. Open the Flowmeter Calculation dialog box for the restriction device that you
want to calculate.
2. From the Flowmeter type list, select Restriction Device.
3. From the Sub type list, select the restriction device sub type.
4. Type the appropriate values in the fields next to the other two calculation options
that you haven't selected. SmartPlant Instrumentation will then use these values
to calculate the tube flowmeter parameters for the selected option.
5. In the Pipe group box, view the data in the Material field and the corresponding
linear expansion coefficient value in the Linear expansion coefficient field.
Tips
• The data in the Pipe material field is retrieved from the Process Data
module.
standard value taken from the SmartPlant Instrumentation database.
coefficient.
6. In the Orifice group box, from the Material list, select the orifice material of the
restriction device.
Tips
• The Orifice material list contains standard options provided with
SmartPlant Instrumentation. If the required orifice material is not in
the list, select from the list the MATERIAL NOT LISTED option
and in the Linear expansion coefficient field type the required linear
expansion coefficient.
• If you select a standard option from the Material list, you cannot
change the linear expansion coefficient value for the displayed orifice
material because this is the standard value taken from the SmartPlant

Calculation Module
7. In the Diameter of the bleed/vent hole field, accept the displayed value, or type
the diameter of the bleed/vent hole.
8. If needed, clear the Calculate discharge coefficient check box to enable you to
type the discharge coefficient.
Tips
• If you leave the Calculate discharge coefficient check box selected,
the software automatically calculates the discharge coefficient
according to the preset values.
• When calculating the restriction device parameters for the Steam fluid
in steam.
click to get the values from the Process Data module.
restriction device parameters:
• Orifice diameter
• Full scale flow
• Pressure loss
Caution
• Do not type any values in the field next to the selected calculation
option.
10. Click OK to carry out and display the calculation results.
Tips
• The values of pressure loss in the results comes from the default values
for differential range flow set in the Units of Measure and Accuracy
dialog box.
• When sizing flowmeters for Liquids and Water, SmartPlant
Instrumentation checks whether Downstream pressure is greater than
Vapor pressure. If it is, the program continues sizing. If it is not,
critical flow takes place, and the program advises you to check the
input data.
12. To recalculate the restriction device parameters, enter the new data and then click
Calculate.
13. Click Close to return to the calculation data sheet, where you can click to
generate a report for the current calculation result. Error messages also appear in
a calculation report.

Calculation Module
Calculating a Relief Valve

Use this procedure to calculate the sizing of a relief valve. This option works for
single phase fluids only and for all fluid states, with the exception of Solid/Powder.
Notes
values! Therefore, to protect the integrity of your values, on the
Calculate a Relief Valve

1. Open a calculation window for a relief valve item.
want to calculate.
3. Make sure that you enter process data in all of the fields that are required for
calculation
Tip
• Although from the Pressure/Vacuum list, you can select Vacuum
only or Pressure and vacuum, SmartPlant Instrumentation calculates
pressure relief valves only, and not vacuum relief valves or dual mode
pressure/vacuum relief valves. The vacuum service set point value
that you enter beside Valve Set Vacuum is displayed in the process
data report for this instrument, but not in the calculation report.
4. Click .
5. Click to display the Relief Valve Calculation dialog box.
Tip
• The default selection for Use Rupture Disk at the inlet? is No.
Selecting Yes enables the Combination Capacity factor (Kc) field
below.

Calculation Module
6. Select user-defined conditions for the relief valve:

• ASME Capacity Certification requirement.
• Sizing basis.
• Rupture Disk at the inlet use.
7. If you are using the Bellows valve style in liquid or water applications, you can
also let SmartPlant Instrumentation calculate the correction factor for back
pressure (Kw) by checking the Calculate check box.
8. Type the required value for Effective coefficient of discharge (Kd) or click
Default to use the SmartPlant Instrumentation default value.
9. If available, type the required value for Combination capacity factor (Kc) or
click Default to use the SmartPlant Instrumentation default value.
10. Click the Calculate command button.
Related Topics
• Calculating a Relief Valve in Case of Fire, page 1229
• Entering Built-Up Back Pressure - Relief Valve, page 1243

Calculation Module
Calculating a Relief Valve in Case of Fire

Use this procedure to calculate the sizing of a relief valve in case of fire.
Notes
Size a Relief Valve in Case of Fire

1. With a calculation data sheet open for a relief valve item, scroll to the SIZING
DATA section.
2. From the Case (fire/non-fire) list, select Fire.
3. Enter all the required values, especially the Area and Properties @relieving
condition values. Some properties vary for the Liquid and Gas fluid states.
• Complete the Relief Valve Calculation dialog box, and click the
Calculate command button to get the calculation results.
Tip
• The Sizing basis and other calculation results (the Calculated area,
Selected area, and Orifice designation) appear on specifications based
on SmartPlant Instrumentation library form # 7.
Related Topics
• Calculating a Relief Valve, page 1227

Calculation Module
Calculating a Control Valve

This procedure enables you to enter various values for calculating a control valve.
First, you define a CV calculation method and a flow coefficient standard (US or
Europe) of CV sizing, then you select a noise calculation method and a CV body
type. Next, you enter values, perform the calculation, and view the results.
Notes
Calculate a Control Valve

1. Open a control valve calculation item.
want to calculate.
calculation.
4. Click to save the values.

6. In the Control Valve Calculation dialog box, from the Calculation method list,
select the required calculation method – ISA or IEC.
Tip
• The IEC standard is 60534-2-1 (1998)
7. From the Flow coefficient list, select the required flow coefficient standard of CV
sizing – Cv or Kv.
Tip
• Kv is a European standard flow coefficient available for an IEC CV
calculation method. Kv=Cv*0.865

Calculation Module
8. Based on the value that you selected from the Fluid state list on the process data
sheet, do one of the following:
• If you set Liquid or Water, select Masoneilan or IEC from the Noise
calculation method list.
• If you set Gas/Vapor or Steam, select ISA or IEC from the Noise
calculation method list.
9. Enter hydrodynamic noise data as necessary.
Tip
• This option is available only If under State you selected Liquid or
Water, and under Noise Calculation Method you selected IEC.
10. From the Body type list, select the required body type.
11. Enter the required critical flow factor values (Fl, Cf) at minimum, normal, and
maximum control valve coefficients.
12. To define the required pressure drop ratio factor values (Xt) at minimum, normal,
and maximum control valve coefficients, do one of the following:
• To calculate the values automatically, as a function of critical flow,
select Calculate pressure drop ratio factor.
• Type the required values in the @Minimum, @Normal, and
@Maximum fields.
13. Type the Valve style modifier (Fd) value.
14. To set the Relative capacity value, do one of the following:
• Accept the value that SmartPlant Instrumentation calculates based on
the calculation method and on the standard that you selected from the
Flow coefficient list.
• Type the value that you require.
15. Type the required Number of flow passages.
16. Enter the appropriate Valve size and select its unit of measure.
17. To set the outlet pipe diameter, do one of the following:
• Under Outlet pipe diameter, type the value required.
• Click Default to apply the inlet pipe diameter.
18. Click Calculate to carry out and display the calculation results.
19. Examine the figures for results that may have to be re-calculated.
20. To recalculate the orifice flowmeter parameters, enter the new data and click the
Calculate command button.

Calculation Module
Tip
• You can calculate a control valve and the relevant parameters even if
the pipe wall thickness is not defined. In this case, Noise is not
calculated and a line of text in Notes section of the calculation sheet
informs you that Noise will not be calculated because Pipe wall
thickness is not defined.
Related Topics
• Recommended Control Valve Characteristic, page 1242

Calculation Module
Calculating a Thermowell
A Thermowell, inserted into a pipe, enables you to calculate tag temperature. This
procedure shows you how SmartPlant Instrumentation calculates the maximum
permissible length of a Thermowell. The calculation is based on the maximum
frequency that the Thermowell can withstand. The calculation complies with ASME
PTC 19.3 Standard.
Notes
Calculate the Maximum Permissible Thermowell Length

1. Open a thermowell calculation item.
want to calculate.
calculation.
4. Click to save the values.
5. Click to open the Thermowell Calculation window.
6. Select the appropriate velocity: minimum, normal, or maximum.
7. Select the required values from the Nominal size of sensing element list.
8. Enter additional values as need, and click Calculate.
9. When done, click Cancel to return to the main calculation window for a
Temperature Item.
Related Topics

Calculation Module
Performing a Batch Calculation

This option enables you to perform a calculation for a group of tags, all belonging to
one of the following types: Control Valve, Flowmeter, Relief Valve, or Thermowell.
Notes
• You must define process data before calculation.
• After calculating tags, you can change parameters and then use this
procedure to recalculate.
Perform a Batch Calculation

1. On the Edit menu, point to Batch Calculation, and click the required instrument
type. SmartPlant Instrumentation opens the Batch Calculation window for
instruments of that type.
2. On the Actions menu, click Find Tag.
3. In the Find Tag dialog box, under Search parameters, do one of the following:
• Type and select filter parameters.
• To display all tags, leave the boxes blank.
4. Click Find.
Tips
• For tags for which you defined multiple cases, each case is displayed
in a separate row, which allows you to select one or more cases of a
given tag for calculation.
• To utilize the entire dialog box to display the results, click Show more
search results.
5. Select the tags that you want to calculate, and click OK.
6. In the Batch Calculation window, for each tag for which you want to display or
edit calculation parameters, select the tag and do the following:
a. Click Actions > Type Data.
b. Type and select data you want to change for the calculation, and click OK to
return to the Batch Calculation window.
7. Select the tags that you want to calculate, and do one of the following:
8. For information on items with status Failed, on the Reports menu, click Batch
Calculation Messages.

Calculation Module
9. To display process data for a given tag, in the Batch Calculation window, select
a tag, and on the Reports menu, click Process Data Report.
Related Topics
• Generating Calculation Item Reports, page 1238

Calculation Module
Calculating Multiple Cases

A given instrument or line is often used for more than one operating service. For
example, a dual-fuel control system might use a single supply line and control valve
to carry various fuels, gas or liquid. Each group of process data settings that you
enter for a given instrument or line is called a case (for more information, see
Multiple Process Data Cases, page 1190).
Use this procedure to calculate multiple cases of a given tag.
Calculate Multiple Cases

1. In the Calculation module, create multiple cases for the tag that you want to
calculate (for details, see Multiple Process Data Cases, page 1190).
Tip
• You can create multiple cases in the Process Data module, and later
open the tag in the Calculation module
• .
2. For each case that you want to calculate, do the following:
a. In the GENERAL section of the calculation data sheet, from the Case list,
select the required case.
b. Calculate the case.
c. To generate a calculation report for the current case, on the Actions menu,
click Reports.
Related Topics
• Creating a Hybrid Case, page 1237

Calculation Module
Creating a Hybrid Case

For a control valve for which you defined multiple cases, you can create a hybrid case
from the minimum, normal, and maximum flow coefficient values (Cv/Kv) that you
calculated for the various cases. Use this procedure to create such a hybrid case.
Create A Hybrid Case

1. In the Process Data module or in the Calculation module, create multiple cases for
the control valve for which you want to create a hybrid case (for details, see
Creating Process Data Cases, page 1191).
2. Do one of the following to calculate every one of the cases:
• In a Control Valve Calculation window for the given tag, calculate
every one of the cases individually.
• Perform a batch calculation procedure to select and calculate all of the
cases of the given control valve tag.
3. In the main window of the Calculation module, click Edit > Hybrid Case.
4. On the Select Tag dialog box, click Find, and then select the tag for which you
want to create a hybrid case.
5. On the Hybrid Case dialog box, do the following to set values for the hybrid
case:
a. In the Case selection data window, select the value that you want to copy for
the hybrid flow coefficient at minimum, and then click Add Minimum.
b. In the Case selection data window, select the value that you want to copy for
the hybrid normal flow coefficient, and then click Add Normal.
c. In the Case selection data window, select the value that you want to copy for
the hybrid flow coefficient at maximum and then click Add Maximum.
Tips
• Flow coefficients are displayed dynamically as Cv or Kv, depending
on the method of calculation that you set for a given control valve in
the Control Valve Calculation dialog box.
• The software offers you the flexibility to select any value of a case for
any level of the hybrid case — minimum, normal, or maximum.
Related Topics
• Calculating Multiple Cases, page 1236

Calculation Module
Principles of Generating Calculation Item Reports

SmartPlant Instrumentation generates Calculation item reports by utilizing two
predefined report templates: Liquid and Gas, with which the data of an instrument is
associated. An instrument may be a Control Valve, Flowmeter, Relief Valve, or
Thermowell. This is done through the association of an instrument, and its process
function to its predefined template defined in the Process Data module.
Each report is made up of a number of sections depending on the process function.

For example: the heading, information gathered from the Process Data module, data
entered via the Body Type dialog box of the Calculation module, the Results and
Coefficients section, and an area provided for Notes and Revisions.
Caution
• When generating a report, only those items that include the saved
calculation results appear on the list in the Find Tag dialog box.
Generating Calculation Item Reports

Use this procedure to do the following:
• Generate calculation reports for instrument tags.

• Add, edit, and delete calculation report revisions.
• Assign, edit, and delete external drawing numbers assigned to the
calculation reports.
Generate a Calculation Item Report

1. In the Calculation Module window, on the Reports menu, click the report that
you require.
Tip
• You can also generate a calculation item report when a calculation
item window is open. On the module toolbar click , or on the
Actions menu, click Report.
Tip
2. In the Find Tag dialog box, under Search parameters, do one of the following:
• Type and select filter parameters.
• Leave the boxes blank to display all tags.
3. Click Find.

Calculation Module
4. Select the tags for which you want to generate a report, and click OK.
5. At the prompt, click Yes to display the calculation item report print preview. You
can do any of the following:
• Adjust the zoom level.
• Save this report as an external file.
• Perform, edit, or delete a revision on the calculation report.
• Assign, edit or delete an external drawing number for the calculation
report.
Related Topics
• Calculation Revisions, page 1240

Calculation Module
Calculation Revisions
The revision feature is used to keep track of the changes made to SmartPlant
Instrumentation reports and items, including calculations. It is important and useful
to have a chronological description of the changes, dates of change, and a list of
persons who approved them. Use this procedure to add, edit, and delete revisions.
Maintain Calculation Revisions

1. Generate a report preview for the calculation (for details, see Generating
Calculation Item Reports, page 1238).
2. In the Print Preview: Calculation Report window, on the print preview toolbar,
click .
P0, P1, P2... for preliminary revisions or 0, 1, 2 /A, B, C etc. for normal serial
revisions).
Tips
• If you select any revision method besides Other, SmartPlant
Instrumentation successively numbers each new revision.
4. Click New to add a new revision data or click Edit to update an existing revision
data line.
Tip
• The By data field contains the current user's initials by default, if the
System Administrator has defined it as such.
6. Under Drawing number, accept the default drawing number, or edit as required.
7. To delete revisions do the following:
a. Select the revision you want to delete.
b. Click Delete.
8. Click OK.

Calculation Module
Note
• You can also maintain revisions in batch mode using global revisions
(for more information, see Global Revisions: An Overview, page 76.
Related Topics
• Generating Calculation Item Reports, page 1238
Create a New Tag in the Calculation Module

You can create new tag numbers directly in the Calculation module, without having
to open the Instrument Index module.
1. In the Calculation Module window, on the Edit menu, point to Calculate, and
then click one of the following:
• Flowmeter
• Thermowell
• Control Valve
• Relief Valve
2. On the Enter Tag Number dialog box, type the name of the new tag number, and
click OK.
and click OK.
• Accept the displayed loop number and click OK.
• Type the loop number that you need and click OK.
• To create the tag number without a loop association, click Cancel.
5. On the Tag Number Properties dialog box, on the General tab, enter the
appropriate values.
6. Enter power supply values. For details, see Entering Power Supply Data for
Panels and Instrument Tags.
7. If the Process Data dialog box opens, select a fluid state and then click OK.
• In the process data sheet, enter and save the relevant process data
values.
Related Topics
• Opening an Instrument Tag in the Process Data Module, page 1172

Calculation Module
Recommended Control Valve Characteristic

This feature allows you to calculate the recommended control valve characteristic.
You can determine whether Linear or Equal Percentage valve is more suitable for a
specific valve application.
Note
• Make sure that you enter the required pressure drop, pump drop, and
system loss values in the process data sheet before performing this
procedure.
Calculate the Recommended Control Valve Characteristic

1. Open the required calculation item sheet for a control valve calculation.
2. On the Actions menu, click the Recommended Valve Characteristic option.
3. Enter the required Critical value or click Default to utilize the default value.
4. Click Calculate.
Tip
• SmartPlant Instrumentation calculates the recommended valve
characteristic and displays the result (Linear or Equal %) both in this
dialog box and the Notes window.

Calculation Module
Entering Built-Up Back Pressure - Relief Valve

The option enables you to enter a built-up back pressure value, which is taken into
account for calculation when sizing the relief valves. The result is displayed in the
NOTES section of the calculation data sheet, under General Notes.
Take Built-Up Back Pressure Into the Calculation Account

1. With a calculation data sheet open for a relief valve item, on the Actions menu,
click Enter Built-up Back Pressure.
2. In the Built-up Back Pressure dialog box, type the required value, select the unit
of measure and click OK.
Select a New Process Data Status

There are five statuses that relate to Workflow. For information on all five statuses,
see Process Data Statuses, page 100. The Select a New Process Data Status dialog
box becomes available for tags for which the instrument engineer, in the Workflow
Instrumentation / Process Data Browser, has set a status of Process Data Required.
To access this dialog box, a member of the process engineering group needs to open a
process data sheet for an instrument or line, modify some of the values, and click .
Status list — Accept the default Do not change status, or change the status to one
of the following:

Lock out from Tags marked for editing by the Set and changed by
Instrument process engineering group and process engineer
not available to the instrument
group.
Release to Instrument Tags available to the instrument Set by process
engineering group following engineer. Can be
release from the process group. changed by instrument
engineer.

Calculation Module
Custom Fields
You use this section of a process data or calculation sheet for custom fields ,as
defined by the Domain Administrator. Note that the Domain Administrator can also
enable custom fields in the other sections of process data sheets for a given <plant>.

Dimensional Data for Piping Module

The Dimensional Data for Piping (DDP) module enables you to store and manage
three levels of dimensional data: default, working, and vendor. This structure
represents the natural flow of information and activities related to dimensional data
processing.
You can store and maintain default instrument dimensional data by classifying it per
group, manufacturer, or process connection.
The DDP module also enables you to store and maintain dimensional data received
from a vendor. This data can also be classified per group, manufacturer, or process
connection.
Most significantly, the DDP module provides the means to transfer, store, and
maintain certified vendor dimensional data for your instruments. This certified
vendor data will then be transferred to your Working data which you use for the
actual instruments in your database.
You can use the DDP module to transfer external dimensional data to your
SmartPlant Instrumentation database and export of dimensional data from your
database to an external 3-D piping design application.
In addition, the DDP module enables you to generate and print out various
dimensional data reports that facilitate your dimensional data management. These
reports can help you keep track of suspected data, data status, default dimensional
data, and vendor dimensional data, and so forth.
Note
• The Dimensional Data for Piping module is available only if it is
included in the software license that you purchased from Intergraph.

Principles of the DDP Module

This section provides general guidelines and a recommended flow of activities for the
DDP module.
At the initial stage, you should select the appropriate instrument types and define their
instrument profiles so that dimensional data handling is clearly specified. Based on
the existing dimensional library and practices of dimensional data processing, you
also classify the instruments by their type and pre-assigned DDP group by defining
this group in the instrument type profile.
Next, define basic instrument parameters in the Instrument Index module or

Specifications module, including the instrument manufacturer, model, and process
connections.
Group definition coupled with basic information enables the dimensional data
designer to provide piping designers with preliminary dimensions filled from the
standard dimensional data library based on specified basic instrument parameters.
When requests for quotations are issued and vendor bids are evaluated, more detailed
dimensional information supplied by vendors and manufacturers in electronic or hard
copy form can be automatically imported or manually entered as vendor data.
This vendor data lets the designer re-evaluate dimensional data, if desired, and issue
vendor-certified dimensional data to the piping.
Starting from the moment when the preliminary dimensional data was selected for the
instruments, you are able to release this information to the piping design. This can be
done in two forms — electronically or by providing a hard copy. Electronic form is
an automatic transfer and processing of the structured data to a 3-D CAD system.
Alternatively, dimensional data report or dimensional data sheet can be printed out
and transferred to the piping design department in paper form.
The status of the dimensional data design can be tracked through the instrument
status. You can also view the history information for the selected instrument
modifications.
Controlling the modifications of critical definitions, such as a DDP group, instrument

type, model, and process connections provides the means to manage and keep track of
suspected data during the whole life cycle of the dimensional data design.

Start the DDP Module

The DDP module is available only if it is included in the software license that you
purchased from Intergraph.

• Click Modules > Dimensional Data.
Preliminary Procedures
There are two preliminary procedures that you have to carry out before you start
entering dimensional data. These procedures are:
• Defining the setting for the Dimensional Data for Piping module. To
carry out this procedure, you must log on to the Administration
module as System Administrator and enter the desired data on the
Dimensional Data Settings Dialog Box.
• Associating an Instrument Type with a DDP Group, page 1252
Define the Process Connection Class / Rating

This procedure enables you to define the desired process connection class / rating.
This represents the value of the maximum in-line pressure that the process connection
can withstand.
1. In the Dimensional Data for Piping Module window, on the Tables menu, click
Process Connection Classes.
2. To create a new process connection class, click New.
3. Type the appropriate process connection class name and description.
Tip
• You cannot delete a process connection class if it is associated with
default, working, or vendor data.
Related Topics
• Defining the Connection End Preparation, page Error! Bookmark
not defined.
• Principles of the DDP Module, page 1246

Define a Process Connection End Preparation

Process Connection End Prep.
2. To create a new process connection end preparation, click New.
3. Type the appropriate process connection end preparation name, design code, and
description.
Related Topics
• Defining the Process Connection Class, page Error! Bookmark not
defined.
Additional Settings
You also have to make some additional settings for the dimensional data. These
settings include the following:
• Equipment and equipment type

• Instrument manufacturer
• Instrument model
You access the appropriate dialog boxes from the Dimensional Data for Piping
Module window and by selecting the desired command on the Tables menu. These
definitions are actually made in the Instrument Index module and can be accessed
from the DDP module too.
For a detailed explanation about the above-mentioned features, see the Instrument
Index module documentation.

Define a Dimensional Group

Defining the dimensional groups is the step in storing and managing dimensional
data. You need dimensional groups to store, display, and manage default, working
and vendor dimensional data. Moreover, instrument types are also associated with
dimensional groups. Hence, new tag numbers whose instrument type is associated
with a particular dimensional group will contain dimensional data and this
dimensional record will be displayed in the Working Data window.
Note
• The Domain Administrator first needs to import DDP library data,
including default groups.
1. In the Dimensional Data for Piping window, on the Tables menu, click
Dimensional Groups.
2. To create a new dimensional group, in the Dimensional Groups dialog box, click
New.
3. Under Dimensional Group, type the group name.
4. Under Description, type the group description.
5. Select the 3 Points and/or 4 Points check boxes, depending on how many
connection points you want to define.
6. In the CAD Code field, type the desired CAD code.
7. To define the current group parameters, click Properties. See Defining
Dimensional Group Properties, page 1250 for more details.
8. To assign a picture to the selected group, do the following:
a. Under Picture, click Assign.
b. In the Select Group Picture dialog box, navigate to the desired file, and click
Open.
9. To assign a dimensional data sheet form to the current group, under Form, click
Assign.
Related Topics
• Defining Dimensional Group Properties, page 1250

Define Dimensional Group Properties

This procedure enables you to define dimensional data parameters for a given
dimensional group. These parameters then appear in the Default Data window, the
Working Data window, and the Vendor Data window, as well as in the Dimensions
section of the Add Data, and Edit Data dialog boxes.
Thirty parameters are available for each dimensional group. You create an active
parameter by typing its description, selecting it for use, and setting its allowed
minimum value to be zero or greater than zero.
Dimensional Groups.
Tip
• At this point, you can modify general properties of the dimensional
group (for details, see Defining Dimensional Groups, page 1249).
2. Click Properties.
3. In the Dimensional Group Properties dialog box, under Description, type the
desired parameter description.
4. To include this parameter in the selected dimensional group, click Select.
Tips
• To select all thirty parameters, select the Select all check box.
• You cannot clear a Select check box for a parameter for which the
dimensional group is assigned.
5. If you require the selected parameter to have a value greater than zero, select the
Release if Zero check box.
Tip
• Clearing Release if Zero does not prevent you from placing zeros in
this field, but rather prevents the release of dimensional data by
disabling the Ready for Release option.
6. Click OK to accept your definitions and return to the Dimensional Groups
dialog box.
Related Topics
• Defining Dimensional Groups, page 1249

Duplicate a Dimensional Group

This option enables you to create a new dimensional group based on the same group
parameters as the selected group.
1. With the Dimensional Groups dialog box open, highlight the desired group.
2. Click Duplicate to duplicate the selected group.
3. Click OK to accept your definitions, save the group data, and close the dialog
box.
Assigning Dimensional Data Forms

Assigning a dimensional data form to a dimensional group consists of two stages:
• Assigning a .psr file to a dimensional data form

• Assigning the dimensional data form to a dimensional group
Assign a PSR File to a Dimensional Data Form

Dimensional Data Sheet Forms.
2. To create a new dimensional data form, do the following:
a. Click New.
b. Type the form name and description in the appropriate fields.
3. Select the dimensional data form to which you want to assign a .psr file, and click
Assign.
4. In the Select Group Form dialog box, navigate to the desired .psr file and click
Open.
5. In the Dimensional Data Forms dialog box, click OK.
Assign a Dimensional Data Form to a Dimensional Group

1. Click Tables > Dimensional Groups.
2. Select the group to which you want to assign a dimensional data form, and under
Form, click Assign.
3. In the Assign Dimensional Data Form dialog box, select a form, and click OK.
Related Topics
• Defining Dimensional Groups, page 1249

Associate an Instrument Type with a DDP Group

This option enables you to set the default dimensional group for new tag numbers that
are associated with dimensional data. Note that this procedure is performed in the
1. In the Instrument Index Module window, on the Tables menu, click
Instrument Types.
2. From the Process function list, select the process function.
3. In the data window, select the instrument type.
4. Click Profile.
5. On the General tab, under Dimensional data, do the following:
a. Select the Include dimensional data check box to associate the selected
instrument type with dimensional data.
b. From the Group Name list, select the dimensional group with which
dimensional data will be associated by default.
6. Click OK to close the Instrument Type Profile dialog box and then click OK to
close the Instrument Types dialog box.

Managing Vendor Data

Vendor data is used for data validation and verification purposes of dimensional data
for piping design. You use Vendor data to certify the Working data prior to its
release to piping.
Instead of inserting raw Vendor data manually, use the Import Utility to import a
large amount of raw vendor information. After importing the Vendor data, you revise
the raw vendor data to assign it to a dimensional group, verify the instrument tags,
and, if desired, manually modify the vendor data details.
Sometimes multiple records for the same instrument can exist. This can happen if
you import vendor data from several manufacturers. You can copy vendor data to the
Working data if the manufacturer, model, the Dimensional Group, and the process
connection values match the Working data values.
You can also indicate whether the imported data has been copied to the Working data.
You can reset this indication every time import is performed for a specific record,
thus creating a clear indication if the latest information has been copied to the
Working data.
Managing Vendor data involves editing it and entering new dimensional vendor data
for a selected instrument.
Vendor data is displayed in the Vendor Data window.
Display and Access Vendor Data

1. With the Dimensional Data for Piping Module window open, click or click
Vendor Data on the View menu.
2. In the Select Dimensional Group dialog box that opens, select the desired
dimensional group and click OK.
The Vendor Data window opens displaying the existing vendor data records.
You can customize the display and layout of the data in the Working Data
window. The following options are available:
• Determining the fields to be displayed

• Sorting the data
• Filtering the data

Enter Vendor Data

This feature allows you to enter vendor data manually. It is useful when adding a
few records. If you want to enter numerous records, use the Import Utility.
1. Open the Vendor Data window and do one of the following:
• Right-click anywhere in the Vendor Data window and click New
Vendor Data on the shortcut menu.
• Click New Vendor Data on the Actions menu.
2. Beside Tag number, click Browse and then do the following:
a. In the Enter Tag dialog box, type in the desired tag number and click OK or
click Find to find the desired tag number.
b. In the Find Tag dialog box, enter the desired search parameters and click
Find to find the desired tag number.
c. Under Search Results, highlight the desired tag number and click OK to
return to the New Vendor Data dialog box where this tag number is displayed
in the Tag name field.
3. Select the desired instrument manufacturer from the Manufacturer list.
4. Select the desired instrument model from the Model list.
5. Type the desired full and dry weight values and select the weight unit of measure
from the Weight UOM list.
6. In the Revision field, type the revision number as needed.
7. Enter the default INLET and OUTLET values: type in the Size values and select
the appropriate values from the Class and End preparation lists.
8. Enter the default #3 and #4 process connection values if needed: type in the Size
values and select the appropriate values from the Class and End preparation
lists.
9. In the Dimensions section, type in the default dimensional properties. Note that
the Dimensions field names appear as you have defined them in the Dimensional
Groups dialog box.
10. Type the Full and Dry Weight values.
11. Select the weight unit of measure from the Weight UOM list.
12. Click OK to save the data and close the dialog box.

Enter Vendor Data

This feature allows you to enter vendor data manually. It is useful when adding a
few records. If you want to enter numerous records, use the Import Utility.
1. Open the Vendor Data window and do one of the following:
• Right-click anywhere in the Vendor Data window and click New
Vendor Data on the shortcut menu.
• Click New Vendor Data on the Actions menu.
2. Beside Tag number, click Browse and then do the following:
a. In the Enter Tag dialog box, type in the desired tag number and click OK or
click Find to find the desired tag number.
b. In the Find Tag dialog box, enter the desired search parameters and click
Find to find the desired tag number.
c. Under Search Results, highlight the desired tag number and click OK to
return to the New Vendor Data dialog box where this tag number is displayed
in the Tag name field.
5. Type the desired full and dry weight values and select the weight unit of measure
from the Weight UOM list.
6. In the Revision field, type the revision number as needed.
8. Enter the default #3 and #4 process connection values if needed: type in the Size
lists.
Groups dialog box.

Managing Working Data

This feature enables you to store and manage Working dimensional data. The
Working Data window displays existing Working dimensional data for tag numbers
entered in the Instrument Index module. Once you create a new tag number whose
instrument type is associated with dimensional data and a dimensional group, the
dimensional data for this tag will be displayed in the Working Data window.
You can also add more records to the Working data by copying from Vendor data or
by copying preliminary default data from the Default Library if the Dimensional
Group, manufacturer, model, and the process connection values match the Working
data.
Managing Working data involves editing it, modifying the data status, entering the
piping design area, and finally generating and printing out a Dimensional Data Sheet
for a particular instrument.
You access Working data in the Working Data window.
Display And Access Working Data

1. With the Dimensional Data for Piping Module window open, click or click
Working Data on the View menu.
2. In the Select Dimensional Group dialog box, highlight the desired dimensional
group and click OK.
The Working Data window opens displaying the existing working data records
for the instruments whose instrument type is associated with dimensional data and
the current dimensional group.
Tip
• You can customize the display and layout of the data in the Working
Data window. The following options are available:
• For a detailed explanation on how to carry out these procedures, refer
to the Browser module, Defining a View Profile.

Edit Working Data

You can edit the working data either in the Working Data window or in the
Working Data Properties dialog box. Note however, that not all the fields are
accessible for editing in the Working Data window. Therefore, you should edit the
data in the Working Data Properties dialog box.
1. With the Working Data window open, highlight the desired tags and do one of
the following to open the Working Data Properties dialog box:
• Right-click the selected tag numbers and click Working Data
Properties on the shortcut menu.
• Click Working Data Properties on the Actions menu.
3. Enter the default #3 and #4 process connection values: type in the Size values and
select the appropriate values from the Class and End preparation lists.
4. Under Dimension values, type the default dimensional properties. Note that the
Dimensions field names appear as you have defined them in the Dimensional
Groups dialog box.

Enter the Piping Design Area

This option enables the piping designers to enter 3-D CAD design model or piping
design area for the selected instrument. You can select multiple records from the
Working Data window and enter or modify the piping design area as needed.
1. In the Working Data window, highlight the desired instruments and do one of the
following:
• Right-click the selected instruments and click Piping Design on the
shortcut menu.
• Click Piping Design on the Actions menu.
• b>Piping Design Area dialog box opens.
2. Type in the desired design area name in the Design Area field and click Save.
3. Select the Copy to all tags check box to copy the design area name you have just
entered to all the selected instruments or click Preview or Next to open the
previous or the next record.
Note that all the other fields in this dialog box are read-only.
Copy Working Data to Default Data

This option enables you to copy working dimensional data to the Default Library.
The copied record includes all its definitions: the dimensional group, manufacturer,
model, and the process connection values.
You can select only a single instrument at a time. This instrument will serve as a
default example. For each selected instrument, the software can then search a default
record with corresponding dimensional group, manufacturer, model, and process
connection values.
1. In the Working Data window, highlight the instruments whose working data you
want to copy to the Default Library and then do one of the following:
• Right-click the selected tag numbers and click Copy Working to
Default on the shortcut menu.
• Click Copy Working to Default on the Actions menu.
2. Examine the information in this view-only dialog box and click Copy to copy the
Working data to the Default Library.
Note that the Copy button will be disabled if no matching values are found.

Copy Default Data to Working Data

This feature allows you to copy records with preliminary default dimensional data
into the working data of the selected instrument. Copying default data from the
Default Library is only possible if the dimensional group, manufacturer, model, and
the process connection data match the working data.
You can select numerous instruments whose default data you want to copy. For
every selected tag number, the software can then search for values matching the
working data. Only after matching dimensional group, manufacturer, model, and
process connection values are found, the software copies the default data.
After successfully copying default data, the status of the copied records is set as
Preliminary and its revision number as 0 (zero). The revision number will then be
incremented from the last preliminary status by one, e.g., Preliminary 1.
1. In the Working Data window, highlight the tag numbers whose default data you
want to copy and then do one of the following:
• Right-click the selected tag numbers and click Copy Default to
Working on the shortcut menu.
• Click Copy Default to Working on the Actions menu.
The software searches for instruments with matching dimensional group,
manufacturer, model, and process connection values. Once matching values
are found, the Copy Dimensional data from Default Data dialog box opens:
2. Examine the displayed data:
• Instruments selected— this field shows how many tag numbers you
selected whose default dimensions you want to copy.
• Instruments found— this field shows how many tag numbers in the
working data match the values in the default data.
• Instruments with incomplete data— this field shows how many tag
numbers in the working data have incomplete data.
A progress bar opens under the data status indication showing you the data
copying progress. For every instrument with matching values, default
dimensional values are copied.
3. Click Copy to copy the data.
copying progress.
Note the following possibilities:
• If the instrument contains no working data, the copied default

dimensions will be marked as ready for release.

• If the instrument contains working data, you will be prompted if you

want the working data to be overwritten by the default data. The
copied dimensions will be marked as suspected.
• If the instrument contains working data whose status is certified, a
warning message appears informing you that the working data for this
instrument is certified by vendor. You will be prompted whether you
want the working data to be overwritten by the default data. If you
choose to overwrite it, the dimensional data status will marked as
suspected.
Copy from Vendor Data to Working Data

This feature allows you to copy certified vendor data to the working data of a
selected instrument. Copying vendor data is only possible if the dimensional group,
manufacturer, model, and the process connection data match the working data.
You can select numerous instruments for which you want to copy vendor data. For
each selected instrument, the software can then search for matching dimensional
group, manufacturer, model, and process connection values. Once matching values
are found, the software opens the Copy from Vendor to Working dialog box that
displays the number of instruments selected and the number of instruments found
with matching values.
1. In the Working Data window, highlight the tag numbers for which you want to
copy vendor data and then do one of the following:
• Right-click the selected tag numbers and click Copy from Vendor to
Working on the shortcut menu.
• Click Copy from Vendor to Working on the Actions menu.
The software searches for instruments with matching dimensional group,
manufacturer, model, and process connection values. Once matching values
are found, the Copy from Vendor to Working dialog box opens:
2. Examine the displayed data:
• Instruments selected— this field shows how many tag numbers you
selected for which you want to copy vendor dimensions.
• Instruments found— this field shows how many tag numbers in the
working data match the values in the vendor data.
• Instruments with incomplete data— this field shows how many tag
numbers in the working data have incomplete data.
copying progress. For every instrument with matching values, vendor
dimensional values are copied including the vendor revision number. This
data will be marked as copied to working data.

3. In the Set Status section, select the dimensional data status of the working data as
desired: Preliminary, Design, or Certified.
4. Click Copy to copy the data.
Note the following possibilities:
• If the instrument contains no working data and all desired dimensional

data is defined, the data will be marked as ready for release.
• If the instrument contains working data, you will be prompted if you
want the working data to be overwritten by the vendor data. The
copied dimensions will be marked as suspected data and copied from
vendor.
Notes
• When you copy the vendor data to the working data of a specific tag,
the working data revision number is incremented automatically
(Modify Status and Revision dialog box).
Modify Working Data Status

This option enables you to display and modify the current status of Working
dimensional data for the selected instrument. Three status stages are available:
Preliminary, Design, and Certified. Within each status, a revision number (from zero
to 99) indicates the progress of the dimensional data handling. An instrument status
can be described as a combination of these two parameters: the status of the Working
dimensional data and the revision number, for example PRELIMINARY 1 or
DESIGN 5.
Note that when you modify the data status because of any dimensional data
management, you will be able to reset the suspected data flag and mark the data as
correct and ready for release to piping.
Caution
• The Working data status cannot be changed to CERTIFIED unless a
purchase order has been issued and entered in the Instrument Index or
Note also that you can select multiple instruments for status modification.
1. In the Working Data window, highlight the instruments whose working status
you want to modify and then do one of the following:
• Right-click the selected instruments and click Modify Status and
Revision on the shortcut menu.
• Click Modify Status and Revision on the Actions menu.

2. On the Status tab, click Set status and select the desired status from the Status
list. The list displays the selected status and becomes unavailable until you click
Set status again.
3. Click Raise to next revision to raise the revision number if needed.
4. Click in the Description text box and type a short status description.
5. Select the Reset Suspect Flag check box to remove the suspected data status for
the current instrument.
6. Click Save to save your settings.
7. Click Next or Previous to display the next or previous selected tag number.
8. Click OK to close this dialog box or click the History tab to open the History tab
folder.

Managing Default Dimensional Data

This feature enables you to store and manage preliminary dimensional data for your
instrumentation design. You can use standard (default) dimensions of known
manufacturers who are likely to supply the instruments. This Default data is stored in
the Default Library which allows you browse through the data, modify it, and copy it
to the Working data as needed. Once sufficient Default data is available, the DDP
designer can provide this data to the piping designers for their preliminary design.
The Default data will then be replaced or modified according to the actual
dimensional data received from the manufacturers.
Caution
• Note that you must first define the appropriate dimensional group, the
process connection data, and the manufacturer before you can start
entering default data. Remember that only one set of default
dimensional data can exist for a domain.
Enter Default Data Into the Default Library

1. With the Dimensional Data for Piping Module window open, click Default
Library on the View menu or click on the toolbar.
2. In the Select Dimensional Group dialog box, highlight the desired group and
click OK.
Caution
• If you select All Groups, you will not be able to edit the data and no
process connection values will be displayed.
3. Click Actions > New Default Data.
4. In the Default Data Properties dialog box, select the desired instrument
manufacturer from the Manufacturer list.
7. Enter the default #3 and #4 process connection values if needed: type the Size
lists.
Groups dialog box.

Edit Default Dimensional Data

1. Open the Default Data window for the desired dimensional group (for details, see
Entering Data into the Default Library, page Error! Bookmark not defined.).
2. Right-click the entries that you want to edit, and on the shortcut menu, click
Default Data Properties.
6. Enter the default #3 and #4 process connection values: type in the Size values and
select the appropriate values from the Class and End preparation lists.
Groups dialog box.
8. Type the Full and Dry weight values.
Customizing the Default Library Display and Layout

You can customize the display and layout of the data in the Default Library. The
following options are available:

For a detailed explanation on how to carry out these procedures, refer to the Browser
module, Defining a View Profile, page 264.

Generate a Dimensional Data Sheet

This feature enables you to produce a dimensional data sheet for a selected
instrument. The dimensional data sheet can complement or serve as an alternative for
the automatic 3-D CAD piping design.
A dimensional data sheet includes general tag information, dimensional data of the
specific group, and the graphic schematic or detailed presentation of the instrument
and its dimensions.
1. In the Working Data window, highlight the desired instrument and do one of the
following:
• Right-click the selected instrument and click Dimensional Data Sheet
on the shortcut menu.
• Click Dimensional Data Sheet on the Actions menu.
2. In the Dimensional Data Sheet window that opens, you can do the following:
• Enter or modify the values in the dimensional data sheet fields. Click
in the appropriate field to type a value or select a value from a list.
Note that not all the fields are accessible for editing.
• Manage and enter dimensional data sheet revisions. Click to open
the Revisions dialog box where you can enter and modify revisions.
• Save the dimensional data sheet as an external file, click .
• Print out the dimensional data sheet, click .
Tip
• You can also preview and print dimensional data sheets in batch mode.
For details, see Printing Dimensional Data Sheets, page 1268.
Track the Working Data Status History

1. With the Modify Status dialog box open, click the History tab to open the
History tab folder.
2. Examine the information and click Edit to type in any appropriate description if
necessary.

Generating DDP Reports

You can generate and print out the following reports.
Report Description
Group List Contains a detailed list of all existing Dimensional Groups
and their parameters, such as group name, description,
associated picture file, cad group identifier, and
dimensional parameter definitions.
Dimensions List Displays a detailed list of all dimensional data for each
instrument that is associated with dimensional data.
Suspected Data List Presents a list of all the instruments for which dimensional
data must be re-evaluated due to some changes made to the
instrument definitions. For example, if the process
connection or any other key parameter has been changed,
the data is marked as suspected. This report shows the
cause of the suspected data flag.
Status History Contains all the dimensional data status history per all
Tags whose dimensional data status has been changed.
Suspected Data History Displays a list of all Tags whose dimensional data was or
still is marked as suspected. The report also presents the
reasons for the suspected data indication.
Default Library List Contains a list of general default definitions for the
elements of the Default Library.
Default Dimensional Lists detailed definitions of the elements in the Default
Data Library.
Vendor Dimensional Contains a detailed list of vendor dimensional data.
Data
Data Sheets Allows you to display data sheets associated with specific
tag numbers.
Empty Sheet Forms Allows you to display field names and dimensional
properties only, without displaying the values. An empty
sheet form also displays a dimensional group diagram.
• With the Dimensional Data for Piping Module window open, on the
Reports menu, click a report menu command.

Generate A Suspected Data List, Status History, Or

Suspected Data History Report
1. With the Dimensional Data for Piping Module window open, on the Reports
menu, click the appropriate menu command.
2. In the Report Parameters dialog box, in the Report Per section, select if you
want the report to include data for all the instruments associated with dimensional
data or just for the selected groups.
3. In the Show data for section, select if you want the report to be generated for the
current <plant> or the current <unit>, and click OK.
Related Topics
• Printing Dimensional Data Sheets, page 1268
• Printing Empty Sheet Forms, page 1269

Printing Dimensional Data Sheets

Use this procedure to open a print preview of one more dimensional data sheets and
print dimensional data sheets in batch mode.
Batch preview and printing is available either from the Dimensional Data for Piping
Module window or from the Working Data window.
Print Dimensional Data Sheets From the Dimensional Data

for Piping Module Window
1. Click Reports > Data Sheets.
2. In the Select Tags for Printing Dimensional Data Sheets dialog box, find the
desired instruments.
3. Under Search results, select source tag numbers.
4. Click OK.
Print Dimensional Data Sheets From the Working Data

Window
1. In the Working Data window, select one or more instruments.
• On the Actions menu or shortcut menu, click Print Dimensional Data
Sheets.
• On the Working Data window toolbar, click .
Tip
• Clicking only prints the instrument list displayed in the Working
Data window.
Related Topics
• Generating DDP Reports, page 1266
• Printing Empty Sheet Forms, page 1269

Print Empty Sheet Forms

Use this procedure open a print preview and print one more empty sheet forms. An
empty sheet form is a form that does not contain any values. Such a form only
displays the names of the fields and dimensional properties, and also display the
dimensional group diagram. Each dimensional group is associated by default with
one sheet form.
1. Click Reports > Empty Sheet Forms
2. In the Print Empty Sheet Forms dialog box, select one or more dimensional
groups.
3. Click OK.
Related Topics
• Generating DDP Reports, page 1266
• Printing Dimensional Data Sheets, page 1268

Construction Module
Construction Module
Construction Flow of Activities
A typical flow of activities for installation consists of the following stages (the
procedures for each stage are described in more detail in the relevant sections):
1. Populating the following supporting tables:
• Contractors
• Contracts: One or more contracts can be defined per contractor.
• Installation Index Categories: SmartPlant Instrumentation provides
three default installation index categories: Instrument, Mechanical, and
Electrical. You can edit these if required, and you can also add up to
two more categories of your own.
• Installation Indexes: One or more installation indexes can be
associated with each contract. Each installation index must belong to
an installation category. Within each category, there is no limit to the
number of installation indexes you can define.
2. Assigning the installation indexes to the desired items (instrument tags, panels, or
cables) in the appropriate Construction Browser View.
3. Issuing reports. For each installation index, the following classes of reports can
be viewed and printed:
• Working report: Working (current) reports can be accessed from the
Installation Index Manager or by selecting filtered data to display in
the Browser and previewing the reports there.
• Formal report: Reports related to formal issues can be accessed from
the Installation Index Manager Archive.
In both classes, a complete report of the items assigned to the installation
index can be displayed, or where relevant, you can issue a change summary
report showing the differences between the current situation or selected
revision and the previous revision.
4. Retrieving archived reports.

Construction Module
Definitions in the Construction Module

In order to implement the installation, the activities must be defined. The following
elements of the Construction module are involved in specifying the activities:
• Installation Contractors: The companies responsible for carrying out

the different installation tasks.
• Installation Contracts: The documents used to specify the details and
conditions for each task or group of tasks. One or more contracts can
be defined for each contractor.
• Installation Categories: Each category can represent a discipline of
operation (for example, three default categories of Installation Indexes
are defined: Instrument, Electrical, and Mechanical).
• Installation Indexes: An installation index is an index number within
an installation category associated with a specific installation task.
Each task may consist of one or more activities.
• Items: A SmartPlant Instrumentation item can be an instrument tag, a
panel, or a cable to which an installation index can be assigned.
Within each category, only one index can be assigned to a particular
item.
• Formal Issue (Revision): A formal issue is a revision that is assigned
to an installation report when the contract data is stable and is ready to
be sent to the client for approval. The revision can then be used as a
benchmark for monitoring any changes that may be made later.
• Archive: After creating a formal issue for an installation index, the
reports containing the details of that index are stored in the Installation
Index Manager Archive. From there you can retrieve existing
installation reports showing archived information, or reports of the
changes that were made to the installation index since the previous
revision.

Construction Module
Installation Index Category Definitions

All new installation indexes that are defined must belong to an installation index
category. There are three default categories (editable) that are provided as standard:
Instrument, Electrical, and Mechanical, and you have the option to add two further
installation index categories if required.
Edit an Installation Index Category

You may only edit installation index categories that do not have any indexes assigned
to them.
1. Click Tables > Category.
2. In the Index Categories dialog box, select the desired row, and then click Edit to
open that row for editing.
3. Edit the code in the Prefix field (up to 5 characters) and Name fields if required
(you can enter a name of up to 20 characters in the Name field).
• To make the new installation index category available in the
Installation Index Manager window and in the header columns for
the appropriate Browsers, select at least one of the check boxes:
• Wiring Category: This makes Cable, Panel, and Wire reports
available for all items assigned to installation indexes in this
category.
• Instrument Category: This makes an Instrument report available
for all items assigned to installation indexes in this category.
• To exclude the new installation index category from the lists in the
Installation Index Manager window and in the header columns for
the appropriate Browsers, clear all the check boxes.
5. Click OK.

Construction Module
Edit an Installation Index

There may be occasions where you will want to update or change an installation
index definition. Editing an installation index may involve changes to the name,
description, or contract for the index. After editing an index name, the new name will
appear in the appropriate index field in the Browser Views for instrument tags where
the original index was assigned.
1. Click Tables > Installation Index.
2. In the Installation Indexes dialog box, in the data window, select the required
installation index, and then click Properties.
3. Edit the data in the appropriate fields (Number, Description, and Contract
Number) as required.
Tip
• Installation Index numbers must be unique.
4. Repeat steps 2 through 4 for each installation index you want to edit.
Delete an Installation Index

When an installation index is no longer needed, you can delete it, provided it has not
already been assigned to an item in one of the Browser Views.
2. In the Installation Indexes dialog box, in the data window, select the index that
you want to delete.
3. Click Delete.
The installation index is deleted.
4. Repeat steps 2 and 3 for each installation index you want to edit.

Construction Module
Viewing and Modifying Assigned Installation

Indexes
After assigning an installation index to an instrument tag, you can open a filtered
browser view based on the currently selected index in the Installation Index
Manager window. The filtered list enables you to view and modify with ease those
items (instrument tags, panels, cables, or wires) that already have a particular index
assigned to them.
Note
• If you change the electrical index in one of the report views — tag,
panel, or cable — SmartPlant Instrumentation updates the electrical
index of all the relevant items.
Modify Assigned Installation Indexes

1. In the Installation Index Manager window, select the required installation index
category from the list.
Tip
• The list of installation indexes for the selected category is displayed in
the lower data grid.
2. In the Report for field, select the required report (if more than one report is
available for the selected category).
Tip
• Where several reports are available for a particular installation index,
the revision data displayed in the lower data window will depend on
the report you select. Thus for the same installation index, different
reports may show different revisions.
3. In the lower data window, select the required installation index from the list.
• Click .
• Click Actions > Open Filtered Browser.
The appropriate Browser View window opens for the report you selected, for
example, the Panel Terminations Report. All panels in the database that are
linked to the selected installation index are displayed.
5. In an Index column, modify the index selection as required.

Construction Module

• Close the window.
• Click .
• Click Actions > Refresh.
7. At the prompt, click OK to save the changes.
Construction Options
The procedures described in this section explain how to create, maintain, and use
installation indexes for tracking the tasks performed by contractors.
Construction - Example Scenario

Using the installation of electronic 2-wire transmitters as a basis, the following
example shows the kind of data you would enter:
1. In the Contractors dialog box, define contractors as follows:
a. Contractor for mechanical tasks.
b. Contractor for electrical tasks.
c. Contractor for instrument-related tasks.
2. Define one contract number for each contractor.
3. Define installation indexes in each installation category (using the default
categories) as follows:
a. Instrument category
• I1: Instrument calibration only.
• I2: Instrument calibration and various checks.
b. Electrical category
• E1: Wire to JB only.
• E2: Wire to JB and MR.
• E3: Wire to MR only.
• E4: Wire to MR and CS.
•E5: Wire to CS only.
c. Mechanical category
• M1: Physical installation and connections.
• M2: Connect impulse piping.

Construction Module
4. Assign the installation indexes to the required instrument tags (in the appropriate
Construction Browser View), for example, the Instrument Installation Index View
is displayed, and indexes I1, E2, and M1 are assigned to a number of flow
transmitters.
5. Generate a formal issue for each installation index.
6. Change installation indexes that were wrongly assigned to one of the flow
transmitters as follows:
• I1 to I2.
• E2 to E1.
7. Create working and formal reports for installation indexes I1, I2, E1, and E2 to
show the current statuses of the installation indexes and their statuses prior to the
above changes.
8. Generate the following new formal issues:
• Revision for installation indexes I1 and I2.
• Revision for installation indexes E1 and E2 (report for wires).
Tip
• Revisions are performed per installation index and per report, and so in
this example, you would create a revision once all the changes for the
particular installation index have been made for the appropriate
instrument tags.
9. Change the electrical installation index for another flow transmitter from E2 to E3
and generate formal issues for both of these installation indexes (report for wires).
10. Preview and print formal change summary reports from the revision archive for
the last formal issue on installation indexes E2 and E3.
Selecting and Viewing Current Installation Indexes

There are two locations from which you can view the installation indexes:
• In the Installation Index Manager window, you can view a list of the
indexes in each category by selecting the category from the Index
category list.
• In the Installation Indexes dialog box, you can view a list of the
indexes in each category, or from all the categories.

Construction Module
View Installation Indexes on the Installation Indexes Dialog

Box
2. In the Installation Indexes dialog box, do one of the following:
• To view the installation indexes in a particular category, from the
Index category list, select the required category.
• To view the installation indexes in all categories, select Show all
index categories.
3. When done, click Cancel to close the dialog box.
Adding Installation Indexes

Adding an installation index requires the following actions:
1. Create the contractors in the supporting table.
2. Create the contracts in the supporting table.
3. Ensure that at least one installation index category is active.
4. Create the installation index itself.
Add an Installation Index

1. Define your contractors as follows:
a. Click Tables > Contractor.
b. In the Contractors dialog box, click New.
c. In the new line, enter a name (up to 20 characters) and a definition (up to 40
characters) in the appropriate fields.
d. Repeat steps b) and c) for each contractor you want to add.
e. Click OK to save your changes and close the Contractors dialog box.
2. Define your contracts as follows:
a. Click Tables > Contracts.
b. In the Contracts dialog box, click New.
A new line appears.
c. In the Contractor Name field, select a contractor from the list.
d. In the Contract Number field, type a number for the contract.
e. Repeat steps b) through d) for each contract you want to add.
f. Click OK to save your changes and close the dialog box.

Construction Module

4. In the Index Categories dialog box, check that the category definitions meet your
requirements, otherwise do one of the following:
• Create a new installation index category (for details, see Adding an
Installation Index Category, page 1279).
• Edit an existing installation index category (for details, see Editing an
Installation Index Category, page 1272).
5. Create the installation index as follows:
a. Click Tables > Installation Index.
b. In the Installation Indexes dialog box, from the Index category list, select a
category.
Tip
• Selection of an installation index category is a prerequisite for
defining an installation index. If no category is available in the
list, you can create one by clicking to open the Index
Categories dialog box. Select at least one of the check boxes:
Wiring Category or Instrument Category for one or more of the
installation index categories.
c. Click New.
Tip
• The category prefix is entered by default as the prefix for the
Installation Index number.
d. Type the installation index number and description in the appropriate fields.
Tip
• Installation Index numbers must be unique. If you do not modify
the default, you will be prompted to keep it on saving.
e. From the Contract number. list, select a contract.
f. Repeat steps c) through e) for each installation index you want to add.
g. Click OK to save your changes and close the dialog box.

Construction Module
Adding an Installation Index Category

There are two user-definable installation index categories. This section explains how
to create and use them.
Define a New Installation Index Category

2. In the Index Categories dialog box, select an empty row and click Edit to open
that row for editing.
3. Enter a short code in the Prefix field (up to 5 characters) and type a name (up to
20 characters) in the Name field.
4. In order to make the new installation index category available in the Installation
Index Manager window and in the header columns for the appropriate Browsers,
select at least one of the check boxes:
• Wiring Category: This makes Cable, Panel, and Wire reports
available for all items assigned to installation indexes in this category.
• Instrument Category: This makes an Instrument report available for
all items assigned to installation indexes in this category.
Tip
• Selection of both check boxes makes all four reports available.
5. Click OK.

Construction Module
Assign Installation Indexes to Items

You will remember that each installation index represents a particular activity
performed by a particular contractor. For every item (instrument tag, panel, cable, or
wire), you can assign one installation index in each of the active categories. Since a
contractor may perform the same activity on more than one item, you can assign the
same installation index in a given category to several items of the same type, such as
instrument tags. For example, you may want to assign the same electrical installation
index to all the instrument tags whose process function is measuring pressure.
At this stage, it is assumed that you have defined all your installation indexes as
described in the previous sections.
1. With the Installation Index Manager window open, select the required
installation index category from the Index category list.
The list of installation indexes for the selected category is displayed in the
data window.
2. Beside Report for, select the required report (if more than one report is available
for the selected category).
• Click .
• Click Actions > Open General Browser.
Tip
• The appropriate Browser View window opens for the report you
selected. For example, if you selected the Electrical Index, and you
chose Panels in the Report for field, the Panel Terminations Report
will be displayed. In the default category definition, the Panels report
(as part of the Wiring Category) only appears in the Electrical Index,
and therefore only the Electrical Index column will appear in the
Browser View. In this view, all the panels in the database are
displayed.
4. In the Electrical Index column, select the required index from the list for each
instrument tag as required.
• Close the window.
• Click .
• Click Actions > Refresh.
6. At the prompt, click OK to save the changes.

Construction Module
Generating Reports
You can display and print a report for each installation index revision you create.
Two types of report are available: a general report showing details of all the items in
the selected revision, and a change report showing only the differences between the
current revision and the previous one.
Generate Reports For An Installation Index Revision

1. Follow steps 1-3 in Viewing and Editing Archives, page 1284 to display the
required installation index revisions.
2. In the row with the revision for which you want to print the reports, select either
or both of the check boxes in the following columns:
• Report: to display the general report for the revision.
• Change Report: to display the change report with the differences
between the current and previous revisions.
Tip
• You may only print reports for one revision at a time.
• Click .
• Click Reports > Print Report.

Construction Module
Construction Module Revisions

The revision feature is used to keep track of the changes made to an installation
index. It is important and useful to have a chronological description of the changes,
dates of change, and a list of persons who approved them. Using this feature, you can
add revisions in the Installation Index Manager window.
Add New Construction Module Revisions

1. With the Installation Index Manager window open, select the required
installation index category from the list.
The list of installation indexes for the selected category is displayed in the
lower data window.
2. In the Report for field, select the required report (if more than one report is
• Click .
• Click Actions > Revision.
4. Select one of the revision numbering methods (use P0, P1, P2... for preliminary
revisions or 0, 1, 2 /A, B, C, and so forth, for normal serial revisions).
Tip
5. Click New to add new revision data.
6. Add the revision data in the appropriate data fields.
Tip
• The By data field contains the current user's initials by default, if
Administrator.

Construction Module
Maintaining a Revision Archive

When you create a new revision for an installation index in the Construction module,
a view-only archive copy is made of the information contained in the installation
index reports. This information is stored even after the reports themselves have been
deleted.
The revision archive data can be saved in the database or in a file, depending on the
setting selected in the Administration module.
Notes
• If you select to save your previous revisions in a file, make sure that:
the path to the appropriate file is added to your environment path
parameter (see your Windows User Guide to learn about defining
paths in your environment).
• If the revision file is shared by a number of users via a local network
connection, make sure that the resource on which that file is located is
appropriately shared (users should have both read and write access
rights to the revision files).
• Identical drive mapping is used for all the appropriate workstations to
indicate the location of the psr files.

Construction Module
Viewing and Editing Archives

Once you generate revisions for the installation indexes, the revision information is
added to the archive, and you can retrieve it when required. You can filter archived
indexes according to various criteria (contractor, contract, date ranges, etc.). On
retrieval of an archived index, you can edit its revision information and print reports.
View an Archived Installation Index

• Click .
• Click Actions > Installation Index Manager Archive.
2. In the upper part of the window, select the required criteria to filter the retrieved
installation indexes, from the following options:
a. In the Index category field, select to specify a particular installation index
category for filtering the retrieved archived indexes.
b. In the Report for field, select the required report (if more than one report is
c. To specify installation indexes belonging to a particular contract, select the
required contract in the Contract number field, or leave the field blank to
retrieve archived indexes that match the other selection criteria for all the
contracts.
d. To specify a particular installation index, select that index in the Index
number field, or leave the field blank to all archived indexes that match the
other selection criteria.
e. To specify installation indexes belonging to a particular contractor, select the
required contractor in the Contractor name field, or leave the field blank to
retrieve archived indexes that match the other selection criteria for all the
contractors.
f. Select one of the following options:
• Revision: to specify a particular revision number for retrieval. If you
do not specify a revision number, all relevant revisions will be
retrieved.
• From date / To date: to specify a range of dates for revisions. If you
do not change the defaults (From date: 00/00/00, To date: <today's
date>), all installation index revisions generated up to and including
the current date will be retrieved.
• Click .

Construction Module
• Click Actions > Find.

The installation index revisions are retrieved according to the specified
selection criteria.
4. If required, edit a revision as follows:
a. Select a revision from the retrieved list.
• Click .
• Click Actions > Revision.
Tip
• When you open the Revisions dialog box from the archive, you
can only edit existing revisions; you may not create new ones.
c. Edit the revision data as required in the appropriate data fields.
d. When done, click OK
You are returned to the Installation Index Manager Archive window.
5. To return to the current Installation Index Manager window, do one of the
following:
• Click .
• Click Actions > Working Installation Index Manager.

SmartPlant Instrumentation KKS

Overview
SmartPlant Instrumentation supports KKS naming conventions for process-related
identification of the following item types:
• Instruments
• Loops
• Lines
• Process equipment
• Control system tags
• Panels (plant panels only, belonging to panel categories available in
the Convention list in the Naming Conventions dialog box)
• Cables (plant cables only)
For each of these item types, the following KKS segment properties are available:
KKS Level Name Property Description

Total Plant Total Plant Single
character
(numeric or
alphabetic).
System Code System Code Prefix (optional) Single digit.
System Classification Three-character alphabetic key,
selected from a standard list, that
represents the type of system in
use the plant.
System Numbering Two-digit number with leading
zeros.


Equipment Unit Code Equipment Unit Classification Two-
character
alphabetic
key, selected
from a
standard list,
that
represents
the type of
equipment
within the
system used
for
measuring or
monitoring
the system,
or the type
of
measurement
circuit (level,
flow, and so
forth).
Equipment Unit Numbering Three-digit number with leading
zeros.
Equipment Unit Additional Code Optional character (alphabetic).
Component Code Component Classification Two-
character
alphabetic
key, selected
from a
standard list,
that
represents
the type of
component.
Component Numbering Two-digit number with leading
zeros.


Numbering Element (for cables Application Area Single digit
only) (0-9)
representing
the
application
area of a
cable
(voltage
levels).
Cable Number (digits 2 and 3) Two-digit number.
Cable Suffix The fourth position of the cable
number can be a numeric or
alphabetic character, mostly used
for grouping purposes.
Total Plant
This property is a single character (numeric or alphabetic).
System Code
System Code Prefix (optional) — Single digit.
System Classification — Three-character alphabetic key, selected from a standard

list, that represents the type of system in use the plant.
System Numbering — Two-digit number with leading zeros.
Equipment Unit Code

Equipment Unit Classification — Two-character alphabetic key, selected from a
standard list, that represents the type of equipment within the system used for
measuring or monitoring the system, or the type of measurement circuit (level, flow,
and so forth).
Equipment Unit Numbering — Three-digit number with leading zeros.
Equipment Unit Additional Code — Optional character (alphabetic).
Component Code
Component Classification — Two-character alphabetic key, selected from a
standard list, that represents the type of component.
Component Numbering — Two-digit number with leading zeros.

Numbering Element (for cables only)

Application Area — A single digit (0-9) representing the application area of a cable
(voltage levels).
Cable Number — Two-digit number.
Cable Suffix — The fourth position of the cable number can be a numeric or
alphabetic character, mostly used for grouping purposes.
Note
• SmartPlant Instrumentation does not auto-increment the numbering of
the various segments in the process identification.
Process Identification Prefix and Notation Characters
Process Identification usually uses the equal (=) character as a prefix. Identification
may include space (" ") or pipe (|) characters.
Examples
For a medium voltage panel, only the System Code segments might be required in
most cases. Thus a suitable KKS name would be 1 0BBA01, where the values are
designated as follows:
Property Value Description

Total Plant 1
System Code Prefix 0
System Classification BBA MV
distribution
board
System Numbering 01
Equipment Unit Classification (Not used)
Equipment Unit Numbering (Not used)
For a flow transmitter, the KKS identification 1 0PAE01 CF013 – B01 could be
used, where the values are designated as follows:

Total Plant 1
System Code Prefix 0
System Classification PAE Circulating
(main
cooling)
water pump
system


System Numbering 01
Equipment Unit Classification CF Open flow
loops
Equipment Unit Numbering 001
Component Classification -B Transducer
Component Numbering 01
Note
• When creating a new instrument, the associated loop inherits the
relevant segments of the instrument names and vice versa. Also, KKS
naming is propagated to cables when you connect them to panels that
already have KKS naming. Cables inherit the KKS naming of the
panel whose system code is first in alphabetic order.
Requirements for Importing Line Data in KKS Mode

When importing line data to the Instrument Index module, you need to perform the
following procedure to enable the use of KKS segments in the import link.
1. In the Import Utility, select the desired import link and open the Link Properties
dialog box.
2. Click the Style tab.
3. Select the Display all fields check box.
Related Topics
• Propagation of KKS Names in SmartPlant Instrumentation, page 1291
• SmartPlant Instrumentation KKS Overview, page 1286

Propagation of KKS Names in SmartPlant

Instrumentation
When an item, such as a loop, has KKS naming, and you perform tag number
association, the software automatically propagates the loop naming to the associated
tags. The software also propagates panel naming when you connect a cable to a
panel.
Target Item Type Inherited Components of Target Possible Example of

Item Name Source Source Item
Item Name
Type
Instrument All populated segments of the loop Loop =1 LBA01
number CF001
Cable All common and used process Panel =1 LBA01
identification segments of the CF001 4120
panel (the first system (4120 is the
classification which comes in cable
alphabetic order) numbering,
which is
entered
manually)
For a specific example of loop naming propagation, see Example of KKS Naming
Propagation, page 1292.
Notes
• The software performs propagation according to hard-coded rules.
Name segments that are not included in a propagation rule remain
blank.
• On connecting a cable to a panel, the KKS naming is propagated to the
cable. On disconnection, the cable retains the name received by
propagation until you reconnect it.
Related Topics

Example of KKS Naming Propagation

This scenario shows how SmartPlant Instrumentation propagates loop naming to its
tag when you create a loop in the Domain Explorer and associate a tag with this
loop.
1. In the Domain Explorer, create a new loop using the following KKS settings:
2. Click OK to open the Instrument Number dialog box, where you can create a
new instrument tag number. At this stage, the software has already propagated all
the loop naming settings.
3. Accept the propagated settings, and then, define the component classification as
shown (-B 01):

4. Click OK to display the Select Instrument Type dialog box, where the software
displays the instrument type that matches the component classification key value
in the instrument tag name:
Tip
• To display the matching instrument types, you must first populate the
Instrument Type supporting table with applicable KKS entries.
5. Select the instrument type and click OK to display the loop and its tag in the
Domain Explorer:
Related Topics
• Rename an Item in KKS Mode, page 1296

Scope of KKS Issues for the Current SmartPlant

Instrumentation Version
The current version of SmartPlant Instrumentation supports KKS naming conventions
for process-related identification of most instrumentation items.
Out of Scope Issues

The following issues are not supported in the current development:
• Integrated environment operations

• Configuration rules for KKS establishments
• Grouping of items hierarchically by a common physical system
classification or equipment unit
• Point of installation and location identification
• Signal identification (signal area, signal applications, and gated
signals)
• Typical loop management
• Creation of items with KKS naming from the Specifications module
• Loop naming propagation to instruments when renaming the loop
• Searching for items using KKS segments as search parameters. You
can, however, search for items using wild cards in the Find Items
dialog box, in the box where you can enter the full item tag name.
• Telecom options
• Macro expansion when importing from SmartPlant P&ID
Notes
• The software does not automatically increment numbering properties
of KKS segments.
• When creating multiple items, the names of all the items, other than
the first one, appear in the interface as zeros, for example: '00000',
even though KKS naming is actually applied to them. In such cases,
the user needs to rename the individual items by changing the
appropriate numbering segment, after which the software displays the
item names correctly.
• The software does not reset cable names when you disconnect one of
the cable sides from a panel that originally propagated its naming to
the cable.

• When renaming a panel, the software does not update the cable
naming according to KKS rules.
• If you change the naming convention, it only affects new items.
Existing items retain their names according to the previous naming
convention.
• The software does not make any validations between the item type and
the KKS code.
• The software does not validate imported data. For this reason, you
need to check the source data before importing it. It is recommended
to use the comparison list before importing line, equipment, or wiring
data. For instrument tags and loops, you can map the appropriate
segments of the source data to the KKS data segments in SmartPlant
Instrumentation.
• Moving a loop to another plant group or associating an instrument or a
loop with another loop does not affect the tag naming.
• When duplicating a loop containing a number of conventional
instrument tags, the software does not automatically detect the tag
number instrument type.
Related Topics

Rename an Item in KKS Mode

1. In the Domain Explorer, select an item such as an instrument and do one of the
following:
• On the item's Properties dialog box, beside Number (for an
instrument), click the ellipsis button .
• Right-click the item, and on the shortcut menu, click Rename.
Tip
• The name of the field representing the item name varies according to
the item type.
2. Type appropriate values in each segment of the item tag.
Tips
• Press the Tab key to move from one segment box to another.
• Move the mouse pointer over a segment to display a Tool Tip
indicating the name of the segment.
• Click the ellipsis button beside a Classification segment to display

the appropriate Classification dialog box, from which you can select
suitable values. If you have already typed part of the key prior to
clicking the ellipsis button, the Classification dialog box opens at the
appropriate place in the list.
• When a numeric segment accepts more than one digit, if you enter
fewer digits than the maximum, the software automatically adds
leading zeros to the value you typed. You cannot remove the leading
zeros from the segment.
Related Topics

Index
Index
.bmp files add_spec9 table, 796
adding to spec page, 806 ampersand character in specs, 812
.dxf files amplifiers
saving reports, 111 adding connectors, 762, 765
.isf files creating, 761
saving specs in .isf format, 903 analyzers
.pbl files analyzer stream specs, 856
retrieving reports, 126 complex analyzer specs, 841
.pdf files defining complex analyzers, 1198
document binder package, 979 linking stream and line components, 1199
printing specs into .pdf files, 937 overview, 1195
.psr files API 2540 standard
correcting grid line divergence, 918 liquid density calculation, 1202
correcting line discontinuity, 917 apparatus
creating invisible vertical line, 916 add an apparatus to a group, 509
customizing for Save as Excel, 914 apparatus group, 508
managing the file list, 125 common tasks, 505
opening as spec page, 793 configuring, 506
overview, 120 editing terminal properties, 510
replacing double lines, 917 fieldbus apparatus configuration, 687
retrieving custom spec pages, 800 overview, 504
retrieving files, 122 approvals
revisions, 973 in hook-up drawings, 1086
saving data, 123 in loop drawings, 1015
saving specs in .psr format, 902 As-Built
spec customization for Excel common tasks, 910 claiming items common tasks, 203
spec revisions, 898 claiming items for a project, 199
specprn.psr, 930 claiming items in Domain Explorer, 206
user-defined fields, 127 copying items for merging as Merge Now, 208
value display precision for Excel, 919 copying items for merging as Release Claim, 209
viewing, 121, 124 copying items to Claim Buffer, 205
.xls files displaying data in project, 204
font style of specs, 908 merging items common tasks, 203
global value display precision, 918 merging project items, 201
Save as Excel overview, 908 assign I/O
saving specs, 904 instrument tags, 411
saving specs in batch mode, 904 tag numbers, 411
setting macro security, 922 associating
spec customization common tasks, 910 items in KKS mode, 1292
spec customization guidelines, 912 associating external files, 958
.zip files AutoCAD
binder packages, 973 CAD settings, 1021
revisions, 973 LISP function, 1021
spec revisions, 898 paths, 1021
access rights auto-wiring
maintenance event records, 1128 changing task status, 590
Acrobat Distiller common tasks, 579
batch printing to PDF, 105 control systems, 585
setting print options, 107 control systems (pre-assigned junction boxes), 587
active item library flow of activities, 578
defining, 1064 overview, 575

Index
pre-assigned junction boxes, 581 assigning to instrument types, 998

task statuses, 590 assigning to instruments, 1000
tasks overview, 576 changing from Automatic to Manual, 999
two panels, 583 icons in the Domain Explorer, 988
base conditions manual assignment, 1000
in the Process Data module, 1176 overview, 988
batch loop creation updating block assignments, 1001
typical loop, 388 block types
batch operations, 1234 adding, 993
Acrobat Distiller options, 107 adding blocks, 993
adding tags to a multi-tag spec, 850, 851 icons in the Domain Explorer, 988
applying reference cables, 448 overview, 988
batch calculation, 1234 specifying default border block, 1006
CAD drawing block assignment, 1000 specifying default logo block, 1006
changing form assignment for specs, 831 blocks
creating hook-up items, 1065 associating loop block, 997
deleting spec revisions, 899 copying all automatically assigned blocks, 1003
deleting specs, 787 copying to another plant hierarchy item, 996
dissociating CAD drawing blocks, 1005 copying to other instruments, 1002
generating specs, 784 dissociating from instruments, 1005
Ghostscript printer options, 106 dissociating loop block, 997
importing data to instrument specs, 907 drawing generation per block, 1023
printing documents, 104 hook-up drawing border block, 1088
printing documents to PDF files, 105 hook-up drawing logo block, 1088
propagation of line data, 1179 inserting macros in drawing blocks, 1039
saving single-tag specs, 903 shipped blocks, 991
saving specs as Excel, 904 updating paths, 1016
batch printing viewing in CAD application, 994
dimensional data sheets, 1268 border blocks
dimensional sheet forms, 1269 CAD loop drawings drawings, 1006
Bill of Material hook-up drawings, 1088
common tasks, 1098 breakdown maintenance
generation, 1099 creating a repair form, 1125
opening by selecting document numbers, 1101 filling out repair forms, 1126
sorting data, 1100 issuing a new work request, 1122
binder packages opening a work request, 1123
adding revisions, 969 performing, 1103
change notification, 975, 976 brick assemblies
change summary report, 974 common tasks, 684
creating, 952 creating, 685
deleting, 957 overview, 683
deleting revisions, 971 browser manager
General Document Binder, 950 adding a new view, 265
managing external files, 958 browser types, 272, 273, 275, 276, 277, 278, 279,
notes, 959, 963, 965 280, 281, 282
overview, 948 clearing a view setting, 289
printing, 977 common tasks, 262
printing to file, 979 copying a view, 267
properties, 954, 983 creating a view style, 286
revision archive, 972 creating a workflow, 96
revisions, 967 default view, 263
saving, 981 defining a view, 264
Specification Binder, 949 deleting, 269
templates, 961, 962 displaying current settings, 297
troubleshooting, 984 displaying current style, 286
block assignment methods duplicating a view, 265

Index
duplicating views, 294 open an existing diagram, 642

filter settings, 302, 303, 304, 305, 306, 307, 308 overview, 638
finding, 270 removing objects, 643
hierarchy, 271 viewing an existing diagram, 642
modifing a profile, 267 cable drums
modifying style settings, 289 adding drums manually, 628
overview, 261 associating pulling areas, 626
print layout, 292, 293 automatic cable assignment, 630
printing style setting, 295 common tasks, 624
sorting sequence, 298, 299, 300, 301 defining attributes, 627
sorting settings, 296 deleting drums, 628
style settings, 284 editing drum properties, 628
browser module flow of activities, 623
overview, 260 manual cable assignment, 630
browser views, 408 optimizing, 630
applying profiles, 353 overview, 623
changing instrument type, 411 pulling areas, 626
changing process function, 411 cable routing
clearing data from the buffer, 322 adding sections, 617
common tasks, 316 appending to cable, 621
copying data, 321 associating with cables, 619
counting rows, 322 common tasks, 612
counting tag number rows, 407 copying to another cable, 620
creating device panels and cables, 479 customizing terminology, 615
displaying wiring connections, 411 editing, 619
editing data, 319 editing sections, 618
editing typical tags, 392 overview, 610, 611
Field Indication Color, 324 setting options, 614
finding a value, 323 standard positions, 616
finding a value in a column, 405 standard widths, 616
instrument index standard view, 403 cables
modifying layout, 319 adding connectors, 443, 692
opening, 318 adding sets to cables, 431, 445
opening a module, 325 applying a cable structure, 449
overview, 315 applying reference cables, 448
refreshing displayed data, 323 assigning drums automatically, 630
sorting rows, 322 assigning drums manually, 630
using the buffer, 321 associating with pulling areas, 626
view data history, 408 associating with routing section, 619
browsers cable hierarchy in Domain Explorer, 223
adding new browser common tasks, 309 common tasks, 434
adding new browser overview, 309 connecting device cables in batch mode, 532
adding new form browser, 313 connecting to terminal strips, 530
creating new, 311 creating, 441
creating spec form browser fields, 828 creating home-run cables, 671
opening specifications, 785 cross wiring, 573
showing in Explorer Items pane, 246 defining a configuration, 438
built-up back pressure, 1243 deleting a configuration, 441
cabinets device cables, 483
creating, 458 disconnecting, 536
cable block diagram, 638 display adjacent connections, 541
common tasks, 638 display farthest connections, 541
cable block diagrams, 638, 639, 641, 642, 643 editing, 444
adding items, 641 editing a configuration, 439
creating, 639 examples of farthest connections, 542
disconnecting cable, 642 fieldbus cables common tasks, 671

Index
filtering in Explorer, 242 CAD paths

moving to other terminals, 535 AutoCAD, 1021
overview, 433 long paths, 1021
renaming device cables in batch mode, 484 MicroStation, 1021
spur cables, 672 SmartSketch, 1021
telecom, 751 updating for CAD loop drawings and blocks, 1016
view connection destination, 540 updating for hook-up drawings and blocks, 1089
without sets and wires, 447 calculation
CAD drawing blocks batch calculation, 1234
actions in Domain Explorer, 224 calculating a control valve, 1230
adding to block type, 993 calculating a relief valve, 1227
assigning to CAD drawing pages, 1004 common tasks, 1219
assigning to instrument types, 998 creating new tags, 1241
associating loop block, 997 editing a calculation item, 1216
copying all automatically assigned blocks, 1003 flow coefficient standard, 1230
copying to another plant hierarchy item, 996 fluid definition, 1217
copying to other instruments, 1002 hybrid case, 1237
defining insertion points, 995 multi-case, 1236
display rules in Domain Explorer, 224 Thermowell, 1233
dissociating from instruments, 1005 viewing a calculation item, 1216
dissociating loop block, 997 calculation item reports
icons in the Domain Explorer, 988 generation principles, 1238
logo and border blocks, 1006 Calculation module
overview, 988 overview, 1215
reassigning dissociated blocks, 1001 starting, 1215
shipped blocks, 991 Calculation module reports
updating block assignments, 1001 Calculation Item, 1238
user-defined general blocks, 1006 calculation sheets, 1216, 1219
CAD loop drawing generation calculation common tasks, 1219
macros, 1037 editing a calculation item, 1216
per instrument block, 1023 opening, 410
per loop, 1023 viewing a calculation item, 1216
per page, 1023 calibration errors, 1155
CAD loop drawing history as found, 1155
deleting generation history records, 1027 as left, 1155
displaying generation history, 1025 calculation formulas, 1155
showing latest generated drawing, 1025 square root extraction, 1155
CAD loop drawings calibration failure
assigning drawing blocks to pages, 1004 action codes, 1144
associating external drawing, 1017 damage codes, 1145
client and vendor approvals, 1015 diagnostic codes, 1146
date formats, 1009 calibration history
defining insertion points for blocks, 995 generating reports, 1165
dissociating external drawing, 1017 maintaining, 1160
generation error report, 1028 Calibration module
generation prerequisites, 1018 Calibration module windows, 1134
generation principles, 1018 common tasks, 1133
generation procedure, 1023 flow of activities, 1133
maintaining document references, 1014 overview, 1132
maintaining revisions, 1012 starting, 1134
multi-drawings, 1010 calibration reports
multi-page drawings, 1011 generation, 1164
TagAsMacroName parameter, 1018 history reports, 1165
updating paths, 1016 calibration results
viewing drawing blocks, 994 deleting, 1161
viewing external drawing, 1017 recording in tag calibration history, 1150

Index
result codes, 1147 overview, 869

viewing and editing, 1162 removing instruments, 877
calibration settings removing sections, 877
alarm and trip levels, 1142 title block assignment method, 878
calibration ranges, 1141 with multiple instruments, 871
clearing ranges, 1144 with process data cases, 873
common tasks, 1140 computed values in spec fields
copying process data range values, 1139 defining field with computed values, 813
custom fields, 1141 showing revision numbers, 814
errors and points, 1141 connection types
scale definition, 1141 defining, 527
set point, 1143 examples, 529
cases, 1236, 1237 connections
calculating, 1236 adding jumpers, 537
hybrid case, 1237 common tasks, 525
multiple, 1190, 1191, 1192, 1193, 1194 connecting cables to terminal strips, 530
change connecting device cables in batch mode, 532
line type, 396 connecting wires to terminal strips, 534
changed documents, 94 connection types, 527
channels device panel connections, 411
assigning instruments, 552 disconnecting cables and wires, 536
assigning segments, 553 display adjacent connections, 541
associating with pins, 694 display farthest connections, 541
associating with terminals, 694 displaying, 411
creating, 554 examples of farthest connections, 542
displaying in panel-strip reports, 637 generating reports, 544, 636
finding for I/O assignment, 562 moving cables and wires to other terminals, 535
managing in the I/O Data dialog box, 560 overview, 524
claiming PDF panel-strip reports, 637
common tasks, 203 removing jumpers, 538
copying items to Claim Buffer, 205 tracing signals, 543
device panels,, 206 updating, 540
equipment in Browser module, 208 view cable destinations, 540
exclusive claim mode, 199 connectors
lines in Browser module, 208 adding to amplifiers, 762, 765
loops in Browser module, 208 adding to cables, 443, 692
non-exclusive claim mode, 199 adding to switches, 765
overview, 199 assigning connector pins, 693
tags in Browser module, 207 defining connector types, 691
tags in Instrument Index module, 207 deleting, 694
using Domain Explorer, 206 deleting connector types, 692
comparison of data hub connecors, 771
comparing with saved spec, 896 intercom connecors, 774
comparing with spec revision, 896 panels with terminals and connectors, 464
spec data comparison common tasks, 892 pin configuration, 691
complex analyzers control system tags, 563
defining, 1198 adding in I/O Assignment, 555
flow of activities, 1196 coupling with instruments, 557
fluid components, 1197 creating in standard browser view, 556
line components, 1197 CS tag alias, 352
linking stream and line components, 1199 decoupling instruments and CS tags, 557
overview, 1195 deleting, 558
composite specs filtering in I/O Assignment window, 558
duplicating, 869 propagation, 563
features not supported, 869 renaming, 556
loop composite spec, 875 control valves, 1230, 1242

Index
calculating, 1230 customization requirements, 115

flow coefficient standard, 1230 customizing in InfoMaker, 881
recommended characteristics, 1242 editing properties, 119
Controller/Processor header in I/O Card Properties, field descriptions, 115
501 modifying for specs, 883
conventions overview, 114
KKS, 1286 updating for specs after upgrade, 883
copy custom views
instrument tags, 364, 366 defining for Domain Explorer, 247
line data, 397 defining for Reference Explorer, 247
tag numbers, 364, 366 data fields
typical loop, 387 deleting from spec page, 818
copy profile data displaying field names in spec page, 793
instrument types, 352 duplicating in spec page, 818
copying spec data editing spec page field headers, 812
common tasks, 886 formatting spec page field values, 815
from form data template to spec, 889 generating spec reports by field name, 935
from one spec to another, 890 setting tab order in spec page, 799
from spec to form data template, 887 spec form browser, 828
overview, 885 spec_note_large column, 796
protecting fields from overwriting, 887 with computed values in spec page, 813
create data formats
line type, 396 Save As options, 110, 111, 113, 123, 981
criticality database views
adding values, 373 associating with specs, 817
cross wiring date formats
automatic, 571 CAD loop drawings, 1009
cables, 573 maintenance event records, 1129
common tasks, 564 DCS panels
manual, 566 associating with Profibus DP segment, 713
overview, 564 creating, 461
panel-strip reports, 574, 636 manufacturer-specific labels, 67
preferences, 538, 570 delete
semiautomatic, 568 instrument tags, 367, 368
CS tags line type, 398
adding in I/O Assignment, 555 loop numbers, 341
coupling with instruments, 557 loops, 341
creating in standard browser view, 556 tag numbers, 367, 368
CS tag alias, 352 typical loops, 391
decoupling instruments and CS tags, 557 de-multiplexing tag signals, 603
deleting, 558 device cables
filtering in I/O Assignment window, 558 connecting in batch mode, 532
renaming, 556 creating, 483
custom creating in standard browser view, 479
calibration fields, 1141 filtering in Explorer, 244
custom fields device panels
custom title block, 115 associating instruments, 482
documents, 115 automatic configuration, 473
in the Process Data window, 1175 claiming, 206
of wiring equipment in spec page, 819 common tasks, 470
revisions, 115 copying to Claim Buffer, 205
viewing PSR user-defined fields, 129 copying to Merge Buffer as Merge Now, 208
custom tables, 67 copying to Merge Buffer as Release Claim, 209
create report, 418 creating, 459
managing custom tables, 67 creating device cables, 483
custom title blocks creating in standard browser view, 479

Index
displaying connections, 411 viewing associated documents, 958

dissociating instruments, 482 documents numbers
editing plug-and-socket boxes, 676 modifying in a browser view, 320
for instruments, 480 domain explorer
manual configuration, 475 changing tag-loop, 379
multi-input with terminals, 727 Domain Explorer
overview, 468 arrangement of telecom items, 739
plug-and-socket multi-input device panel, 726 association rules, 230
pre-assigning junction boxes, 580 cable hierarchy, 223
principles, 469 claiming As-Built items, 206
renaming device cables, 484 common tasks, 214
with plug-and-socket connections, 675 creating items, 235
device types custom views, 247
telecom profile defaults, 746 deleting items, 236
dimensional data for piping dragging items, 230
forms, 1251 drawing blocks, 224
groups, 1249, 1250 duplicating items, 235
overview, 1245 editing item properties, 236
printing data sheets, 1268 features, 212
printing empty sheet forms, 1269 filtering items, 240
process connection class, 1247 filtering items according to item name, 242
dimensional groups finding a specific item, 239
printing empty sheet forms, 1269 hook-ups, 226
distribution frames item status indicators, 234
creating, 755 loops, 228
in Domain Explorer, 739 moving itmes, 236
document binder, 948 My List, 246
Document Binder module overview, 212
starting, 951 panels by category hierarchy, 221
Document Binder module reports panels by location hierarchy, 223
Change Summary, 974 searching for items, 238
document creation showing browser in Items pane, 246
common tasks, 413 tree view structure, 218
overview, 413 window, 248
document headers DP instruments
editing, 113 creating, 661
document numbers drawing
defining for hook-up drawings, 1085 drawing report, 416
defining for specs, 788 drawing blocks
opening hook-up reports, 1101 actions in Domain Explorer, 224
documents display rules in Domain Explorer, 224
associating external documents, 958 drawing generation methods
defining spec document numbers, 788 applying to hook-ups, 1084
dissociating external documents, 958 default, 1093
Document Browser view, 320 default method, 1084
modifying document numbers, 320 viewing, 1084
previewing, 102, 958 duplicate
printing, 104 instrument tags, 364, 366
printing to PDF files, 105 loop numbers, 333, 1186
REF_NAME macro, 1032 tag numbers, 364, 366
references in hook-up drawings, 1087 typical loop, 387
revision archive, 88 edit
revision management common tasks, 77 instrument tag properties, 363
revision management overview, 75 line data, 395
saving, 110 loop numbers, 336
saving in .dxf format, 111 tag data, 404

Index
tag number properties, 363 duplicating, 748

typical loop properties, 390 field values
typical tag properties, 391 setting a date range, 409
edit data tracking changes, 409
common tasks, 399 fieldbus
overview, 399 brick assemblies common tasks, 684
editing line process data brick assemblies overview, 683
fluid, 1188 changing segment instrument association, 669
selecting a pipe standard, 1187 configuring apparatuses, 687
electrical tags, 360 connections and associations common tasks, 689
equipment creating brick assemblies, 685
wiring equipment common tasks, 487 creating home-run cables, 671
wiring equipment overview, 485 creating I/O cards, 698
error messages, 1234 creating segments, 666
batch calculation, 1234 creating spur cables, 672
printing binder package, 984 dissociating from instruments, 668
Excel editing fieldbus segments, 667
font style of specs, 908 Fieldbus Tag Numbers Browser, 658
global value display precision, 918 flow of activities, 645
macro security requirement, 908 function block overview, 654
Save as Excel overview, 908 I/O assignment, 700
saving specs in batch mode, 904 instrument type profiles, 660
saving specs in Excel format, 904 instruments, 661
setting macro security, 922 managing cables common tasks, 671
spec customization common tasks, 910 multi-input devices, 723
spec customization guidelines, 912 overview, 644
Explorer plug-and-socket boxes overview, 673
common tasks, 214 preliminary definitions common tasks, 649
overview, 211 Profibus DP segments, 711
export Profibus PA segments, 711
process data files, 1207 segment wiring report, 706
Save As options, 110, 111, 113, 123, 981 segment-wide parameters, 651
exporting spec data segment-wide parameters example, 653
overview, 900 terminators, 678
protecting fields, 905 terminators common tasks, 678
external documents validation overview, 701
associating, 420 validation report for a segment, 704
common tasks, 419 validation report for multiple segments, 704, 705
opening, 421 view in Fieldbus Tag Numbers browser, 670
overview, 419 fieldbus specs
remove, 421 adding function block custom fields, 819
viewing, 421 editing columns in multi-tag specs, 846
external macros editing columns in single-tag specs, 835
assigning data sources, 1056 filter (Explorer)
connecting to external data source, 1052 device cables, 244
connecting to non-ODBC data source profile, 1055 filtering cables, 242
connecting to ODBC data source profile, 1054 filtering items, 240
data source connection prerequisites, 1053 filtering items according to item name, 242
naming conventions, 1050 filtering loops, 244
overview, 1049 filter settings
structure conventions, 1051 clearing view filter, 308
field devices, 459 defining filter view, 305
conventional, 749 displaying filter conditions, 304
plug-and socket, 750 duplicating view filter, 307
field tags modifying view filter, 306
creating, 747 find

Index
value in a column, 405 flow of activities, 645

finding loops function block overview, 654
all loops in a unit, 52 I/O assignment, 700
common tasks, 47 instrument type profiles, 660
overview, 46 instruments, 661
typical loops, 55 overview, 644
using search parameters, 53 preliminary definitions common tasks, 649
finding tag numbers segment wiring report, 706
in the Calibration module, 1135 segment-wide parameters, 651
finding tags segment-wide parameters example, 653
all tags in a unit, 48 validation overview, 701
common tasks, 47 validation report for a segment, 704
overview, 46 validation report for multiple segments, 704, 705
typical tags, 52 function blocks, 657
using search parameters, 49 associating with instrument types, 656
flow coefficient standard, 1230 associating with instruments, 664
flowmeters, 1219, 1221, 1223, 1225 customizing, 655
calculating a restriction device, 1225 enabling, 670
calculating a tube flowmeter, 1223 overview, 654
calculating an orifice, 1221 supporting table, 657
preparing for calculation, 1219 user-defined, 655
fluid definition, 1217 functional requirement
Fluke Interface, 1166 generating specs, 868
downloading data, 1167 general blocks
uploading data, 1169 assigning via instrument type, 1006
folders in Domain Explorer, 218 border and logo blocks, 1006
form browser general signals
adding new browser, 313 creating, 600
form data templates de-multiplexing tag signals, 603
common tasks, 833 linking tag signals, 601
copying data from specs, 887 multiplexing tag signals, 602
copying data to specs, 889 general specification notes
creating, 833 template, 960
modifying, 833 generate documents
protecting fields from overwriting, 887 generating documents
formats for multi-tag specs common tasks, 413
changing for existing specs, 862 Ghostscript
common tasks, 857 printer options, 106
creating, 858 global revisions
deleting, 861 adding, 79
modifying, 860 common tasks, 77
print layout, 862 filtering items, 78
regenerating, 862 managing spec revisions, 894
Foundation Fieldbus overview, 76
brick assemblies common tasks, 684 updating, 81
brick assemblies overview, 683 upgrade example, 83
configuring apparatuses, 687 upgrade settings, 80
connections and associations common tasks, 689 upgrading, 82
creating brick assemblies, 685 grid lines in specs
creating home-run cables, 671 correcting horizontal divergence, 918
creating I/O cards, 698 correcting line discontinuity, 917
creating segments, 666 correcting vertical divergence, 918
creating spur cables, 672 creating invisible vertical line, 916
Fieldbus Tag Numbers Browser, 658 replacing double lines, 917

Index
groups sorting in libraries, 1066

dimensional, 1249, 1250 hook-up libraries
HART instruments actions in Reference Explorer, 254
creating, 718 common tasks, 1060
flow of activities, 716 deleting items, 1068
I/O assignment, 721 display rules in Reference Explorer, 254
I/O cards, 720 overview, 1059
instrument type profiles, 717 hook-up reports
overview, 715 available reports, 1096
virtual digital tags, 720 Bill of Material, 1099
history common tasks, 1098
calibration history reports, 1165 Hook-Up Item List, 1100
deleting CAD loop drawing generation history, Hook-Up Tag List, 1101
1027 opening by selecting document numbers, 1101
displaying CAD loop drawing generation history, overview, 1096
1025 hook-up sub-libraries
in the Process Data module, 1213 actions in Reference Explorer, 254
maintaining calibration history, 1160 display rules in Reference Explorer, 254
spec data, 897 overview, 1059
home-run cables hook-up types
associating with segments, 696 assigning to instrument types, 1073
connecting to plug-and-socket boxes, 695 creating, 1072
creating, 671 deleting, 1079
hook-up drawings hook-ups
applying generation methods, 1084 actions in Domain Explorer, 226
assigning border and logo blocks, 1088 assigning to sub-libraries, 1075
changing output file names, 1085 associating instrument tags, 1074
clearing generation methods, 1084 associating items, 1076
client approvals, 1086 common tasks, 1070
common tasks, 1082 creating, 1072
default generation method, 1084 deleting, 1079
document references, 1087 display rules in Domain Explorer, 226
editing identifying fields, 1085 dissociating instrument tags, 1078
file formats, 1090 dissociating items, 1077
general drawing, 1080 duplicating, 1072
generating enhanced hook-up drawings, 1092 item list report, 1100
generating in CAD application, 1090 moving all to another hook-up type, 1075
generating in mixed mode, 1093 overview, 1057
generation overview, 1080 tag list report, 1101
generation scenarios, 1080 hubs
multi-page drawing, 1090 adding connectors, 771
output file name, 1090 adding ports, 771
paths for drawings and blocks, 1089 creating, 770
revision display order, 1080 creating hub cabinets, 769
revisions, 1086 hybrid case, 1237
vendor approvals, 1086 hybrid case specs, 845
hook-up items I/O assignment
associating with hook-ups, 1076 assigning instruments, 552
common tasks, 1060 assigning segments, 553
creating, 1064 canceling, 559
creating in batch mode, 1065 common tasks, 546
deleting, 1068 coupling CS tags with instruments, 557
displaying assigned pipe specs, 945 creating channels, 554
dissociating from hook-ups, 1077 creating CS tags, 555
duplicating, 1063 decoupling instruments and CS tags, 557
overview, 1058 enabling function blocks, 670

Index
filtering CS tags, 558 editing properties, 363, 406

finding I/O channels, 562 editing tag categories, 374
for instruments, 549 generate a list, 416
for segments, 551 generate a report, 416
Foundation Fieldbus, 700 instrument type profile defaults, 348, 350
generating reports, 560, 636 list, 416
HART instruments, 721 list available numbers, 416
overview, 545 loop association, 379, 380
point-topoint wiring diagram, 543 moving multiple tags, 369
Profibus, 700 moving to another unit, 368
tag preferences, 549 multiple, 378
I/O cards multi-row mode editing, 406
associating with I/O terminations, 502 naming, 360
common tasks, 697 new, 357, 358
creating, 497 opening an external document, 421
for Foundation Fieldbus, 698 remove external document, 421
for HART instruments, 720 renaming, 370
for Profibus, 698 renaming options, 371
manufacturer-specific labels, 67 sorting tag rows, 406
panel manufacturer-specific headers, 501 telecom field tags, 747
I/O terminations track field value changes, 409
associating with I/O cards, 502 viewing associated documents, 421
creating, 499 wiring and CS profile, 350
icons in Domain Explorer, 234 instrument types, 348
importing data appling profiles, 353
process data files, 1205 assigning CAD drawing blocks, 998
importing spec data assigning hook-up types, 1073
from external file, 906 associating with function blocks, 656
overview, 900 changing, 411
to instrument specs, 907 common tasks, 347
InfoMaker copying profile data, 352
customizing title blocks for specs, 881 default profile, 348, 350
instrument blocks define CS alias tag, 352
actions in Domain Explorer, 224 fieldbus instruments, 660
display rules in Domain Explorer, 224 HART instruments, 717
drawing generation per block, 1023 overview, 346
instrument creation wiring and control system, 350
with auto-configured device panel, 473 Instrumentation Explorer
with manually configured device panel, 475 overview, 211
without a device panel, 477 instruments
instrument index adding CS tags, 237
change tag-loop association, 380 assigning CAD drawing blocks, 1000
create custom table report, 418 assigning pipe specs, 942
defining standard view, 403 assigning to channels, 552
overview, 328 associating device panels, 482
instrument tags, 348 associating with function blocks, 664
adding remarks, 363 associating with hook-ups, 1074
adding tag categories, 374 associating with Profibus DP segments, 712, 713
assigning I/O, 411 associating with Profibus PA segments, 712
associate new loop, 379 associating with segment, 668
associating external documents, 420 base conditions, 1176
change instrument type, 372 calculating physical properties, 1182
copying, 364, 366 changing segment association, 669
counting rows, 407 copying CAD drawing blocks, 1002
deleting, 367, 368 copying line process data, 1178
duplicating, 364, 366 copying process data from other tags, 1177

Index
coupling with CS tags, 557 creating sub-libraries, 1063

creating and associating device cables, 483 deleting sub-libraries, 1069
creating device panels, 480 duplicating, 1062
creating in Specifications module, 786 sorting hook-up items, 1066
decoupling instruments and CS tags, 557 items, 240, 242
dissociating CAD drawing blocks, 1005 adding to custom view, 247
dissociating device panels, 482 applying naming conventions, 430
dissociating from hook-ups, 1078 association rules in Domain Explorer, 230
dissociating from segment, 668 claiming common tasks, 203
entering power supply data, 361, 465 claiming for a project, 199
fieldbus instruments common tasks, 659 claiming items in Domain Explorer, 206
finding, 46 copying As-Built items to Claim Buffer, 205
Foundation Fieldbus instruments, 661 copying items for merging as Merge Now, 208
generate process data sheet, 415 copying items for merging as Release Claim, 209
generating a report, 237 copying reference items, 238, 256
generating a specification, 237 creating in Domain Explorer, 235
generating process data reports, 1211 creating reference items, 256
HART instruments, 718 deleting, 236
Hook-Up Tag List report, 1101 duplicating, 235
I/O assignment, 549 editing, 236
Instruments folder in Domain Explorer, 218 filtering, 240
multi-input (plug-and-socket connections), 728 filtering according to item name, 242
multi-input (terminal connections), 730 filtering for global revisions, 78
performing various actions, 237 merging common tasks, 203
process data sheets, 237 merging with As-Built, 201
Profibus instruments, 661 moving, 230
serial interface (plug-and-socket), 732 moving in Domain Explorer, 236
serial interface (terminal connection), 734 name uniqueness of wiring items, 428
insulation types, 1199 reference items, 252
intercom removing trailing separators, 431
adding connectors, 774 renaming in KKS mode, 1296
intercoms revision management common tasks, 77
creating, 773 revision management overview, 75
creating cabinets, 772 searching for a specific item, 239
interface language searching for items, 238
common tasks, 69 sequence uniqueness of wiring items, 428
creating language files, 71 showing browser in Explorer Items pane, 246
editing, 72 status indicators in Domain Explorer, 234
overview, 68 using My List, 246
prefixes and suffixes, 74 jumpers
replacing from database, 70 adding, 537
replacing from file, 70 removing, 538
intools.ini, 131 junction boxes
intrinsic safety, 605 creating plug-and-socket boxes, 676
calculating, 606 editing plug-and-socket boxes, 677
calculating for loops, 609 generic junction boxes, 455
common tasks, 604 pre-assigning device panels, 580
creating a new circuit type, 605 telecom, 753
creating circuit types, 605 KKS
defining circuit cables, 608 importing line data, 1290
defining tags, 607 overview, 1286
item libraries propagation, 1291, 1292
active item library, 1064 renaming items, 1296
creating, 1062 scope, 1294
creating in batch mode, 1065 language
creating items, 1064 common tasks, 69

Index
creating language files, 71 .isf data import records, 907

editing, 72 import_isf.log, 907
overview, 68 logo blocks
prefixes and suffixes, 74 CAD loop drawings drawings, 1006
replacing from database, 70 hook-up drawings, 1088
replacing from file, 70 logon passwords
large note page changing, 42
creating, 796 loop blocks
line type actions in Domain Explorer, 224
create or edit, 396 display rules in Domain Explorer, 224
line types loop drawing generation methods
adding new, 1183 applying to loops, 1022
changing, 1183 By Loop, 1020
deleting, 1184 By Signal, 1020
editing properties, 1183 Custom by Loop, 1020
lines Custom by Signal, 1020
adding in the Process Data module, 1184 overview, 1020
adding line types, 1183 loop drawing history
assigning pipe specs, 943 clearing temporary data, 1027
changing line type, 396 loop drawing reports, 1028
common tasks, 394 loop drawings
copying data to another line, 1188 associating loop block, 997
copying data to instruments, 1178 dissociating loop block, 997
copying line data, 397 modifying identifying information, 1015
create a line type, 396 single-page drawings, 1012
define pipe specifications, 398 updating properties, 1008
deleting, 398 Loop Drawings module overview, 987
deleting pipe specs, 1201 Loop Drawings module reports
dissociating pipe specs, 946 CAD Loop Drawing Generation Errors, 1028
edit a line type, 396 loop error
editing line data, 395 calculating, 1158
line fluid velocity, 1189 overview, 1153
line ID in spec page, 804 setting tags, 1156
line process data reports, 1210 Loop Error Calculation Common Tasks, 1154
modify pipe specifications, 398 loop numbers
new, 395 common tasks, 329
pipe specs in Process Data, 1201 duplicating, 333, 1186
process data - fluid, 1188 editing, 336, 338
properties, 1185 editing multipe loops, 340
local revisions finding all loops in a unit, 52
adding, 86 finding loops using search parameters, 53
deleting, 87 finding typical loops, 55
editing, 87 function requirements, 345
local signals moving to another unit, 335
creating, 599 naming, 331, 332
filtering tag numbers, 599 new, 341
locations overview, 329
changing panel locations, 633 preferences, 343
defining panel locations, 632 properties, 338
deleting panel locations, 633 renaming, 342
dissociating panel locations, 633 renaming multiple loops, 344
modifying panel locations, 632 search options, 47
panel locations common tasks, 631 search options overview, 46
panel locations overview, 631 loops
log files actions in Domain Explorer, 228

Index
associate instrument tag, 379 creating a repair form, 1125

associate tag number,, 379 defining PM activities, 1113
change instrument tags, 379 defining PM attachments, 1111
change tag numbers, 380 defining PM tasks, 1112
deleting, 341 entering PM data, 1118
display rules in Domain Explorer, 228 extending existing scheduling, 1117
duplicating, 333, 1186 filtering maintenance activities, 1106
edit properties, 338 flow of activities for PM, 1120
filtering in Explorer, 244 issuing work requests, 1122
function requirements, 345 opening work requests, 1123
instrument tags, 379, 380 overview, 1102
instrument tags association, 379 preliminary activities in PM, 1109
loop report, 417 scheduling maintenance, 1115
loop summary, 417 starting, 1105
moving from one unit to another unit, 335 Maintenance module reports
multiple instrument tags, 378 generating maintenance reports, 1108
multiple renaming, 344 manufacturers (instruments)
multiple tags, 378 editing in specs, 839
preferences, 343 manufacturer-specific field headers, 67
renaming, 342 marshaling racks
tag numbers association, 380 creating, 456
Loops folder in Domain Explorer, 218 master tag, 852
macro definitions merge actions
overview, 1040 merge now, 201
macro function release claim, 201
creating user-defined functions, 1046 merging
default macro function, 1046 common tasks, 203
deleting, 1048 copying to Merge Buffer as Merge Now, 208
modifying, 1047 copying to Merge Buffer as Release Claim, 209
standard, 1045 merge actions, 201
standard macro function, 1046 overview, 201
user-defined, 1043 MicroStation
macros CAD settings, 1021
CAD loop drawings, 1037 long paths, 1021
creating definitions, 1041, 1094 miscellaneous cabinets
customized macro definitions, 1040 creating, 768
deleting definitions, 1042, 1095 in Domain Explorer, 739
external, 1049, 1050, 1051, 1056 models (instruments)
external macro data sources, 1052 editing in specs, 839
generating report, 1036 modules
loop title block, 1032 opening, 43
overview, 1029 move
structure, 1031 instrument tags to another unit, 368
wiring macro conventions, 1034 loop from one unit to another unit, 335
maintenance event records multiple instrument tags, 369
access rights, 1128 multiple tag numbers, 369
completing, 1131 multiple tags, 369
creating, 1130 tag numbers to another unit, 368
date formats, 1129 multi-case process data, 1236, 1237
deleting, 1131 calculation, 1236
description field, 1130 creating, 1191
flow of activities, 1128 deleting a case, 1194
overview, 1127 governing case, 1192
Maintenance module hybrid case, 1237
access rights, 1110 managing case names, 1193
breakdown maintenance, 1103 overview, 1190

Index
multi-drawings tag numbers, 357, 358

assigning blocks to pages, 1004 new loop
defining CAD drawings as multi-drawings, 1010 during tag edit, 341
multi-input devices non-instrument specs
common tasks, 724 common tasks, 865
device panels with terminals, 727 generating, 867
instruments (plug-and-socket), 728 generation prerequisites, 866
instruments (terminal connections), 730 overview, 864
overview, 723 non-wiring instruments
plug-and-socket device panel, 726 signal propagation, 598
serial interface (plug-and-socket), 732 notes in binder packages
serial interface (terminal connection), 734 form, 960, 961, 962, 963, 965
multi-page drawings general specification, 959, 960, 961, 962, 963, 965,
assigning blocks to pages, 1004 966
defining CAD drawings as multi-page drawings, notes in specs
1011 adding notes and remarks, 787
multiple loops open
editing, 340 calculation sheets, 410
multiplexing tag signals, 602 external document, 421
multi-row mode specification sheets, 410
editing properties, 406 supporting tables, 404
multi-tag specs PA cabinets
adding a single tag, 850 adding amplifiers, 761
adding tags in batch mode, 851 creating, 760
changing format, 862 in Domain Explorer, 739
common tasks, 847 PA instruments
editing, 851 creating, 661
formats common tasks, 857 PABX cabinets
generating, 849 adding racks, 763
master tag, 852 creating, 762
moving tag from single-tag spec, 840 PABX racks
moving tags to another see list, 853 adding switches, 764
moving tags to single-tag spec, 854 creating, 763
overview, 846 packages
overview of see list formats, 857 General Document Binder, 950
removing tags, 855 Specification Binder, 949
title block, 879 panels
My List, 246 adding racks, 466
name cabinets, 458
electrical tags, 360 changing locations, 633
instrument tags, 360 conventional panels common tasks, 453
instrument tags renaming options, 371 conventional panels overview, 452
loop numbers, 331, 332 creating plug-and-socket junction boxes, 676
renaming loop numbers, 342 DCS panels, 461
renaming loops, 342 defining new locations, 632
renaming multiple loops, 344 deleting locations, 633
tag numbers, 360 device panel overview, 468
tag numbers renaming options, 371 device panel principles, 469
typical loops and tags, 393 device panels, 459
naming conventions device panels common tasks, 470
applying to wiring items, 430, 431 dissociating locations, 633
item types supporting KKS, 1286 DP-compatible panels, 713
new, 375, 381 editing plug-and-socket device panels, 676
instrument tags, 357, 358 editing plug-and-socket junction boxes, 677
line, 395 entering power supply data, 361, 465
soft tags, 375, 381 fieldbus panels common tasks, 674

Index
generic junction boxes, 455 device panels, 675

in Domain Explorer, 218 editing device panels, 676
in Reference Explorer, 253 editing junction boxes, 677
locations common tasks, 631 for fieldbus, 673
managing locations, 631 panels with terminals and connectors, 464
manufacturer-specific labels, 67 point-to-point wiring diagrams
marshaling racks, 456 changing font size, 544
modifying locations, 632 opening, 543
panels by category hierarchy in Domain Explorer, viewing, 407
221 ports
panels by location hierarchy in Domain Explorer, adding to hubs, 771
223 adding to switches, 765, 766
PLC panels, 463 power supplies
plug-and-socket device panels, 675 entering data for instruments, 361, 465
telecom panels common tasks, 752, 757 entering data for panels, 361, 465
with terminals and connectors, 464 preferences
paper size of specs, 780 CAD settings, 1021
passwords cross wiring, 538, 570
changing the logon password, 42 customizing, 44, 130
patch panels displaying, 44, 130
creating, 756 general preferences common tasks, 44
in Domain Explorer, 739 I/O assignment, 549
PDF files intools ini file, 45
Acrobat Distiller options, 107 intools.ini, 131
pins loop numbers, 343
assigning connector pins, 693 preventive maintenance
associating with channels, 694 defining attachments, 1111
connector type pin configuration, 691 defining PM activities, 1113
pipe specifications defining PM tasks, 1112
defining, 398 entering PM details, 1118
modifiying, 398 extending existing scheduling, 1117
pipe specs overview, 1120
assigned to hook-up item sub-library, 945 preliminary activities, 1109
assigned to hook-ups, 1075 scheduling maintenance, 1115
assigning to instruments, 942 previewing documents, 102
assigning to lines, 943 print layout
associating with hook-up item libraries, 944 defining for multi-tag specs, 862
defining, 941 testing for multi-tag specs, 862
defining in Process Data module, 1201 printer settings
deleting, 947 modifying, 108
deleting in Process Data module, 1201 printing documents
dissociating from instruments, 942 Acrobat Distiller options, 107
dissociating pipe specs, 946 details, 104
modifying properties, 941 Ghostscript printer options, 106
pipes printing specs and reports
material, 1200 common tasks, 933
selecting a pipe standard, 1187 list of spec reports, 930
PLC panels printing a spec report, 934
associating with Profibus DP segment, 713 printing a specification, 937
creating, 463 process analyzers
manufacturer-specific labels, 67 complex analyzers, 1195
plug-and-socket boxes simple analyzers, 1195
common tasks for fieldbus, 674 process data
connecting home-run cables, 695 implementing Workflow, 98
creating junction boxes, 676 statuses for Workflow, 100

Index
Workflow browser view, 96 creating I/O cards, 698

Workflow overview, 95 flow of activities, 708
Workflow prerequisites, 96 function block overview, 654
process data cases I/O assignment, 700
generating hybrid case specs, 845 instruments, 661
generating specs, 844 overview, 707
process data for instruments segment-wide parameters, 651
calculating physical properties, 1182 validation report for a segment, 704
copying from another tag, 1177 validation report for multiple segments, 704, 705
deleting, 1181 Profibus DP
deleting cases, 1194 associating instruments with segments, 712, 713
differential pressure instruments, 1181 creating segments, 711
editing, 1175 DP-compatible panels, 713
multi-case, 1190, 1191, 1192, 1193 generating enhanced Profibus layouts, 714
process data for lines Profibus PA
adding line types, 1183 associating instruments with segments, 712
adding new lines, 1184 creating segments, 711
changing line types, 1183 generating enhanced Profibus layouts, 714
copying to instruments, 1178 segment wiring report, 706
copying to other lines, 1188 validation overview, 701
deleting cases, 1194 profile
deleting line process data, 1189 applying to an instrument type, 353
deleting line types, 1184 project + As-Built
fluids, 1188 claiming equipment in Browser module, 208
line fluid velocity, 1189 claiming items in Domain Explorer, 206
line process data reports, 1210 claiming lines in Browser module, 208
modifying line data, 1185 claiming loops in Browser module, 208
multi-case, 1190, 1191, 1192, 1193 copying items for merging as Merge Now, 208
propagating line data, 1179 copying items for merging as Release Claim, 209
selecting data for copying, 1180 copying items to Claim Buffer, 205
viewing, 1186 displaying As-Built data, 204
Process Data module tags in Browser module, 207
adding insulation types, 1199 tags in Instrument Index module, 207
adding tag numbers, 1172 propagation
external revisions, 1212 KKS, 1291, 1292
overview, 1170 propagation of signals
workflow, 1171 common tasks, 594
Process Data module reports de-multiplexing tag signals, 603
for one line or instrument, 1209 forcing, 596
generation pronciples, 1209 general signals, 600
reports for instruments, 1211 linking tag signals with general signals, 601
reports for lines, 1210 local signals, 599
process data sheets, 410 manual, 597
create for instrument, 415 multiplexing tag signals, 602
exporting, 1207 non-wiring instruments, 598
generate, 374 possible cases, 592
generate in browser view, 415 re-propagating, 596
importing, 1205 propagation of tag numbers, 563
opening, 410 control system tag propagation, 563
process function properties
add new subcategory, 349 editing instrument tags, 363
changing, 411 editing loop properties, 338
process functions editing tag numbers, 363
selecting for spec page, 798 editing typical loops, 390
Profibus editing typical tags, 391
common tasks, 710 racks

Index
adding slots, 466 list, 75

creating, 466 non-list, 75
Reference Explorer reports
arrangement of telecom items, 739 channels in panel-strip reports, 637
copying items, 238, 256 drawing report, 416
creating items, 256 generating from the Domain Explorer, 237
custom views, 247 generating spec reports by date, 935
duplicating items, 235 generating spec reports by field name, 935
editing item properties, 236 loop summary, 417
features, 252 panel-strip from Cross Wiring, 574, 636
filtering items, 240 PDF panel-strip reports, 637
filtering items according to item name, 242 process data sheets, 415
finding a specific item, 239 spec form field reports, 936
hook-up libraries, 254 spec report list, 930
moving items, 252 spec reports common tasks, 933
overview, 252 specification sheets, 415
searching for items, 238 telecom, 775
showing browser in Items pane, 246 wiring equipment in panel-strip reports, 637
tree view structure, 253 reports (Calculation module)
window, 257 Calculation Item, 1238
regenerating generation principles, 1238
spec forms, 830 reports (DDP module)
spec pages, 794 report descriptions, 1266
relief valves, 1227, 1229, 1243 reports (Document Binder module)
calculating, 1227 Change Summary, 974
calculating sizing in case of fire, 1229 reports (hook-ups)
entering built-up back pressure, 1243 available reports, 1096
remarks Bill of Material, 1099
adding to instrument tags, 363 Hook-Up Item List, 1100
adding to tag numbers, 363 Hook-Up Tag List, 1101
rename opening by selecting document numbers, 1101
instrument tags, 370 reports (Loop Drawings module)
tag number, 370 macro reports, 1036
renaming items reports (Maintenance module)
KKS, 1296 generating maintenance reports, 1108
repair forms reports (Process Data module)
creating, 1125 for one line or instrument, 1209
report comparison reports for instruments, 1211
comparing archived reports, 91 reports for lines, 1210
comparison color, 90 restriction device calculation, 1225
comparison font, 90 revision archive
currently previewed with archived, 92 binder packages in ZIP files, 973
overview, 89 for binder package (overview), 972
report generation revision macro order, 1080
from the Connection window, 544, 636 revisions, 1240
Spec Pages per Form, 829 adding global revisions, 79
report management adding local revisions, 86
comparison options, 89 adding to binder package, 969
editing report headers, 113 batch deletion of spec revisions, 899
previewing documents, 102 binder package, 967, 973
printing, 104 CAD loop drawings, 1012
printing documents to PDF files, 105 common tasks, 77
saving, 110 converting spec revisions, 898
saving in .dxf format, 111 deleting global revisions, 85
viewing archived reports, 93 deleting local revisions, 87
report types deleting specs in batch mode, 787

Index
display order in hook-up drawings, 1080 typical loops, 55

document binder revision archive, 972 typical tags, 52
editing local revisions, 87 sections
external revisions for process data, 1212 instrument composite spec, 871, 873
filtering items for global revisions, 78 loop composite spec, 875
global revisions, 76 overview of composite specs, 869
global upgrade example, 83 removing from composite page, 877
hook-up drawings, 1086 removing instruments, 877
in the Calculation module, 1240 see list
in the Process Data module, 1212 adding tags, 851
managing spec revisions globally, 894 changing columns header font, 853
overview, 75 changing format, 862
per document, 75 editing, 851
per item, 75 finding tags, 852
printing spec revisions, 895 formats common tasks, 857
report types, 75 generating multi-tag spec, 849
spec revisions common tasks, 892 master tag, 852
spec revisions overview, 891 moving tag from single-tag spec, 840
updating revisions globally, 81 moving tags to another see list, 853
upgrade settings for global revisions, 80 moving tags to single-tag spec, 854
upgrading global revisions, 82 multi-tag specs common tasks, 847
viewing archive, 88 overview, 846
viewing spec data history, 897 overview of see list formats, 857
saving data removing tags, 855
in .dxf format, 111 resizing columns, 853
in various formats, 110, 123 title block, 879
saving documents segments
editing headers, 113 assigning to channels, 553
in .dxf format, 111 associating DCS with Profibus DP segments, 713
in various formats, 110, 123 associating instruments with Profibus DP
overview, 101 segments, 712
ZIP files, 981 associating instruments with Profibus PA
saving specs segments, 712
as Excel, 904 associating with home-run cables, 696
as Excel in batch mode, 904 associating with instruments, 668
batch save of instrument specs, 903 associating with terminators in plug-and-socket
in .isf format, 903 boxes, 682
in .psr format, 902 associating with terminators on terminal strips, 682
overview, 900 changing instrument association, 669
save options common tasks, 901 common tasks, 665
search options dissociating from instruments, 668
common tasks, 47 DP-compatible panels, 713
overview, 46 editing, 667
searching enabling function blocks, 670
for tag numbers in the Calibration module, 1135 Fieldbus Tag Numbers Browser, 658
searching for for Foundation Fieldbus, 666
all loop numbers, 52 generating enhanced Profibus layouts, 714
all tag numbers, 48 I/O assignment, 551
items in Explorer tree view, 238 Profibus DP segments, 711
items to open spec for, 785 Profibus PA segments, 711
loops using search parameters, 53 segment-wide parameters, 651
spec forms, 785 select lists, 66
specific item in Domain Explorer, 239 adding new values, 66
specific item in Reference Explorer, 239 sequence
tags in see list, 852 uniqueness of wiring items, 428
tags using search parameters, 49 serial interface

Index
instruments with terminal connection, 734 overview, 211

plug-and-socket instruments, 732 SmartSketch
sets (cable) CAD settings, 1021
adding cable sets, 431, 445 paths, 1021
connecting to terminal strips, 530 soft tags, 357, 375, 381
shipped data new, 357, 375, 381
CAD drawing block files, 991 sort settings
fieldbus bricks, 685 displaying current setting, 297
function blocks, 654 sorting sequence, 298, 299, 300, 301
instrument types, 346 sorting
signals hook-up items, 1066
common tasks, 594 spec form data templates
de-multiplexing tag signals, 603 common tasks, 833
filtering tag numbers, 599 creating, 833
forcing propagation, 596 deleting, 834
from non-wiring instruments, 598 modifying, 833
general signals, 600 overview, 832
linking tag signals with general signals, 601 protecting fields from overwriting, 887
local signals, 599 spec forms
manual propagation, 597 adding pages, 826
multiplexing tag signals, 602 analyzer stream form 78, 856
point-to-point wiring diagram, 543 assigning title block, 882
propagation examples, 592 changing form assignment, 830
propagation overview, 591 changing form assignment in batch mode, 831
re-propagating, 596 common tasks, 822
tracing, 543 complex analyzer form 77, 841
single-page drawings creating, 824
modifying properties, 1012 creating spec form browser fields, 828
single-tag specs deleting, 829
common tasks, 836 editing properties, 825
editing field values, 838 hybrid case form 76, 845
editing units of measure, 838 listing form pages, 829
generating, 837 overview, 821
moving tags from see list, 854 regenerating library forms, 830
moving to see list spec, 840 removing pages, 827
overview, 835 restoring library forms, 830
saving in .isf format, 903 searching for, 785
saving in batch mode, 903 sorting pages for print order, 828
slots spec generation
adding to racks in batch mode, 466 analyzer stream spec, 856
creating, 467 complex analyzer spec, 841
SmartPlant Electrical data, 1031 functional requirement specs, 868
macro structure, 1031 hybrid case specs, 845
SmartPlant Instrumentation multi-tag specs (see list), 849
changing the logon password, 42 non-instrument specs, 867
general preferences, 44 prerequisites for non-instrument specs, 866
getting started, 39 principles, 781
navigating, 40 single-tag spec, 837
opening a module, 43 specs with tag cases, 844
opening another domain, 41 spec page graphics
overview, 34 adding lines, 802
searching for loops, 46 adding to spec page, 806
searching for tags, 46 common tasks, 801
starting, 40 defining line ID, 804
swtching to another unit, 42 duplicating lines, 805
SmartPlant Instrumentation Explorer modifying line length using arrow keys, 803

Index
modifying line length usng the mouse, 804 composite specs, 869
modifying position using arrow keys, 808 descriptions, 781
modifying position usng the mouse, 808 instrument composite spec, 871, 873
modifying size using arrow keys, 808 loop composite spec, 875
modifying size usng the mouse, 808 spec_note_large column, 796
selecting line color, 804 Specification Binder packages
selecting line style, 804 assigning spec sheets to, 953
selecting line thickness, 804 removing spec sheets from, 955
setting line X and Y coordinates, 803 specification reports
setting X and Y coordinates, 807 change notification, 975, 976
spec pages specification sheets
adding table columns, 816 generate a report, 415
adding to spec form, 826 generate specification sheet, 415
common tasks, 790 open, 410
customization common tasks, 809 specprn.psr, 930
customizing for Save as Excel, 912 specs
default tab order, 799 adding notes and remarks, 787
defining fields with computed values, 813 changing form assignment, 830
deleting, 795 changing form assignment in batch mode, 831
deleting columns, 818 deleting in batch mode, 787
displaying data field names, 793 generating in batch mode, 784
displaying invisible fields, 813 modifying custom title blocks, 883
duplicating data fields, 818 opening from Instrument Index Browser, 785
editing field headers, 812 opening from the Specifications module, 785
formatting column values, 815 overview, 780
large note page creation, 796 print sheet size, 780
listing forms using the page, 794 printing, 937
listing pages included in a form, 829 printing into .pdf files, 937
opening, 792 save options common tasks, 901
opening from external file, 793 specs (non-instrument)
overview, 789 generating, 867
regenerating, 794 generation prerequisites, 866
removing from spec form, 827 overview, 864
retrieving as .psr files, 800 specs (see list)
saving as files, 795 adding a single tag, 850
saving to database, 794 adding tags in batch mode, 851
selecting different process function, 798 changing columns header font, 853
setting field tab order, 799 changing format, 862
showing revision numbers in changed fields, 814 editing, 851
sorting within spec form, 828 finding tags, 852
spec revisions generating, 849
adding, 893 moving tags to another see list, 853
common tasks, 892 moving tags to single-tag spec, 854
comparing data with saved spec, 896 overview of see list formats, 857
comparing spec data with revision, 896 removing tags, 855
deleting, 893 resizing columns, 853
deleting in batch mode, 899 title block, 879
editing, 893 specs (single-tag)
managing globally, 894 editing field values, 838
overview, 891 editing units of measure, 838
showing revision numbers in changed fields, 814 generating, 837
storage methods, 898 moving tags from see list, 854
viewing and printing, 895 moving to see list spec, 840
viewing spec data history, 897 overview, 835
spec title block assignment methods, 878 saving in .isf format, 903
spec types saving in batch mode, 903

Index
specs (tag cases) overview, 56

common tasks, 843 Telecom, 65, 741
generating, 844 switches
generating hybrid case specs, 845 adding connectors, 765
overview, 842 adding to PABX racks, 764
Specs Default TB with PB Units.psr, 881 tab order in spec page
specs types setting field tab order, 799
multi-tag (see list) specs, 846 switching to default tab order, 799
non-instrument specs, 864 table columns
single-tag specs, 835 add_spec9 table, 796
tag case specs, 842 adding to spec page, 816
splice panels creating spec form browser fields, 828
creating, 754 displaying field names in spec page, 793
in Domain Explorer, 739 displaying invisible fields in spec page, 813
spur cables duplicating data fields in spec page, 818
creating, 672 editing spec page field headers, 812
example of segment-wide parameters, 653 formatting spec page field values, 815
standard browser view generating spec reports by field name, 935
creating CS tags, 556 spec_note_large, 796
creating device panels and cables, 479 with computed values in spec page, 813
standard positions (cable routing) tag case specs
adding, 616 common tasks, 843
deleting, 616 generating, 844
editing, 616 generating hybrid case specs, 845
maximum number of cables, 617 overview, 842
standard width (cable routing) tag data
adding, 616 editing tag data, 404
deleting, 616 tag edit
editing, 616 creating new loop, 341
style settings tag loop association
clearing a view setting, 289 common tasks, 377
creating a view, 286 overview, 377
displaying current style, 286 tag numbers, 348
duplicating views, 294 adding in the Process Data module, 1172
modifying, 289 adding remarks, 363
print layout, 292, 293 adding tag categories, 374
printing style setting, 295 assigning I/O, 411
sub-libraries associate new loop, 379
assigning hook-ups, 1075 associating external documents, 420
associating items, 1066 associating with function blocks, 664
associating pipe specs, 944 associating with hook-ups, 1074
creating, 1063 associating with Profibus DP segments, 712, 713
deleting, 1069 associating with Profibus PA segments, 712
displaying assigned pipe specs, 945 associating with segment, 668
dissociating items, 1067 change instrument type, 372
duplicating, 1063 change loop association, 379, 380
summary changing segment association, 669
loop summary, 417 common tasks, 354
supporting tables, 56, 57, 58, 65, 66, 605, 657, 741 copying, 364, 366
adding new values, 66 counting rows, 407
common tasks, 57 creating in Specifications module, 786
function blocks, 657 deleting, 367, 368
instrument type overview, 346 dissociating from hook-ups, 1078
intrinsic safety, 605 duplicating, 364, 366
list, 58 editing properties, 363, 406
open active column, 404 editing tag categories, 374

Index
fieldbus instruments common tasks, 659 overview, 736

finding all tags in a unit, 48 PA cabinets, 760
finding tags using search parameters, 49 PABX cabinets, 762
finding typical tags, 52 PABX racks, 763
Foundation Fieldbus instruments, 661 panels common tasks, 752, 757
HART instruments, 718 patch panels, 756
instrument type overview, 346 plug-and socket field devices, 750
instrument type profile defaults, 348, 350 splice panels, 754
list available numbers, 416 switch ports, 765, 766
moving multiple tags, 369 switches, 764
moving to another unit, 368 unassociated telephone numbers, 767
multiple tags, 378 Telecom Equipment folder in Domain Explorer, 218
multi-row mode editing, 406 telecom reports
naming, 360 actual load, 779
new, 357, 358 common tasks, 775
opening an external document, 421 communication line report, 776
overview, 354 field equipment, 778
power supply data, 361, 465 line numbers, 778
Profibus instruments, 661 signal levels, 779
remove external document, 421 speaker load, 777
renaming, 370 telecom device types, 778
renaming options, 371 telecommunication device lists, 777
search options, 47 telephone numbers
search options overview, 46 associating with channels, 768
sorting tag rows, 406 creating, 766
telecom field tags, 747 unassociated telephone numbers, 767
track field value changes, 409 templates
viewing associated documents, 421 creating for spec forms, 833
Tb_mss.psr, 881 form note, 960, 961, 962
Tb_ora.psr, 881 general specification note, 960
Tbsample.psr, 881 protecting spec fields from overwriting, 887
telecom spec form data templates, 832
amplifiers, 761 terminal strips
arrangement of items in Explorer, 739 common tasks, 512
associating telephone numbers, 768 creating, 518
cables, 751 defining terminal configurations, 513
cables common tasks, 744 modifying terminal configurations, 515
connectors, 762, 765 moving to another panel, 519
conventional field devices, 749 overview, 511
creating field tags, 747 terminal configuration examples, 516
creating telephone numbers, 766 terminals
device type profile defaults, 746 adding a group, 521
devices common tasks, 744 adding to terminal strips, 520
distribution frames, 755 associating with channels, 694
duplicating field tags, 748 configuration examples, 516
flow of activities, 737 defining configurations, 513
hub cabinets, 769 editing, 522
hub connectors, 771 modifying configurations, 515
hubs, 770 selecting a graphic, 523
instruments common tasks, 744 terminators
intercom cabinets, 772 common tasks, 678
intercom connectors, 774 external terminator in plug-and-socket box, 680
intercom equipment, 773 external terminator on terminal strip, 680
junction boxes, 753 in plug-and-socket boxes, 682
miscellaneous cabinets, 768 internal terminators, 681
old equipment, 743 moving external terminators to other ports, 681

Index
on terminal strips, 682 deleting typical loops, 391

overview, 678 duplicating, 387
test equipment editing properties, 390
managing, 1148 finding, 55
overview, 1152 typical loops and tags
selecting, 1152 common tasks, 382
Thermowell calculation, 1233 creating a typical loop, 385
title blocks naming convention, 393
assigning to spec form, 882 overview, 382
custom title block macros, 115 verifying data, 390
customization requirements, 115 typical tags
editing properties, 119 editing, 392
in composite specs, 878 editing properties, 391
macros, 1032 finding, 52
multi-tag specs, 879 UDF
overview of custom title blocks, 114 see custom fields, 115
spec title block assignment methods, 878 uniqueness
spec title block common tasks, 880 names of wiring items, 428
spec title blocks overview, 878 sequence of wiring items, 428
Tb_mss.psr, 882 unit
Tb_ora.psr, 882 moving loop to another unit, 335
Tbsample.psr, 882 units
title blocks (custom) opening another unit, 42
customizing in InfoMaker, 881 units of measure for process data
modifying for specs, 883 automatic conversion, 1204
updating for specs after upgrade, 883 copying defaults, 1204
title blocks of CAD loop drawings setting defaults, 1202
client and vendor approvals, 1015 upgrade
document references, 1014 updating custom title blocks for specs, 883
revisions, 1012 user-defined sub-libraries
track changes assigning hook-ups, 1075
field values, 409 associating items, 1066
tree view structure associating pipe specs, 944
in Domain Explorer, 218 creating, 1063
in Reference Explorer, 253 deleting, 1069
troubleshooting dissociating items, 1067
binder packages, 984 user-defined views
troubleshooting (Save as Excel) associating with specs, 817
common tasks, 920 validation
data saving problem, 923 fieldbus validation common tasks, 703
displaced labels, 925 for fieldbus, 701
display of select lists, 929 report for multiple segments, 704, 705
display of vertical fields, 928 report for one segment, 704
function conversion problems, 927 views (Browser)
grid line overlap problem, 923 adding a new view, 265
overshooting of grid lines, 924 changing instrument type, 411
preparing Excel file for Intergraph Support, 929 changing process function, 411
removing protection, 923 copying a view, 267
spec accessing problem, 922 default view, 263
text display in Excel cells, 927 defining a view, 264
truncation of labels and values, 925 deleting, 269
undershooting of grid lines, 924 duplicating a view, 265
value display precision, 928 finding, 270
typical loops hierarchy, 271
batch loop creation, 388 instrument index standard view, 403
copying, 387 modifing a profile, 267

Index
style settings, 284 signal propagation, 591

views in the Browser module splitting wiring design, 425
in Fieldbus Tag Numbers browser, 670 wiring and control system
virtual tags instrument type profile, 350
creating digital tags, 720 wiring diagrams
wires viewing point-to-point, 407
adding, 446 wiring equipment
applying regional colors, 451 associating I/O cards with I/O terminations, 502
assign designations, 539 common tasks, 487
connecting to terminal strips, 534 creating, 492
disconnecting, 536 custom fields in spec page, 819
editing, 449 customizing categories, 489
moving to other terminals, 535 displaying in panel-strip reports, 637
wiring I/O cards, 497
apparatus common tasks, 505 I/O terminations, 499
apparatus overview, 504 overview, 485
auto-wiring, 575 user-defined category properties, 491
connections, 524 work requests
creating a wiring scheme, 427 issuing a new work request, 1122
cross wiring, 564 opening, 1123
equipment, 485 workflow
general definitions, 430 implementing, 1171
intrinsic safety, 604 Workflow
item hierarchy examples, 494 example scenario, 95
item name uniqueness, 428 implementing, 98
item sequence uniqueness, 428 overview, 95
naming conventions, 430 prerequisites, 96
overview, 423 process data statuses, 100
principles, 424 Workflow browser view, 96
removing trailing separators, 431 ZIP files
reports common tasks, 635 binder package documents, 981

User’s Guide Supplementary Topics
Version 2007 (8.0) January 2007 DINS-08.00.0001A

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, ISOGEN, 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. Other brands and product names are trademarks of their respective
owners.
Table of Contents
Table of Contents
Preface...............................................................................................................................15
Working with SmartPlant Instrumentation: An Overview .........................................16

Getting Started Common Tasks..................................................................................17
Start SmartPlant Instrumentation ...................................................................................... 18
Navigating in SmartPlant Instrumentation........................................................................ 19
Open a Different Domain.................................................................................................. 20
Change the Logon Password............................................................................................. 21
Switch to a Different Unit................................................................................................. 22
Open a Module.................................................................................................................. 22
Setting General Preferences Common Tasks .............................................................23
Display and Customize Preferences.................................................................................. 23
Preferences Governed by the .INI File.............................................................................. 24
Searching for Tag and Loop Numbers ..........................................................................25

Searching for Tag and Loop Numbers Common Tasks .............................................26
Search for All Tag Numbers ............................................................................................. 27
Use Search Parameters to Find Tag Numbers .................................................................. 28
Search for Typical Tags .................................................................................................... 30
Search for All Loop Numbers........................................................................................... 31
Use Search Parameters to Find Loop Numbers ................................................................ 31
Search for Typical Loops.................................................................................................. 33
Supporting Tables............................................................................................................34
Supporting Tables Common Tasks.............................................................................35
Supporting Tables in SmartPlant Instrumentation ............................................................ 36
Supporting Tables for Telecom ........................................................................................ 43
Add a New Value to a Select List ..................................................................................... 45
Customize Manufacturer-Specific Field Headers ............................................................. 46
Manage a Custom Table ................................................................................................... 46
Interface Languages....................................................................................................47
Interface Languages Common Tasks..........................................................................48
Replace the Interface Language with a Language from the Database .............................. 49
Replace the Interface Language with a Language from an External File ......................... 50
Create a Language File with Customized Interface Text.................................................. 51
Edit Interface Text Phrases ............................................................................................... 53
Prefixes and Suffixes in the Interface Text....................................................................... 55
Revision Management .....................................................................................................56
Global Revisions...............................................................................................................57
Revision Management Common Tasks ......................................................................58
Filter Items for Global Revisions...................................................................................... 60

Table of Contents
Add Global Revisions ....................................................................................................... 61

Define Settings for Upgrading Revisions ......................................................................... 62
Update Revisions Globally ............................................................................................... 63
Upgrade Revisions Globally ............................................................................................. 64
Revision Upgrade Example .............................................................................................. 65
Delete Global Revisions ................................................................................................... 66
Add Local Revisions......................................................................................................... 67
Edit Local Revisions ......................................................................................................... 68
Delete Local Revisions ..................................................................................................... 68
View an Archived Revision .............................................................................................. 69
Report Comparison.....................................................................................................70
Setting Font and Color for Report Comparison..........................................................71
Set Font And Color for Report Comparison ..................................................................... 71
Comparing Archived Reports .....................................................................................72
Comparing the Current Report with an Archived Report...........................................73
Viewing Archived Reports .........................................................................................74
View an Archived Report ................................................................................................. 74
Displaying Changed Documents ................................................................................75
Display a List of Changed Documents ............................................................................. 75
Workflow....................................................................................................................76
Workflow Prerequisites ..............................................................................................77
Create a Workflow Browser ............................................................................................. 78
Implementing Workflow ............................................................................................79
Enter Initial Instrument Data ............................................................................................ 79
Enter Process Data for Instrument Tags ........................................................................... 80
Enter Additional Instrument Data ..................................................................................... 80
Process Data Statuses .................................................................................................81
Printing and Saving Documents .................................................................................82
Previewing Documents...............................................................................................83
Preview a Document ......................................................................................................... 84
Printing Documents ....................................................................................................85
Print Documents ............................................................................................................... 85
Batch Printing Documents to PDF Files.....................................................................86
Setting Ghostscript Batch Print Options.....................................................................87
Set the Ghostscript Batch Print Options ........................................................................... 87
Setting Acrobat Distiller Batch Print Options ............................................................88
Set the Acrobat Distiller Batch Print Options................................................................... 88
Modifying Printer Settings .........................................................................................89
Saving Documents ......................................................................................................90
Save the Current Document to a File ................................................................................ 90
Saving in DXF Format................................................................................................91
Save a Document in DXF Format..................................................................................... 91
Editing Document Headers.........................................................................................92
Edit the Headers for a Report............................................................................................ 92
Customizing Title Blocks for Reports ........................................................................93
Requirements for Customized Report Title Blocks....................................................94
Edit Report Title Block Properties.................................................................................... 98

Table of Contents
PSR Files ....................................................................................................................99

Viewing PSR Files....................................................................................................100
Retrieving PSR Files.................................................................................................101
Retrieve a Previously Saved PSR File ............................................................................ 101
Saving PSR File Data ...............................................................................................102
Opening PSR Files from the PSR List......................................................................103
Open a PSR File From the PSR List ............................................................................... 103
Managing the PSR File List......................................................................................104
Manage .Psr Files............................................................................................................ 104
Retrieving PBL File Reports ....................................................................................105
Retrieve a Report From a PBL File ................................................................................ 105
Adding User-Defined Fields to PSR Files................................................................106
Add User-Defined Fields to a PSR File (Using InfoMaker)........................................... 106
Viewing PSR User-Defined Fields...........................................................................108
View PSR User-Defined Fields in a Report Header ....................................................... 108
SmartPlant Instrumentation and InfoMaker .............................................................109
Defining InfoMaker as the Default Report Generator..............................................110
Define InfoMaker As the Default Report Generator ...................................................... 110
SmartPlant Instrumentation Database Structure.......................................................111
Building a Query.......................................................................................................113
Build a Query.................................................................................................................. 113
Creating a SmartPlant Instrumentation Database Profile .........................................115
Create a SmartPlant Instrumentation Database Profile................................................... 115
Using SmartPlant Instrumentation with InfoMaker..................................................117

Working with InfoMaker Libraries and Reports Common Tasks ............................117
Create an InfoMaker Library and Report for Editing PSR Files .................................... 117
Open a PSR File From an InfoMaker Library And Report............................................. 118
Creating an InfoMaker Library.................................................................................119
Create an InfoMaker Library .......................................................................................... 119
Saving an InfoMaker Customized Report ................................................................120
Save a Customized Report .............................................................................................. 120
Create a New Browser for SmartPlant Instrumentation.................................................. 120
SmartPlant Instrumentation and MicroStation..........................................................122

Overview...................................................................................................................122
System Requirements ...............................................................................................123
MicroStation Settings ...............................................................................................124
Define MicroStation Settings.......................................................................................... 125
Setting the SmartPlant Instrumentation Parameters for MicroStation SE/J .............127
Enable MicroStation SE/J to Work With Long File Paths.............................................. 127
Creating Tag Sets......................................................................................................128
Create Tag Sets ............................................................................................................... 128
Exporting Tag Sets ...................................................................................................130
Export Tag Sets............................................................................................................... 130
Importing Tag Sets ...................................................................................................131
Import a Tag Set ............................................................................................................. 131

Table of Contents
Linking a Tag to a Drawing Element .......................................................................132

Link a Tag to a Drawing Element................................................................................... 132
Creating a Cell Library .............................................................................................133
Create a Cell Library....................................................................................................... 133
Fencing Elements for a Cell .....................................................................................134
Fence Elements for a Cell ............................................................................................... 134
Defining the Cell Origin ...........................................................................................135
Define the Cell Origin..................................................................................................... 135
Defining the Coordinates of the Cell Origin.............................................................136
Define the Cell Origin Coordinates ................................................................................ 136
Add a Cell to the Cell Library......................................................................................... 136
Previewing a Cell......................................................................................................137
Preview a Cell ................................................................................................................. 137
Displaying a Cell on the Desktop .............................................................................138
Display a Cell on the Desktop ........................................................................................ 138
Generating a Report Using MicroStation .................................................................139
Import Utility .................................................................................................................140

Overview...................................................................................................................140
Database Platform Support .......................................................................................141
Import Prerequisites..................................................................................................142
Data Import Process..................................................................................................143
Matching Naming Conventions................................................................................145
Starting the Import Utility ........................................................................................146
Running an Import Session Using Command-Line Parameters ...............................147
Start a Command-Line Import Session........................................................................... 147
Running an Import Session from the User Interface ................................................149
Start the Import User Interface ....................................................................................... 149
Working with Log Files............................................................................................150
Creating a New Log File...........................................................................................151
Create a New Log File .................................................................................................... 151
Opening an Existing Log File...................................................................................152
Open an Existing Log File .............................................................................................. 152
Viewing a Log File ...................................................................................................153
View the Current Log File .............................................................................................. 153
Checking the Name of the Current Log File ............................................................154
Check the Name of the Current Log File........................................................................ 154
Closing the Current Log File ....................................................................................155
Close the Current Log File.............................................................................................. 155
Deleting an Existing Log File...................................................................................156
Delete an Existing Log File ............................................................................................ 156
Logging the Import Parameters ................................................................................157
Log the Import Parameters.............................................................................................. 157
Creating a New Link.................................................................................................158
Creating a New Link for the ODBC Platform ..........................................................159
Create a New Link (ODBC) With a Database As the Source Data ................................ 159
Selecting dBase / Text Files as the Source Profile ...................................................161
Create a New Link (ODBC) With Dbase / Text Files As the Source Data..................... 162

Table of Contents
Creating a New Link for Platforms other than ODBC .............................................163

Create a New Link (Other Platforms Than ODBC)........................................................ 163
Using the Link Explorer Window.............................................................................165
Changing Link Source Paths ....................................................................................167
Change the Source Path of an Existing Link .................................................................. 167
Specify a New Default Folder for All Links................................................................... 167
Moving Links Between Databases or Domains........................................................168
Exporting Links ........................................................................................................169
Export a Group of Links ................................................................................................. 169
Importing Links ........................................................................................................170
Import a Group of Links ................................................................................................. 170
Setting the Properties for a Link...............................................................................171
Setting General Parameters.......................................................................................172
Creating Complementary Elements (Import to Table) .............................................174
Setting the Import Mode Parameters ........................................................................175
Set the Import Mode Parameters for Identical Source And Target Rows....................... 175
Setting the Refresh Parameters.................................................................................177
Refresh Previously Imported Data.................................................................................. 177
Filtering the Source Data ..........................................................................................179
Specify a Filtering Condition.......................................................................................... 179
Importing Data into Additional Plant Hierarchy Items ............................................181
Import Data Into an Additional Plant Hierarchy Item .................................................... 183
Setting the Import Mode Parameters ........................................................................184
Set the Import Mode Parameters for Identical Source And Target Rows....................... 184
Setting the Tag / Loop Parameters............................................................................186
Set the Tag/Loop Parameters .......................................................................................... 186
Setting Custom Parameters (Import to Module Only)..............................................188
Set Custom Parameters ................................................................................................... 188
Setting the Specification Sheet Parameters (Import to Specifications Module
Only) .........................................................................................................................190
Set the Specification Sheet Parameters........................................................................... 190
Setting the Style Parameters (Import to Module) .....................................................191
Set the Style Import Parameters in the Import to Module Mode .................................... 191
Setting the Style Parameters (Import to Table) ........................................................192
Set the Style Import Parameters in the Import to Table Mode ....................................... 192
Link Definitions........................................................................................................193
Defining the Naming Convention Structure .............................................................194
Define Links for Naming Conventions........................................................................... 194
Configuring Source Data for Variable Length Data Fields ......................................196
Primary Keys ............................................................................................................197
Opening Import Links...............................................................................................199
Open Import Links.......................................................................................................... 199
Mapping Source and Target Data .............................................................................200
Define the Import Mapping ............................................................................................ 200
Using Formulas and Arithmetic Functions in Import Links.....................................203
Working with Reference Tables ...............................................................................205
Select the Reference Tables ............................................................................................ 205
Executing the Import of Data ...................................................................................206

Table of Contents
Execute the Import of Data ............................................................................................. 207

Testing the Import Process .......................................................................................208
Test the Import Process................................................................................................... 208
Import Comparison...................................................................................................209
Run the Comparison List ................................................................................................ 210
Setting the Import Comparison List Options............................................................211
Setting the Target Table Definitions: An Overview.................................................212
Modifying Table Column Definitions ......................................................................215
Modify Table Column Definitions.................................................................................. 215
Modifying Table Column Definitions - Table Definitions Note ..............................219
Modifying Table Column Definitions - Column Colors Note..................................220
Modifying Table Column Definitions - Column Status Note ..................................221
Modifying Table Column Definitions - Key Note ...................................................222
Modifying Table Column Definitions - Key Caution...............................................223
Modifying Table Column Definitions - Numbering System Note ...........................224
Modifying Table Column Definitions - Key Level Note .........................................225
Deleting Table Column Key Definitions..................................................................226
Delete Table Column Key Definitions............................................................................ 226
Viewing the Source and Target Rows ......................................................................227
View the Source And Target Rows ................................................................................ 227
Filtering the Displayed Target Rows........................................................................228
Filter the Displayed Target Rows ................................................................................... 228
Printing the Import Comparison List........................................................................229
Preview And Print Out the Source And Target Rows .................................................... 229
Viewing the Source Data ..........................................................................................230
View the Source Data ..................................................................................................... 230
Displaying the Source Data Fields ...........................................................................231
Select the Desired Viewing Option................................................................................. 231
Sorting the Displayed Source Rows .........................................................................232
Sort the Displayed Source Rows..................................................................................... 232
Filtering the Displayed Source Rows .......................................................................233
Filter the Displayed Source Data Fields ......................................................................... 233
Associating Imported Tag Numbers with the Correct Instrument Type
Descriptions ..............................................................................................................234
Associate Tag Numbers With the Correct Instrument Type Descriptions...................... 235
Associating Additional Source Data.........................................................................236
Associate Additional Data to the Source Table / Database File ..................................... 236
Associating Source Tags with Instrument Types .....................................................238
Associate Source Tags With Instrument Types .............................................................. 238
Guidelines for Selecting Source Data Fields ............................................................240
Define And Associate Source Instrument Type And Instrument Type Description
Data Fields ...................................................................................................................... 240
Moving Data .............................................................................................................242
Move Previously Imported Data ..................................................................................... 242
Deleting Data ............................................................................................................243
Delete Previously Imported Data.................................................................................... 243
Link Groups ..............................................................................................................244
Creating a New Link Group .....................................................................................245

Table of Contents
Create a New Group And Associate Links With It......................................................... 245

Dissociating Links from a Group .............................................................................246
Dissociate Links From a Group ...................................................................................... 246
Moving and Copying Links ......................................................................................247
Move a Link to Another Group ...................................................................................... 247
Copy a Link to Another Group ....................................................................................... 247
Deleting Links ..........................................................................................................248
Delete Links .................................................................................................................... 248
Renaming Groups and Links ....................................................................................249
Rename a Group Or a Link............................................................................................. 249
System Codes............................................................................................................250
Defining Source Systems..........................................................................................251
Define Source Systems ................................................................................................... 251
Adapting Source Codes ............................................................................................252
Adapt System Codes ....................................................................................................... 252
Adapt UOM Codes ......................................................................................................... 254
Adapting UOM Codes - Special Characters.............................................................255
Importing Codes .......................................................................................................256
Import Codes................................................................................................................... 256
Exporting Codes .......................................................................................................257
Export Codes................................................................................................................... 257
Viewing the Current Source System Name ..............................................................258
View the Currently Selected Source System Name........................................................ 258
Using Source Codes in an Import Link ....................................................................259
Use Source Codes in an Import Link .............................................................................. 259
Defining Tables in Excel Spreadsheets ....................................................................262
Define A Table In Excel ................................................................................................. 262
SmartPlant Electrical Interface....................................................................................289

Prerequisites for Working with the SmartPlant Electrical Interface ........................290
Flow of Activities for Creating Control Systems .....................................................292
Retrieve SmartPlant Electrical Data .........................................................................294
Viewing Electrical Tag Numbers .............................................................................295
Create Wiring Items for SmartPlant Electrical Signals ............................................297
Create a Device Panel for an Electrical Tag.............................................................298
Create a Local Signal for Electrical Tags .................................................................299
Flow of Activities for Defining Power Supplies ......................................................300
Publish Data for SmartPlant Electrical .....................................................................302
DCS Vendor Interfaces..................................................................................................303

Prerequisites for Working with DCS Vendor Interfaces ..........................................304
Flow of Activities for Configuring DeltaV ..............................................................306
Flow of Activities for Configuring Yokogawa CENTUM CS 3000........................308
Download DeltaV Definitions ........................................................................................ 310
Retrieve DeltaV Definitions ........................................................................................... 311
Retrieve Yokogawa CENTUM CS 3000 Definitions ..................................................... 312
Retrieve Honeywell Definitions ..................................................................................... 313

Table of Contents
Retrieve ABB Definitions............................................................................................... 314

Crucial Fields for the DeltaV Interface........................................................................... 315
Data Limitations for the Yokogawa CENTUM CS 3000 Interface ................................ 319
Publishing Data for DCS Vendors.................................................................................. 321
Publish Data for DeltaV.................................................................................................. 322
Publish Data for Yokogawa CENTUM CS 3000 ........................................................... 323
View the Log File for a DCS Vendor ............................................................................. 324
View DCS Vendor Items in SmartPlant Instrumentation ............................................... 324
Create Compatible Wiring Items for DCS Vendors in SmartPlant Instrumentation ...... 325
SmartPlant Instrumentation - DCS Vendors: Comparative Terminology ...................... 326
Associate Foundation Fieldbus Device Types for DCS Vendors.............................327
Fluke Interface ...............................................................................................................329

SmartPlant Electrical Interface ....................................................................................... 330
DeltaV Interface.............................................................................................................. 330
Retrieve DeltaV Definitions ........................................................................................... 331
Plant Controller Selection ............................................................................................... 332
Yokogawa CENTUM CS 3000 Interface ....................................................................... 332
Retrieve Yokogawa CENTUM CS 3000 Definitions ..................................................... 333
Plant DCS Panel Selection.............................................................................................. 334
Retrieve Honeywell Definitions ..................................................................................... 335
Retrieve ABB Definitions............................................................................................... 336
Associate Foundation Fieldbus Device Types with Instrument Type ............................ 337
Working with SmartPlant Integration.........................................................................338
Setting Up SmartPlant Instrumentation for an Integrated Environment................340

Integrating SmartPlant Instrumentation with SmartPlant P&ID ..............................341
Integrating SmartPlant Instrumentation with SmartPlant Electrical ........................343
Naming Convention Requirements when Publishing and Retrieving Items ............345
Instrument Retrieval........................................................................................................ 345
Loop Retrieval ................................................................................................................ 346
Instrument Publishing ..................................................................................................... 347
Loop Publishing .............................................................................................................. 348
Document Publish and Retrieve Matrix ...................................................................351
Updating SmartPlant Information in Title Blocks .....................................................353

Updating SmartPlant Information in Title Blocks: Flow of Activities.....................354
Title Block Requirements for Integration Reports ...................................................355
PowerSoft Reports .......................................................................................................... 356
Enhanced Reports ........................................................................................................... 357
Associating a Custom Title Block with SmartPlant Instrumentation ............................. 358
Open a Custom Title Block............................................................................................. 358
Configuring the PDF Generator................................................................................360
Configure the Generic PostScript Printer........................................................................ 360
Configure Adobe Acrobat Distiller 7.............................................................................. 363
Test the PostScript Printer Configuration ....................................................................... 364
Test the Acrobat Distiller Driver Configuration ............................................................. 366

Table of Contents
Install the Update Title Block Component for SmartPlant Instrumentation................... 368
Define PDF Generation Settings..................................................................................... 369
Run the Update Title Block Add-In................................................................................ 370
Schema Mapping............................................................................................................371
General Information About Schema Mapping .........................................................372
Upgrading the SmartPlant Instrumentation Tool Schema for a New Software
Version......................................................................................................................374
Upgrade the SmartPlant Instrumentation Tool Schema.................................................. 374
Workflow for Extending the Schema .......................................................................375
Modify the Tool Schema for a Custom Plant Hierarchy................................................. 377
Synchronizing Schemas............................................................................................383
Synchronize the Map Schema File with the Tool Schema ............................................. 383
Define a Schema for SmartPlant Instrumentation........................................................... 388
Export a New Schema Configuration ............................................................................. 390
Define and Map DDP Data ............................................................................................. 391
Welcome to the SmartPlant Instrumentation Schema Configuration Wizard................. 392
Select Domain................................................................................................................. 392
Schema Options .............................................................................................................. 392
Define New Schema Configuration ................................................................................ 392
Select Schema ................................................................................................................. 392
Select Document Type.................................................................................................... 393
Select Object Types ........................................................................................................ 393
Define Object Levels and Restrictions............................................................................ 393
Define Filter Condition ................................................................................................... 393
Select Object Interfaces .................................................................................................. 393
Select Interface Properties .............................................................................................. 394
Completing the Schema Configuration Wizard .............................................................. 394
Export Schema Configuration Utility.......................................................................395
Publishing in an Integrated Environment .................................................................396
Publish Documents from SmartPlant Instrumentation.................................................... 399
Find Documents to Publish from SmartPlant Instrumentation ....................................... 402
Select Document Types (Document Selection Wizard).................................................. 403
Select Plant Group (Document Selection Wizard) ......................................................... 404
Select Instrument Process Data Sheets (Document Selection Wizard)........................... 404
Select Instrument Specification Sheets (Document Selection Wizard) .......................... 406
Select Enhanced SmartLoop Reports (Document Selection Wizard)............................. 407
Select Wiring Reports (Document Selection Wizard) .................................................... 408
Select Dimensional Data Sheets (Document Selection Wizard)..................................... 409
Document Selection Summary (Document Selection Wizard)....................................... 410
List of Publishable Dimensional Groups ........................................................................ 411
Revising Documents in an Integrated Environment ..................................................414

Revise a Document ...................................................................................................415
Retrieving in an Integrated Environment .................................................................417
Retrieve Documents to SmartPlant Instrumentation....................................................... 420
Using the To Do List ................................................................................................423
To Do List Common Tasks.......................................................................................425
Set Preferences for the To Do List.................................................................................. 426

Table of Contents
Open the To Do List ....................................................................................................... 426

Modify To Do List Task Properties ................................................................................ 427
Run a Task from the To Do List ..................................................................................... 427
Task Dependencies ......................................................................................................... 428
Complete a Task from the To Do List ............................................................................ 429
Sort Tasks in the To Do List ........................................................................................... 429
Filter Tasks in the To Do List ......................................................................................... 429
Defer a Task from the To Do List................................................................................... 430
Remove a Task from the To Do List .............................................................................. 430
Display Deleted Tasks in the To Do List........................................................................ 431
Run a To Do List Report................................................................................................. 431
Update the To Do List Display ....................................................................................... 431
Merger Utility.................................................................................................................432
Overview...................................................................................................................432
Database Platform Support .......................................................................................433
Starting the Merger Utility........................................................................................434
Start the Merger Utility................................................................................................... 434
Working with Log Files............................................................................................435
Creating a New Log File...........................................................................................436
Create a New Log File .................................................................................................... 436
Opening an Existing Log File...................................................................................437
Open an Existing Log File .............................................................................................. 437
Viewing a Log File ...................................................................................................438
View the Current Log File .............................................................................................. 438
Closing the Current Log File ....................................................................................439
Close the Current Log File.............................................................................................. 439
Deleting an Existing Log File...................................................................................440
Delete an Existing Log File ............................................................................................ 440
Setting the Merger Comparison Criteria...................................................................441
Merging Data ............................................................................................................442
Selecting the Target ..................................................................................................444
Select the Target Item ..................................................................................................... 444
Creating a New Merger Session ...............................................................................445
Create a New Merger Session......................................................................................... 445
Opening a Merger Session........................................................................................446
Open a Merger Session ................................................................................................... 446
Renaming a Merger Session .....................................................................................447
Rename a Merger Session............................................................................................... 447
Duplicating a Merger Session...................................................................................448
Duplicate a Merger Session ............................................................................................ 448
Deleting a Merger Session........................................................................................449
Delete a Merger Session ................................................................................................. 449
Selecting the Source Domain....................................................................................450
Selecting the Same Source Domain as the Target Domain ......................................451
Select the Same Source Domain As the Target Domain................................................. 451
Selecting a Source Domain from the Same Database as the Target Domain
(ODBC......................................................................................................................452

Table of Contents
Select a Source Domain From the Same Database As the Target Domain..................... 452
Selecting a Source Domain from a Database Platform Other than ODBC ..............454
Select a Source Domain From a Database Other Than ODBC....................................... 455
Matching Source and Target Projects.......................................................................456
Match the Target Projects to the Source Projects ........................................................... 456
Matching the Source Data with the Target Data ......................................................457
Match the Target Data With the Source Data ................................................................. 457
Matching Source and Target Naming Conventions..................................................458
Match Source And Target Naming Conventions............................................................ 458
Defining Merger Utility Settings ..............................................................................460
Define Merger Utility Settings........................................................................................ 460
Selecting the Source Modules ..................................................................................462
Select the Source Modules and Module Data ................................................................. 462
Selecting the Source Tables......................................................................................464
Select the Source Tables to Be Merged .......................................................................... 465
Selecting Item Types to Merge.................................................................................466
Select the Source Item Types to Merge .......................................................................... 466
Specifying an Insertion Condition ............................................................................467
Specify an Insertion Condition ....................................................................................... 467
Filtering and Sorting the Displayed Source Table List ............................................471
Filter And Sort the Displayed Source Table List............................................................ 471
Selecting Source Data Using the Comparison List...................................................472
Defining Comparison List Options...........................................................................473
Define Comparison List Options .................................................................................... 474
Defining a Comparison List Style ............................................................................475
Define a Comparison List Style...................................................................................... 475
Comparing Data........................................................................................................477
Compare Source And Target Data .................................................................................. 477
Working in Group Mode ..........................................................................................479
Compare Data Using Group Mode ................................................................................. 479
Running the Comparison List in Multi-Sessions......................................................482
Analyzing Comparison Reports................................................................................484
Checking for Duplicate Items...................................................................................486
Check for Duplicate Items .............................................................................................. 486
Restoring Saved PSR Files .......................................................................................488
Restore a Previously Saved .Psr File .............................................................................. 488
Making Individual Item Type Selections .................................................................489
Merging Supporting Tables ......................................................................................490
Guidelines for Selecting Item Types and Defining Merger Settings........................491
Merging Jumpers and Cross Wires...........................................................................500
Merging Specification Forms that Include Custom Title Blocks .............................501
Customizing the Comparison List Display...............................................................502
Filtering the Comparison List Data ..........................................................................503
Filter the Comparison List Data...................................................................................... 503
Displaying Specific Columns ...................................................................................504
Display Specific Data Columns in the Comparison List ................................................ 504
Sorting the Comparison List Data ............................................................................505
Sort the Comparison List Data........................................................................................ 505

Table of Contents
Displaying a Comparison List for a Child Item Type ..............................................506

Display the Comparison List for a Child Item Type....................................................... 506
Monitoring the Transfer Process ..............................................................................507
Start the Transfer Process ............................................................................................... 507
Preliminary Configuration ........................................................................................508
Perform A Preliminary Configuration ............................................................................ 508
Post Merging Actions ...............................................................................................510
Configuring Your Environment................................................................................511
Naming Convention Rules........................................................................................512
Index................................................................................................................................514

Preface
Preface
This user's guide describes concepts, procedures, and interface features of SmartPlant
Instrumentation.
Send documentation comments or suggestions to [email protected].

5

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

The following general tasks are used when getting started:

This procedure explains how to log on to SmartPlant Instrumentation. where to select
the required domain and if the domain type is Operating owner, 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 18.

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 20.

This option allows you to change the password that you use when logging on to
SmartPlant Instrumentation. For more information, see Change the Logon Password,
page 21.

This option makes it possible to switch from the current <unit> to another <unit>.
For more information, see Switch to a Different Unit, page 22.
Open a Module
You can open any SmartPlant Instrumentation 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 22.


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 and where the domain type is Operating owner, 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.
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

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 20
• Switch to a Different Unit, page 22


3. On the Open dialog box, select a domain .
4. If the project icon appears (only when the domain type is Operating owner),
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>.

• Click the <unit> once to highlight it, then click OK.
Related Topics


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.
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


3. On the Open dialog box, expand the <plant> and <area> hierarchies and navigate
to the <unit> you require.

• Click the <unit> once to highlight it, and then click OK.
Related Topics
Open a Module
1. Start SmartPlant Instrumentation.
• Click the appropriate toolbar icon for the module you want to open.
• On the Modules menu, click a desired module name.
Related Topics

Setting General Preferences Common Tasks

The following tasks are used frequently when setting general preferences:

project, if the domain type is Operating owner. For more information, see Display
and Customize Preferences, page 23.

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 24.

Important
• Certain interface options are governed by the INTOOLS.INI file. For more
information, see Preferences Governed by the .INI File, page 24.
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


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. This only applies to
a small number of windows and dialog boxes.
The 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. The
next time you start SmartPlant Instrumentation and display the Open dialog box, the
software displays the <unit> you selected last.
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.
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>.
Suppression of Loop Equipment Propagation to Tag Numbers by Default —

associate with the loop. To do so, open the INTOOLS.INI file, and under the [Index]
Related Topics


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, in
the SmartPlant Instrumentation main user’s guide.
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

Searching for Tag and Loop Numbers Common

Tasks
The following tasks are used frequently when searching for tag or loop 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 27.

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 30.

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
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.
search parameters in the Search results data window.
For more information, see Use Search Parameters to Find Tag Numbers, page 28.

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 31.

This help topic explains how to find loop numbers by entering search parameters.
Entering search parameters in the Find Loop dialog box enables you to narrow down
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 31.

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 33.
Related Topics

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
3. Select the required tag numbers in the Search results data window and click OK.
Related Topics


Important
• To specify search parameters in the Calibration module, you need to
perform a separate procedure. For details, see Search for Tags in the
Calibration Module.
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:
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
Number Type the numeric segment of a tag number to 2315
find all the tag numbers that have this numeric
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)
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

5. In the Search results data window, do one of the following:

• Select the desired tag number.
• 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

Important
• This option is available 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
5. Select the desired tag numbers in the Search results data window and click OK.
Related Topics


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.
3. Select the required loop numbers in the Search results data window and click
OK.
Related Topics

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:
Parameter
Loop name Type the whole loop number you are looking 101F -2225\A
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
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)
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.
display more loop rows. Clear this check box to return to normal
view.
5. Click OK.
Related Topics


You perform the search in the Instrument Index module.
Using the Typical Loop Management dialog box:
• Click Edit > Typical Loop Management.

Using the Batch Loop Creation dialog box:
2. Click Find.
3. In the Find Typical Loop dialog box, do not enter any search parameters and
click Find.
In the Find Tag dialog box:
1. From the Tag class list, select Typical.
2. Click Find and select a tag number.
3. In the Typical Tag Number Properties dialog box, click Associate.
4. In the Find Loop dialog box, click Find to list all the available typical loops in
the Search results data window.
Related Topics

Supporting Tables
Supporting Tables
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 36.
For details about the various activities that you can perform with the supporting
tables, see Supporting Tables Common Tasks, page 35.
Related Topics

Supporting Tables
Supporting Tables Common Tasks

The following tasks are used frequently when managing supporting tables.

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 45.

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 46.

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 46.
Related Topics
• Supporting Tables in SmartPlant Instrumentation, page 36

Supporting Tables
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.

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.

Supporting Tables
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.
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

Supporting Tables
Frequency This supporting table holds frequency values that you can use in
the Frequency list on the Power Supply tab of the Tag Number
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
Linearity Types This supporting table holds linearity type values that are used to
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.
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.

Supporting Tables
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
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
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.
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.

Supporting Tables
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 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
Wire Types Allows you to manage the contents of the Type list on the Wire
Wire Colors Allows you to manage the contents of the Color list on the Wire
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.

Supporting Tables
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.
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.

Supporting Tables
Pulling Areas Allows you to define the pulling areas in your <plant>. The
pulling area in the <plant> 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 <plant>
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
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 35.
• For the explanation of instrument types and their functionalities, see
Working with Instrument Types: An Overview in the SmartPlant
Instrumentation main user’s guide..
• For the supporting tables used in Telecom, see Supporting Tables for
Telecom, page 43.
Related Topics

Supporting Tables

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
Statuses
Telephone Allows you to manage the contents of the Telephone number usages
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

Supporting Tables
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 35.
Related Topics

Supporting Tables

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

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.
5. Repeat steps 3 and 4 as many times as you require.
6. Click OK.
Related Topics

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
Interface Languages
You can replace the SmartPlant Instrumentation interface language. The System
Administrator must first add languages to the database. You can purchase each
language as a separate add-in. 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
• German
• Custom
After the appropriate interface language is added, you can do the following:
• Replace the existing interface language with the imported language.

• Edit interface text phrases.
• Define new phrases to replace existing ones.

Supporting Tables
Interface Languages Common Tasks

The following tasks are used frequently when working with interface languages:
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 49.
Replace the Interface Language with a Language from an External File

Use this procedure 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, a change that improves the performance. For
more information, see Replace the Interface Language with a Language from an
External File, page 50.

An external language file enables you to replace the text in the current interface with
your customized text. To create customized phrases, you use a special interface
language called Custom. After switching to the custom language, all the phrases in
this column replace the original phrases of the interface language without overwriting
them. Empty fields in this column do not affect the original phrases. This way you
can always revert to the original phrases of the interface language. For more
information, see Create a Language File with Customized Interface Text, page 51.

This procedure allows you to change the interface text by editing its phrases. At this
stage, you change the phrases of the interface language, as described in the overview.
Note that the interface text changes take effect only after exiting and re-entering the
application. For more information, see Edit Interface Text Phrases, page 53.

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 55.
Related Topics

Supporting Tables
Replace the Interface Language with a Language from the

Database
3. In the Select Language dialog box, do one of the following:
• From the Language data window, select the language with which you
want to replace the current interface language.
• Click Default to revert the language to the default language (English).
• 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.
Related Topics

Supporting Tables
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.
3. Select Optimize speed.
4. Select Use file to retrieve the interface text from a previously saved file (saved in
.psr format), and 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.
5. 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.
Related Topics

Supporting Tables

Important
database.
• The interface text changes take effect only after exiting and re-entering the
application.
text.
4. In the Custom Phrase column, type the phrases you want.
Tips
• The column header Custom Phrase changes to German Phrase if
you imported the German language, and to French Phrase if you
imported the French language.
• In the Custom Phrase column, each phrase that you type replaces the
corresponding phrase in the interface text. If you leave a field blank,
the corresponding field in the interface text remains unchanged. Make
sure that you add the same prefixes, suffixes and punctuation marks
that appear in the corresponding original phrases of that interface
language for example, ~, &. For details, see Prefixes and
Suffixes in the Interface Text, page 55.
5. To view the changes, switch to the appropriate language. For details, see Replace
the Interface Language with a Language from the Database, page 49.
Tip
.psr extension).
language file.

Supporting Tables
box.
10. Click Close.
Related Topics

Supporting Tables

Important
database. You can purchase a language that you require as a separate add-
in.
• If you edit the phrases of an interface language that you have previously
imported, you will not be able to revert to the imported interface language.
• When editing, make sure that you fill all the fields in the appropriate
column. If you have a field blank, the phrase from the previous interface
language remains after you switch the currently displayed language to the
language that you are editing now. This can result in your interface text
containing phrases or terms in more than one language.
text.
4. Edit the text by clicking the text in the appropriate field.
Tip
• You can modify the column sequence, for example, you can compare
phrases more easily by moving two columns closer together. Drag a
column header and drop it in the desired location. Then, 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.
5. To view the changes, replace the active language with the language that you have
edited. For details, see Replace the Interface Language with a Language from the
Database, page 49.
Tip
.psr extension).
language file.

Supporting Tables
box.
10. Click Close.
Related Topics

Supporting Tables

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 MS Word). It is text]
usually used in conjunction
with ~n.
~t Adds a tab entry. [interface &Action~tCtrl+A
text]~t[interface
text]
Related Topics

Revision Management
Revision Management
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 Report Utility report generated
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. For more information about using revisions in an
integrated environment, see Revising Documents in an Integrated Environment: An
Overview, page 414.
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.

Global Revisions
Global Revisions
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.
Related Topics

Global Revisions
Revision Management Common Tasks

The following tasks are used frequently when managing global and local revisions:

This option enables you to add a global revision to items that belong to any of the
Ups, Wiring, and Dimensional Data. For more information, see Add Global
Revisions, page 61.

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 62.

You can update the existing revision values globally for the items used in the
Ups, Wiring, and Dimensional Data. For more information, see Update Revisions
Globally, page 63.

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

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 66.

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 60.
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

Global Revisions
to define the setting as either Per document or Per Item . For more information, see
Add Local Revisions, page 67.

Use this procedure to edit existing local revisions. For more information, see Edit
Local Revisions, page 68.

Use this procedure to delete existing local revisions. For more information, see
Delete Local Revisions, page 68.
Related Topics

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
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. Click Refresh to update the data window as needed.
7. Click Apply.
Related Topics

Global Revisions

Global Revisions.
select Add revision.
Tips
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:
window.
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.
Related Topics

Global Revisions

2. On the Settings tab, from the Activity list, select Upgrade revision.
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,…
6. Click the appropriate module tab to apply the defined settings. For details, see
Tips

Global Revisions

2. On the Settings tab, from the Activity list, select Update revision.
Tips
7. In the data window, do one of the following to select the items whose revisions
you want to update:
window.
mode.
9. If you want to update revisions for other modules, repeat the appropriate steps for
each module.
Related Topics

Global Revisions

1. Define the settings for upgrading revisions globally. For details, see Define
Settings for Upgrading Revisions, page 62.
2. Select the desired module tab and filter the items as needed. For details, see
Filter Items for Global Revisions, page 60.
4. In the data window, do one of the following to select the items for which you
want to upgrade revisions:
window.
mode.
6. If you want to upgrade revisions for other modules, repeat the appropriate steps
for each module.
Related Topics

Global Revisions
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
• Upgrade Revisions Globally, page 64

Global Revisions

Global Revisions.
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 .
Tips
5. In the data window, do one of the following to select the required items:
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
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).
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.
Tips
• 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. To learn more about
custom title blocks, see Customizing Title Blocks for Reports: An
Overview, page 93.
Related Topics
• View an Archived Revision, page 69

Global 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:
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
3. Make changes for other revisions as desired.

4. Click OK to apply your changes.
Related Topics

1. On the Revisions dialog box, select the revision that you want to delete.
2. Click Delete.
Related Topics

Global Revisions
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
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

Global Revisions
Report Comparison
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.
comparison.
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
73.
• Compare two archived reports. For details, see Comparing Archived
Reports, page 72.
Related Topics
• Viewing Archived Reports, page 74

Global Revisions
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

Global Revisions
Comparing Archived Reports

This option enables you to compare between two archived reports.

Report

• 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
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 71
Related Topics
• Comparing the Current Report with an Archived Report, page 73

Global Revisions
Comparing the Current Report with an Archived

Report
The option enables you to compare the currently previewed report with an archived
report.

Report
• 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
revision number in the Revision filter box and select Activate.
5. Click OK to reopen the Print Preview window.
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 71
• .
Related Topics

Global Revisions
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

• 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
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

Global Revisions
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.

Global Revisions
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

Global Revisions
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
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. For details, see Regenerate
Library Forms.
Related Topics

Global Revisions

1.
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
77.
2. Open the Browser Manager.
3. Under Browser groups, double-click Workflow to expand the hierarchy.
4. Select the Instrumentation/Process Data Browser and create a new view.
5. Double-click the view to expand the hierarchy.
6. Click , and in the Style settings section, click Edit.
7. 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.
8. Click Save.
9. 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 81
Related Topics

Global Revisions
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

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.

Global Revisions
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.
Enter Additional Instrument Data

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

Global Revisions
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:

Process Data Tags that do not require process data and Set and changed by
not Required therefore are not available to the process instrument engineers
engineering group.
Process Data Tags available for process data entry by Set by instrument
Required the process engineering group (in the engineers Can be changed
Process Data module or Browser). 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

Global Revisions
Printing and Saving Documents

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

Global Revisions
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.

Global Revisions
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.
5. In the case of reports consisting of several pages or multiple reports, navigate
using the following options:
Click… …or on the …to do this:
View 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 scroller. 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
On the View Browse to the previous report (available with
menu, click multiple 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
Related Topics

Global Revisions
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 83.
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

Global Revisions
Batch Printing Documents to PDF Files

SmartPlant Instrumentation supports batch printing of the following documents to
PDF files:
• Enhanced reports.
• Specification sheets. For details, see Printing Specifications into PDF
Files.
• Binder packages from the Document Binder module. For details, see
Printing from a Binder Package to a PDF File.
Notes
• When printing .pdf files in batch mode for the above document types, you
must install GNU Ghostscript or Adobe Acrobat Distiller. You then open
the Preferences dialog box and under the General tab, select the
appropriate application from the PDF generator list.
• In general, SmartPlant Instrumentation supports batch printing to .pdf files
only for the above document types. It Is possible to print to .pdf files in
batch mode for other types of documents; however, the software cannot
create unique file names for each document and is liable to overwrite the
previously generated file, resulting in generation of the last report only in
the batch. In this case, to prevent this from occurring, you must configure
your printer settings to prompt for a file name for each document (for
details, see the user's guide for your specific printer).
Related Topics

Global Revisions
Setting Ghostscript Batch Print Options

When you print reports in batch mode using GNU Ghostscript, the software does not
reason, you need to configure the driver settings so that the software prompts you to
Set the Ghostscript Batch Print Options

1. On the Windows taskbar, click Start > Settings > Printers.
2. Right-click Generic PostScript Printer, and on the shortcut menu, click
Properties.
3. Click the Ports tab.
4. Click Configure Port.
5. In the dialog box that opens, from the Output list, select Prompt for filename.

Global Revisions
Setting Acrobat Distiller Batch Print Options

When you print reports in batch mode using Acrobat Distiller, the software does not
reason, you need to configure the print settings so that the software prompts you to
Set the Acrobat Distiller Batch Print Options

1. Start Acrobat Distiller.
2. On the File menu, click Printing Preferences.
3. On the Adobe PDF Settings tab, select the check boxes Prompt for the PDF
filename and Ask to replace existing PDF file.

Global Revisions
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

Global Revisions
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

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

Global Revisions
Saving in DXF Format

You can save any report in .dxf format for insertion into a CAD drawing (with
AutoCAD or MicroStation). 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 whether to include the title block and frame, whether to build
a script file for AutoCAD, and define certain other parameters for AutoCAD.
Save a Document in DXF Format

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. (Clear the check box to exclude the title block
and frame from the saved report if the CAD package has its own frame.)
4. If you are working in batch mode to save a number of files that are to be opened
in AutoCAD, you can automate the process as far as possible. Define the
parameters in the AutoCAD Options and User-defined options sections of the
dialog box as follows:
5.
File Description
Insertion point The X- and Y- coordinates for the insertion point of the report in
the AutoCAD file define the displacement from the lower-left
corner of the AutoCAD file. The upper-left corner of the report is
inserted at this location.
Scale factor The scale factor determines the size of the report so that it will fit
into the AutoCAD 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
AutoCAD scales the font with the report as a whole.
Change black Type the value of the AutoCAD color to be used as a substitute
report color to for black. All reports are displayed in black-and-white. If
viewing the report in AutoCAD with a black background, an
alternative foreground color needs to be used. The recommended
value is 7.
6. Browse to the target folder and click OK.

Global Revisions
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

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

Global Revisions
Customizing Title Blocks for Reports

Title blocks for reports are templates that SmartPlant Instrumentation uses for the
design of its reports. While the standard default title blocks supplied with the
software are adequate for many reports, you can also create your own custom title
blocks that provide you with the required design and layout of your reports. You can,
for example, customize report titles and headers, as well as the frame size of the title
block.
You first create a title block or duplicate it from an existing one using InfoMaker and
save it as a .psr file. You then open the .psr file in SmartPlant Instrumentation and
add it to the title block inventory. After that, you need to associate the title block
with the required reports and finally, generate a report through the relevant module
using the created title block.
Note
• It is usually more convenient to edit an existing title block and save it
under a different name rather than to create a new one.
Related Topics
• Associating a Custom Title Block with SmartPlant Instrumentation, page
358

Global Revisions
Requirements for Customized Report Title Blocks

You can customize a title block for reports in InfoMaker. In either application, the
custom title block has to meet several standard requirements. The title block has to be
compatible with the report it is associated with. Therefore, make sure that the
customization process accurately fits the SmartPlant Instrumentation customizing
conventions as specified in the following topic.
The following list outlines mandatory and optional InfoMaker requirements:
• Report type — When creating a new report set the report type to be
External (mandatory).
• Report style — Set the report style to be Tabular (mandatory).
• Field prompt— When prompted to set the required fields for a title
block, type any text in the appropriate field. There is no significance to
inserting any particular field name as long as something is typed
(mandatory).
• Group — The title block customization has to be performed in the
Detail group (mandatory).
• Layer — Make sure that you create the title block in the Band layer (the
default - mandatory).
• Design— The frame of the title block consists of four lines. Make sure
that each line has its own unique name typed in small caps as follows:
Upper side L_width
Lower side ln_down
Left side ln_left
Right side ln_right
Important
• When adding other design-related items, such as internal lines, text boxes,
and so forth, to the title block, make sure that the names of the new items
contain the tb segment. For example, if you want to add a new line, name
the line as <Line>_tb_<1>. This is required to distinguish between items
that belong to the title block and items that belong to the rest of the report
outside the title block.
• Field type — select any field type other than Column (mandatory).
• Revisions— Make sure that you have a number 1 revision field. For
instance, a title block with solely a revision no. 2, would not apply.

Global Revisions
• Report measurement units— The units of measure of the customized

title block must be compatible with the units of measure of the report it is
associated with. All the reports were created in inches except for the
following, which use PowerBuilder units:
• All the calculation reports
• The Segment map report
• Fields— SmartPlant Instrumentation created an inventory of macros
available for the custom title block fields. From this inventory you can
select the fields that serve your purposes most. Each field and macro has
its unique name (this is the name to insert in the name field when creating
the item in InfoMaker) as shown in the tables below.
Notes
• Macros retrieve the data and enter it to the fields. For these macros to
function properly, you must insert the macro name accurately according to
the macro tables below.
• You can implement custom title blocks that for macros custom_1 through
custom_5 display field values without labels, for example, 'DCS-1' instead
of 'Panel DCS-1'. To enable this option, make sure that the [Custom]
section of the intools.ini file includes the line
'RemoveFixedTextFromTB=1'.
Table includes Text type fields only:

custom_1 Report name
custom_2 – custom_5 Item names or other data used in reports or drawings
eproj_name Project name (Operating owner domain)
project_t Project header (Operating owner domain)
proj_name Domain name
proj_num Project number (Operating owner domain)
city_name City name
owner_name <Plant> owner.
location_name Location name
plant_hierarchy Plant hierarchy defined by the Domain Administrator.
The default plant hierarchy is Plant\Area\Unit. The
Domain Administrator has rights to change the number of
plant hierarchy levels and customize the level names.

Global Revisions
hierarchy_item_name_x The name of a specific item in the plant hierarchy, where

the segment X defines the plant hierarchy level number.
For example, suppose that your plant hierarchy is
Plant\Area\Unit, and on the Unit level, you have an item
name Crude. To display Crude in the title block, you need
to substitute the segment X with the number 3.
plant_name The name of the item on the highest plant hierarchy level
(the default highest level is Plant).
plant_country Country of the highest plant hierarchy level item
plant_state State of the highest plant hierarchy level item
plant_zip ZIP code of the highest plant hierarchy level item
area_name The name of the item on the intermediate level of the plant
hierarchy (the default intermediate level is Area). If the
plant hierarchy has more than three levels, the macro
area_name retrieves the name of the lowest intermediate
level, that is one level above the lowest level of the plant
hierarchy.
unit_name The name of the item on the lowest level of the plant
hierarchy (the default lowest level is Unit).
hierarchy_udf_y_x A custom field value associated with a specific plant
hierarchy item. The segment 'y' retrieves the number of
the custom field (the Domain Administrator can define up
to twenty custom field values for each plant hierarchy
item). The segment 'x' retrieves the number of the level to
which the plant hierarchy item belongs.
hierarchy_udf_y_x_t Custom fields associated with a plant hierarchy item are
regular text fields and behave as any other custom fields
that are available in SmartPlant Instrumentation for
specific items.
hierarchy_udf_y_x_t The header of a custom field associated with a specific
plant hierarchy item. The segments 'y' and 'x' correspond
to the segments in the macro hierarchy_udf_y_x. The
segment 't' indicates the header.
tb_dwg_name_t Document number
lastrev Last revision
rev_no_1 – rev_no_9 Revision number 1 (mandatory field)
rev_udf_cXX_1 – Revision custom fields (for more details, see below)
rev_udf_cXX_9

Global Revisions
create_by_1 – Created by
create_by_9
Date_1 – date_9 Date
Chk_by_1 – chk_by _9 Checked by
appr_by_1 – appr_by _9 Approved by
desc_1 – desc_9 Revision description
The following table includes Computed type fields only:
Field name Field description Expression

C_page_num Current sheet Page()
C_page_count Total sheets PageCount()
comp_1 Logo name bitmap (
ProfileString (
"intools.ini",
"Project",
"LogoPath", "
"+
"projlogo.bmp"
)
Revision custom fields— you can define your own fields and related macros
in addition to those in the inventory of macros (designated for fields) that are
supplies with SmartPlant Instrumentation. You can add up to 20 revision
custom fields per title block. Inserting the right name in the field name
prompt is necessary for the proper function of the field in the title block. The
naming convention for the revision custom fields is as specified in the
following table:
Rev_udf_c01_t Header
Rev_udf_c01_1 Data field
Rev_udf_c01_2 Second data field under the same header
Rev_udf_c02_t Header 2 (another UDF)
Rev_udf_c02_1 The data in the field (2)

Global Revisions
Document custom fields— Using these fields you can have a record of the
documents that were related to a certain report. These are fields that you
define under the following limitation: each custom field must have only two
fields, one for the header and one for the data. This is the naming convention
for these fields:
dwg_udf_c01_t Header
Dwg_udf_c01 Data field
Dwg_udf_c02_t Header 2 (another custom field)
Dwg_udf_c02 Data field (2)
Related Topics
• Associating a Custom Title Block with SmartPlant Instrumentation, page
358
Edit Report Title Block Properties

You can edit report title block properties under two editing levels. The first is
internal and includes changing the revision custom field headers, document headers
and the title block name. The second level is external to SmartPlant Instrumentation
and includes changes in the design, replacing macros, fields, adding and removing
fields.
Blocks.
2. In the Title Block dialog box, select the desired title block and click Properties.
3. In the Title Block Properties dialog box, do the following:
title block.
Tips
• For the second level of editing you can use an external editing
application (for example, InfoMaker). When editing title blocks, you
must follow the title block requirements.

Global Revisions
PSR Files
SmartPlant Instrumentation provides you with a Power Soft Report (.psr) file viewer
that enables you to retrieve, view, and manage files saved in the .psr format. You can
create a .psr file when you want to save a report or a specification using the Save As
command. You can also view and edit .psr files in InfoMaker.
Related Topics

Global Revisions
Viewing PSR Files

This feature enables you to retrieve files saved in the .psr format and view their
contents. This way you can view specifications, reports, and forms which were saved
as .psr files.
You can:
• Retrieve a .psr report that is saved in a file. For details see Retrieving PSR
Files, page 101.
• Open a report from the PSR List window. For details see Opening PSR
Files from the PSR List, page 103.

Global Revisions
Retrieving PSR Files

If you saved a report as a .psr file, you can navigate to that file and open it.
Retrieve a Previously Saved PSR File

• Click .
• On the Actions menu, click PSR Viewer.
3. In the Select Report File dialog box, navigate to the desired .psr file and click
OK to display the content of the selected .psr file in the PSR File Viewer
window.
Related Topics
• Opening PSR Files from the PSR List, page 103

Global Revisions
Saving PSR File Data

You can save data (for example, a .psr file or data from the database) to an external
file in any format supported by the PowerSoft format, for example: .psr, .wmf, .html,
.sql.
For general details of how to save data from a Print Preview window, see Saving
Documents, page 90
Related Topics

Global Revisions
Opening PSR Files from the PSR List

This option enables you to select an existing .psr file from the list and view its content
in the PSR File Viewer window. The .psr file list is useful where you have a
permanent set of standard .psr files that you want to view frequently.
Open a PSR File From the PSR List

• Click .
• On the Actions menu, click List.
3. In the PSR List window, select the .psr file you want to view in the PSR File
Viewer window.
4. Click .
Related Topics
• Retrieving PSR Files, page 101

Global Revisions
Managing the PSR File List

You can manage the list of .psr files displayed in the PSR List window.
Manage .Psr Files

1. In the PSR File Viewer window, click .
2. In the PSR List window, in the Description data field, type in a description to
characterize the selected .psr file.
3. Perform one of the following actions as required:
Click… …to do t he following:
Insert Append a new line where you can type in the path statement for an
existing .psr file.
File Retrieve a .psr file from a folder and add it to the list.
Delete Remove a .psr file from the list.
Path Set a new default path for all the files in the list. This option is useful
if you have moved all the .psr files in the list to the same folder and
you need to show the new location so that the files can be found. In
this case, you do not need to change each file path separately. At
least one .psr file must already be present in the required path.
Select Display the data for the highlighted file in the PSR File Viewer
window.
Caution
• If you click Path and choose a new folder location for the .psr files,
the original paths that were displayed for the files will be overwritten.
You should therefore only use this option where you are certain that all
the files in the list are located in the same folder.
4. On completion of the required action, click Save.
Related Topics

Global Revisions
Retrieving PBL File Reports

The .psr format allows you to save a multi-page report and nested reports (reports
which contain sub-reports or embedded objects). The .psr file format also enables
you to design your own reports in InfoMaker and use names of columns from your
database. You can then view the reports with the actual data by the PBL Viewer
option.
Important
• Prior to retrieving the reports from the appropriate .pbl file you need to
define the .pbl file location. To define the pbl file location, in the
intools.ini file [Custom] section, LibraryList parameter, you type the pbl
file path and one of the pbl files in the path.
Retrieve a Report From a PBL File

1. With the PSR File Viewer window open, click .
2. In the standard Select Source File dialog box, navigate to the required .pbl file
and click OK.
Important
• Make sure you select an appropriate pbl file, as the .pbl format is also
used for purposes other than storing reports.
3. In the DataWindow List pop-up window, scroll to the required data window and
select it.
4. Click to retrieve the appropriate column data from the database and display it
in the PSR File Viewer window.
Related Topics

Global Revisions
Adding User-Defined Fields to PSR Files

When working with reports, you sometimes need to use extra fields in addition to
those currently available to you. A number of user-defined fields (named Udf C01,
Udf C02, and so forth.) are appended by default to every .psr file that you import.
The first step in making the user-defined fields appear in a report is opening the
report using a report generator, such as InfoMaker or MicroStation, and adding the
appropriate user-defined fields to that report.
After saving a report as a .psr file, you can retrieve your user-defined field values and
include them in the header of the desired report.
Add User-Defined Fields to a PSR File (Using InfoMaker)

1. Start InfoMaker.
2. Build a query for generating a report (for details, see Building a Query, page 113).
3. For each user-defined field that you want to add, do the following:
a. With the main report window open, click Insert > Control > Computed
Field.
b. Click the mouse pointer at the position where you want to place the computed
field on the report.
c. On the Modify Expression dialog box, under the Expression section, type an
expression according to the following syntax:
ProfileString("<SmartPlant Instrumentation home
folder>\intools.ini", "External
Report","<s_udf_name>","<s_udf_value>")
For example:
ProfileString("C:\Program Files\SmartPlant\Instrumentation\intools.ini",
"External Report","udf_C01","Not found")
Tip
•The `s_udf_value' parameter is used to specify a default string to
display where no value exists for the specified user-defined field.
d. At the right of the report, using the Position, Font, and Format tabs, make
the desired definitions for the user-defined field (for example, alignment,
positioning, color, style).

Global Revisions
4. If you intend to display more than one .psr file in the SmartPlant Instrumentation
PSR List window, display the SQL data source, and under the where section, type
psr_storage.psr_stor_desc='<PSR description>.>
Caution
• Without adding this expression to InfoMaker, SmartPlant
Instrumentation always retrieves from the database the first row of
user-defined fields in the PSR List window, regardless of the report
you select. Make sure that the '< PSR description>' has the same value
as the value in the Description column of the PSR List window.
5. Save the current report as a .psr file.
6. Open SmartPlant Instrumentation.
7. With any main module window open, click File > Import PSR.
8. In the PSR File Viewer window, click to open the PSR List window.
9. Scroll to the right side of the window to view the user-defined columns and in the
columns Udf C01 to Udf C10, type the desired values.
10. Click Save to save your user-defined data to the database.
Related Topics

Global Revisions
Viewing PSR User-Defined Fields

This option enables you to retrieve your user-defined field values from the existing
.psr files, and include these values in the header of the desired report within the
SmartPlant Instrumentation environment.
View PSR User-Defined Fields in a Report Header

Caution
• If more than one .psr file is displayed in the PSR List window, you must
open the desired report in InfoMaker, and under the where section, type
psr_storage.psr_stor_desc='<PSR description>
Without adding this expression to InfoMaker, SmartPlant Instrumentation always

retrieves from the database the first row of user-defined fields in the PSR List
window, regardless of the report you select. Make sure that the '< PSR
description>' has the same value as the value in the Description column of the
PSR List window. When done, save the changes to the report and close
InfoMaker.
1. From SmartPlant Instrumentation, do one of the following:
• Retrieve the desired .psr file. For details, see Retrieving PSR Files,
page 101, and on the PSR File View window toolbar, click .
• Open the desired .psr file from the PSR List window. For details, see
Opening PSR Files from the PSR List, page 103.
2. In the data window of the PSR List window, select a .psr file with user-defined
fields.
3. Do one of the following to open the PSR File Viewer window:
• Double-click the selected .psr file.
• On the Actions menu, click Select.
4. On the PSR File Viewer window toolbar, click .
Tip
• For the selected file, the software copies the values in columns Udf
C01 to Udf C10 to the [External Report] section of the Intools.ini file
so that the appropriate user-defined field values appear in the report.
Related Topics

Global Revisions
SmartPlant Instrumentation and InfoMaker

Using InfoMaker, you can customize SmartPlant Instrumentation forms and reports.
Customization includes emphasizing particular fields or data, inserting a graphic
other than the default, or using a different color, and so forth. You can also perform
more complex customizations such as selecting tables, creating and selecting reports,
or defining the SmartPlant Instrumentation database profile. For complete
information on InfoMaker functions, see the InfoMaker documentation.
The aim of this document is to get you started and show you by a few selected
examples how InfoMaker can be best used with SmartPlant Instrumentation.
Important
• You must have working knowledge of the SmartPlant Instrumentation
database table structure to be able to customize reports. For further
information, please refer to the SmartPlant Instrumentation Data
Dictionary, which is available upon request.
• The latest InfoMaker Service Pack is available from the Sybase Web site
(accessible via the InfoMaker Help menu). To find out which version of
InfoMaker you require for the current version of SmartPlant
Instrumentation, refer to the Compatibility Matrix on the Intergraph PPM
Support Web site at http://crmweb.intergraph.com/ecustomer_enu.
Related Topics
• Defining InfoMaker as the Default Report Generator, page 110
• SmartPlant Instrumentation Database Structure, page 111

Global Revisions
Defining InfoMaker as the Default Report Generator

Install InfoMaker according to the instructions in the InfoMaker documentation.
After you complete the installation, you will be able to define InfoMaker as your
default report generator, and launch it from SmartPlant Instrumentation.
Define InfoMaker As the Default Report Generator

1. Launch SmartPlant Instrumentation.
3. On the Preferences dialog box, in the left pane, click Report Generator.
4. From the Report generator list, select InfoMaker.
5. Beside the Path box, click Browse to navigate to the location of the InfoMaker
executable file on your computer, and click OK.
Related Topics
• SmartPlant Instrumentation and InfoMaker, page 109
• SmartPlant Instrumentation Database Structure, page 111

Global Revisions
SmartPlant Instrumentation Database Structure

The following discussion is a very broad explanation of the internal structure of the
SmartPlant Instrumentation database. It is not meant to be a database primer, but
rather an aid for the user to have a better understanding of what tables to select when
creating a customized report.
Two of the important features of the SmartPlant Instrumentation database are its
hierarchical and relational structure.
Hierarchical Structure of the Database

At the top of the database hierarchy are schemas. The SmartPlant Instrumentation
database has separate schemas for the Administration module and for the rest of the
SmartPlant Instrumentation modules. At the next level, below the schema, are tables,
and below the tables are table columns, which are represented in the interface as data
fields.
Notes
• In the Administration module, with the Domain Definition dialog box
open, you specify the schema as the login name.
• The schema name always appears prefixed to the table name separated by
a period (.). If, for example in SmartPlant Instrumentation, you chose
WORK_1 as your Login Name (schema name), and in InfoMaker you
select CABLE as your table name, the full table name is
WORK_1.CABLE
Relational Structure of the Database
The relational structure of the database is concerned with the associations (or links)
that are defined between tables and columns.
For example, if you want to create a customized cable report that includes only the
cable's actual description, color, manufacturer, and model, you need to know that
these are columns that are associated with their respective tables. The following is a
summary for this example, taken from the SmartPlant Instrumentation Data
Dictionary.

Global Revisions
Full Table Name Table Description Table Column Display Name

Name
work_1.cable Information stored cable_desc Cable
about the existence Description
of a cable
work_1.cable_color The list of colors cable_color_name Cable Color
available for all
cables
work_1.cable_mfr The data structure cable_mfr_name Cable
for a list of cable Manufacturer
manufacturers
work_1.cable_mfr_mod The model of the cable_mod_name Cable Model
cable
Note
• The SmartPlant Instrumentation Data Dictionary is available upon request,
and contains complete information about tables and columns.
Related Topics
• Building a Query, page 113
• Creating a SmartPlant Instrumentation Database Profile, page 115
• Defining InfoMaker as the Default Report Generator, page 110
• SmartPlant Instrumentation and InfoMaker, page 109

Global Revisions
Building a Query
This procedure describes how to build a query, which is necessary for exporting
SmartPlant Instrumentation data to an external file that you can use to generate an
InfoMaker report. Please refer to the InfoMaker documentation for information how
to modify your report by adding enhancements such as text color, moving fields, and
graphics.
The customized report created in this procedure is limited to only one data source and
presentation style with no other adornments. This example uses information from the
Instrument Index module to generate a report for the description of a set of tag
numbers, including their service and function type.
Build a Query
1. With the main InfoMaker window open, click .
2. On the New dialog box, click the Database tab.
3. Double-click Query to open the Select Tables dialog box.

4. Select the desired tables by clicking with the mouse button.
5. When finished, click Open to display the Query window.

6. Click View > Table Layout.

Global Revisions
7. Select the desired columns as shown in the following example.
8. Click to view the available data as shown.
9. Click the close box to close the Preview window and return to the Query
window.
10. If you want to select additional tables, click to reopen the Select Tables dialog
box.
11. Perform additional steps as desired. These can include the following:
• Using the Join function to rebuild links manually between table rows.
• Defining a sort sequence for the retrieved data.
• Using a Where condition to filter the retrieved data.
Note
• Full details of these procedures are beyond the scope of this topic. For
further information, see to the InfoMaker documentation.

Global Revisions
12. To view details of your query, click the Syntax tab. The following screen shot
shows an example of a query.
13. When finished, save your query by doing one of the following:
• Click .
• Click File > Save Query.
14. On the Save Query dialog box, in the Queries box, type a name for your query.
Notes
• Your query name must not include any spaces.
• The software saves the query in the backup library that you defined (for
Creating an InfoMaker Library, page 119.
Related Topics
• Saving an InfoMaker Customized Report, page 120
Creating a SmartPlant Instrumentation Database

Profile
InfoMaker automatically creates database profiles for various types of data.
However, you may find that your parameter settings do not point to the SmartPlant
Instrumentation data source. In such cases, you need to enter the proper settings to
connect to the SmartPlant Instrumentation database profile.
Create a SmartPlant Instrumentation Database Profile

2. On the Database Profiles dialog box, select ODB ODBC.
3. Click New.

Global Revisions
4. In the Database Profile Setup dialog box, on the Connection tab, enter the
appropriate values for the database to which you want to connect.
Tip
• If you choose to connect to the demo database, the default value for
both the User ID and Password properties is IN_DBAMN.
5. When finished, click OK to re-open the Database Profiles dialog box, where the
current SmartPlant Instrumentation database profile is selected by default.
6. Select the database profile and click Connect to make the connection with the
profile.

Using SmartPlant Instrumentation with InfoMaker
Using SmartPlant Instrumentation with

InfoMaker
Working with InfoMaker Libraries and Reports
Common Tasks
SmartPlant Instrumentation reports can be saved as external .psr files, edited in
InfoMaker, and then opened from within an InfoMaker library and report.
Create an InfoMaker Library and Report for Editing PSR

Files
1. Do one of the following to launch InfoMaker:
• On the Windows Start menu, point to Programs, navigate to the
appropriate folder, and click InfoMaker.
• From any SmartPlant Instrumentation window, click File > Generate
Reports.
Tip
• If the Generate Reports command fails to open InfoMaker and you
receive an error message, make sure that you add the file path
containing the .dll files to the PATH environment variable, and then
restart SmartPlant Instrumentation. By default, the .dll files are
located in the path: <Drive letter>\Program
Files\Sybase\Shared\PowerBuilder\.
2. In InfoMaker, create a new library. For details, see Creating an InfoMaker
Library, page 119.
3. Define InfoMaker as the Default Report Generator. For details, see Defining
InfoMaker as the Default Report Generator, page 110.
4. Define a report as follows:
a. Click File > New.
b. On the New dialog box, on the Object tab, select Freeform and click OK.
c. In the Freeform Report Generator dialog box, select External and click
Next.
d. On the Define Result Set dialog box, in the Name box, type a name for the
result description, and click Next. The name cannot contain spaces.
e. On the Select Color and Border Settings dialog box, click Next.

f. On the Ready to Create Freeform dialog box, click Finish.

g. If the Database Profiles dialog box opens, follow the procedure Creating a
SmartPlant Instrumentation Database Profile, page 115.
5. In the Report window, do the following to save the report that you just defined:
a. Click File > Save.
b. On the Save Report dialog box, under Reports, type a name for the report.
c. Make sure that under Libraries the correct library is selected and then click
OK.
Tip
• To organize your display of .psr files in InfoMaker, create various
reports within various libraries.
6. In the Report window, click File > Open File.
7. On the Select a File Name dialog box, navigate to the .psr file that you want to
open, and click Open.
Open a PSR File From an InfoMaker Library And Report

1. Do one of the following to start InfoMaker:
a. On the Windows Start menu, point to Programs, navigate to the appropriate
folder, and click InfoMaker.
b. From any SmartPlant Instrumentation window, click File > Generate
Reports.
2. File > Open, and on the Open dialog box, do the following:
a. Under Library, select the appropriate library.
b. Under Object Type, select Reports.
c. Under Object, select the desired report from the list.
d. Click OK.
3. Click File > Open File.
4. On the Select a File Name dialog box, navigate to the .psr file that you want to
open, and click Open.

Creating an InfoMaker Library

InfoMaker uses libraries to hold objects such as reports and queries. Also, before
building a query, you need to create a backup library. The software automatically
puts all queries that you save into this library.
Create an InfoMaker Library

2. On the New dialog box, click the Library tab.
3. Double-click the Library icon .

4. On the Specify New Library dialog box, type the desired path and name of the
library (.pbl) file, or click the ellipsis beside the Library box to navigate to the
file.
5. Click Finish.
Related Topics

Saving an InfoMaker Customized Report

When a customized report satisfies your requirements, you can save it in any one of
several formats such as .psr (Powersoft report), Excel, text file, and so forth.
Save a Customized Report

1. In SQL Preview mode, click File > Save Rows As.
2. On the Save As dialog box, do the following:
a. Navigate to the folder where you want to save the report.
b. In the File name box, type the name of the file (without an extension).
c. From the Save as type list, select the file format that you require (for
example, Powersoft Report).
3. Click Save to save your report and return to the Preview mode.
Related Topics

1. Click File > New.
2. On the New dialog box, on the Library tab, double-click the library icon and
create a .pbl library where you can group newly-created browsers.
3. Reopen the New dialog box and click the Object tab.
4. Select Grid for the report layout and click OK.
5. In the Grid Report Generator Wizard, select SQL Select, and then complete
the Wizard steps.
6. On the Select Tables dialog box, select the tables that you require.
a. Select fields from the tables.
b. Select a primary key from each table.
8. Click the Return icon to open the Select Color and Border Settings dialog
box, where you can set the browser colors. After setting the browser colors, click
Next and then click Finish to display the Report preview window.
9. In the report preview window, click the Data Source icon to reopen the Select
window.


a. On the Design menu, click Convert to Syntax to convert the selected fields
from the graphic mode to the syntax mode.
b. Remove all the quotation marks (") from the displayed SQL statement.
The following example shows how the final SQL statement should appear:
SELECT component.cmpnt_name,
component.cmpnt_serv,
loop.loop_name,
loop.loop_serv, component.cmpnt_id,
loop.loop_id
FROM component,
loop
WHERE (loop.loop_id=component.loop_id )
loop
11. Return to the report preview window and do the following:

a. Set the header font style to MS Sans Serif, 8 point, Bold.
b. Protect fields that you want to reserve for internal use (do not protect the
primary keys) by the protected column attribute to 1 (one).
c. For each header name, use the following naming convention: <column
name>_t. For example, cmpnt_name_t.
d. For each field name, use the following naming convention: <column name>.
For example, cmpnt_name.
e. Delete the flag_color field, and also delete all the columns that contain
primary keys (the primary keys remain in the SQL statement).
12. Save the report data in one of the following ways:
• Without previewing, click Save As to save the report in the specially
created .pbl library.
• Save the report as a stand-alone .psr file.
13. If you saved the report in the .pbl library, do the following:
a. Copy the .pbl file to another location, preferably to the SmartPlant
Instrumentation home folder, and then change the file extension from .pbl to
.pbd.
b. In the [CUSTOM] section of your Intools.ini file, add the following line
(including the full pathname of the .pbd file): LibraryList=XYZ.pbd.

SmartPlant Instrumentation and MicroStation

Overview
MicroStation is a three-dimensional CAD software package which includes features
to allow the interchange of design data with SmartPlant Instrumentation. SmartPlant
Instrumentation supplies the design data, and generates a schematic drawing
associated with a specific loop, component or block by means of MicroStation.
Notes
• SmartPlant Instrumentation use of the term Block corresponds to the term
Cell in MicroStation.
• This section explains how MicroStation works with SmartPlant
Instrumentation. All the topics in this section require a basic level of
familiarity with MicroStation. Refer to the MicroStation user manual for
detailed explanations of MicroStation functionality.

System Requirements
Minimum hardware and software requirements must be met before installing
MicroStation on your computer.
• 16 MB RAM in addition to SmartPlant Instrumentation installation

requirements.
• 75 MB of free hard disk space.
Refer to your MicroStation user manual, Getting Started for more detailed
requirements for running the MicroStation software package.

MicroStation Settings
Once MicroStation has been successfully installed, a number of modifications still
have to be made to ensure compatibility with SmartPlant Instrumentation. The
modifications are done directly through the options on the menu bar of the main
MicroStation window.

Define MicroStation Settings

1. Click Workspace > Preferences.
2. On the Preferences dialog box, under Category, select Memory Usage and
ascertain that your settings are as follows:
3.
Setting MicroStation 95 or SE MicroStation J
Max. Element Cache 8000 10240
Resource Cache 24 1024
Undo Buffer 256 2048
Font Cache 30 256
Conserve Memory Cleared Cleared
Disable OLE Automation Cleared Cleared
Tip
•When working with MicroStation 95, SE or J, the Conserve Memory
check box must be cleared.
4. Under Category, select Operation and ascertain that your settings are as follows:
Setting Value
Locate Tolerance 10
Pointer Size Normal
Pointer Type Orthogonal
Display Levels Names
Immediately Save Design Changes Selected
Save Settings on Exit Cleared
Compress Design on Exit Cleared
Enter into Untitled Design Selected
Reset Aborts Fence Operations Selected
Level Lock Applies for Fence Operations Selected
Use Semaphore File for Locking Cleared
Tip
• When working with MicroStation, the Immediately Save Design
Changes check box must be selected to enable viewing or generation
of loop drawings if MicroStation was not previously launched.

5. Under Category, select Tags and ascertain that your settings are as follows:
Setting Value
Prompt on Duplicate Tag Sets Cleared
Use Design File Tag Sets by Default Cleared
Place Tags in Same Graphic Group Cleared
6. When finished, click OK to return to the main MicroStation window.

Setting the SmartPlant Instrumentation Parameters

for MicroStation SE/J
To generate CAD loop drawings using MicroStation, the temporary folder path
setting on the General page of the SmartPlant Instrumentation Preferences dialog
box must not exceed 42 characters. This means for example that you cannot use the
default path C:\Program Files\SmartPlant\Instrumentation\TEMP.
If you installed MicroStation SE or J, you can enter file paths with spaces (long file
paths) on the Loop Drawings > CAD File Locations page of the SmartPlant
Instrumentation Preferences dialog box. This requires that you specify the
MicroStation version to work with long file paths.
Enable MicroStation SE/J to Work With Long File Paths

1. In SmartPlant Instrumentation, click File > Preferences.
2. Expand the hierarchy Loop Drawings > General.
3. From the MicroStation version list, select MicroStation SE/J.

Creating Tag Sets

In MicroStation you group tags into tag sets. Use this procedure when you need to
create a new tag set from scratch. To save time it is recommended that you duplicate
and rename tag sets instead of creating new ones. You can save tag sets to a tag set
library file and then copy them to other files as desired
Create Tag Sets

1. In the main MicroStation window, click Element > Tags > Define.
2. In the Tag Sets window, click Add under the Sets data window.
3. On the Tag Set Name dialog box, type the desired name.
4. Click OK to reopen the Tag Sets window.
5. To add another Set, click Add again to open the Tag Set Name dialog box.
6. Repeat steps 2 and 3, but enter instrument instead.
The Tag Sets window should now appear as follows:
7. Click Add under the Tags data window to open the Define Tag dialog box.
8. Enter the desired information.
Tip
• The text in the Default Tag Value pane must be typed in upper case.
9. Click OK to reopen the Tag Sets window.
10. To add another tag definition, click Add again (under the Tags data window), to
open the Define Tag window.
11. Repeat steps 6 and 7, but now enter tag_loc (Tag Location) instead.
When finished, the Tags data window in the Tag Sets window for instrument
should appear as follows:

12. Select loop in the Sets data window to enter its tag definitions in the Tags data
window.
13. Repeat steps 6 - 8, and enter loop_type (Loop Function) and loop_func (Loop
Type).
When finished, the Tags data window in the Tag Sets window with the loop set
selected should appear as follows:

Exporting Tag Sets

Exporting Tag Sets allows you to save new tag sets in a library file. This makes it
more convenient to import the exported tag set.
Export Tag Sets

1. In the Tag Sets window, select the Set (for example, instrument) to export.
2. Click File > Export > Create.
3. On the Export Tag Library dialog box, click OK to return to the Tag Sets
window.
4. Repeat the previous steps to create a tag library for the loop set.
Note
• The next time you open a MicroStation session, select Import to display
the latest tag set definition.

Importing Tag Sets

This procedure explains how to retrieve a previously created tag set from a tag library
file.
Import a Tag Set

1. In the Tag Sets window, click File > Import.
2. On the Open Tag Library dialog box, select the desired library and click OK to
open the Import Sets dialog box.
3. Click OK to reopen the Tag Sets window with the set and its associated tags
displayed.
4. To add another set, to the Tag Sets window, repeat steps 1 and 2, but this time
select instrmnt.tlb on the Open Tag Library dialog box.

Linking a Tag to a Drawing Element

This procedure explains how to create a drawing element and associate it with the tag
definitions that you defined in the Define Tag window.
Link a Tag to a Drawing Element

1. In the main MicroStation window, click Tools > Main > Tags.
2. In the Tags window, select, for example, the Place Block tool from the Main tool
palette to draw a rectangle on the MicroStation desktop.
3. Select Attach tags to an element to open the Attach Tags dialog box.
4. On the Attach Tags dialog box, place the cursor on the rectangle that you drew in
step two:
5. Double click the cursor to open the Attach Tags dialog box.
Tip
• If you want to display another tag set, such as the loop tag set, open
the Attach Tags dialog box and repeat steps 3 - 5.
6. Click OK to display the tags on the desktop.
7. Move the tags, without clicking, to the desired location. Below is a typical
example.
8. Click the left mouse button when the tag position is appropriate.
The tag is now associated with the design element (the rectangle in this case).

Creating a Cell Library

This procedure explains how to create a cell library to which you can add cells (for
details, see Adding a Cell to the Cell Library).
Create a Cell Library

1. In the main MicroStation window, click Element > Cells to open an unnamed
Cell Library window.
2. Click File > New to open the Create Cell Library dialog box.
3. Click OK to reopen the Cell Library window.
4. Drag the Cell Library window as far off the desktop as possible and store it for
future use. The window will be recalled later when you add a cell to it.

Fencing Elements for a Cell

You can fence elements to globally perform actions on them in batch mode. This
allows you to identify the cell in a cell library to be recalled as many times as needed.
This enables you for example to edit the cell, or combine it with other cells to create a
larger design.
Fence Elements for a Cell

1. Set all the elements on the desktop, and select the fence icon on the main tool
palette.
2. Fence the desired elements.
Tip
• Fencing an area automatically opens the Cell Library window. Prior
to saving a cell in the cell library you need to define the cell origin.

Defining the Cell Origin

You define a cell origin to set the position of a graphic object in a design. This will
subsequently and automatically entail the Create action in the Cell Library window.
Define the Cell Origin

1. Select the Define Cell Origin icon from the Main tool palette.
2. Click the cursor on the lower left corner of the desktop.
Tip
• Now that the cell origin is defined, you have to accurately set the cell
origin coordinates (for details, see Defining the Coordinates of the Cell
Origin, page 136).

Defining the Coordinates of the Cell Origin

This procedure explains how to generate the cell origin coordinates for a graphic
element placed on the desktop.
Define the Cell Origin Coordinates

1. With the cell origin defined (typically, on the lower left corner of the desktop),
click . to open the AccuDraw window.
2. Set the X and Y coordinates to 0.0000.
3. Select all the check boxes.
Add a Cell to the Cell Library

1. Open the Cell Library window.
2. Click Create to open the Create New Cell dialog box.
Tip
• Both Name and Description must be defined otherwise the software
does not perform the create action.
3. Click Create to display the new cell name and description in the data window of
the Cell Library window.
Related Topics
• Previewing a Cell, page 137

Previewing a Cell
When several cells are listed in the cell library, it is recommended that you preview a
cell to make sure that you have selected the correct one. This procedure explains how
to generate a thumbnail view of the cell.
Preview a Cell
• Open the appropriate cell library, and click the cell that you want to
preview.
A thumbnail view of the cell appears in the Print Preview pane.

Displaying a Cell on the Desktop

This procedure explains how to take a previewed cell and place it on the desktop.
This may also be useful when you want to relocate a cell to achieve a different design
than the current one.
Display a Cell on the Desktop

1. Open the Cell Library window, click a cell to preview it, and then click
Placement.
2. On the Main tool palette, click the Place Active Cell icon.
Tip
• A tool from the View Control bar may be needed to display your Cell.
3. Move the mouse to the desired location on the desktop.
4. Click to pin the cell to a selected location.
5. If you need another copy of the same cell, repeat steps 3 and 4.
6. When done, right click.
Tip
• You can also add cells from other libraries, print/plot your design, and
so forth. Refer to the MicroStation user manual to learn more about
the available MicroStation options.

Generating a Report Using MicroStation

You can generate SmartPlant Instrumentation reports using MicroStation from either
SmartPlant Instrumentation or MicroStation. When you generate the report from the
MicroStation environment you need to manually open the desired report file using the
Open dialog box in MicroStation. However, the recommended generation method is
using the Loop Drawings module Loop Explorer since it is completely automatic
and internal to SmartPlant Instrumentation (for details, see Generating a Loop
Drawing Using an External CAD Engine).

Import Utility
Import Utility
Overview
The Import Utility enables you to import data from most common database formats
into a selected table or module in the SmartPlant Instrumentation database. The
Import Utility also provides you access to database platforms other than your own
(Oracle, SQL Server, or Sybase Adaptive Server Anywhere).
To import data, you need to have some knowledge of the SmartPlant Instrumentation
database structure and concepts such as naming conventions. You should also know
how to connect to the source and target databases (for example, correct ODBC
profile, or native connection to the database). To learn more about the SmartPlant
Instrumentation database structure, see Data Import Order, page 260.
The Import Utility is essential because inserting data into SmartPlant Instrumentation
is not a trivial matter. Since the SmartPlant Instrumentation table structure is
relational, there is a constant maintenance of integrity constraints. You have to keep
the relation between the tables and create unique values in the primary key. You
therefore have to insert data into SmartPlant Instrumentation only through the
SmartPlant Instrumentation interface or by using the Import Utility.
You can find the following information in the help topics that follow:
• the database platforms supported by the Import Utility.

• working with log files.
• building new links.
• executing an existing link.
• moving links from one domain to another.
• setting the import comparison criteria.
• maintaining the source and target rows.
• selecting and applying system codes.
Caution
• We recommend proceeding cautiously with the import process, as some of
the Import Utility features change the structure and contents of the target
database.
Related Topics
• Data Import Process, page 143
• Import Prerequisites, page 142

Import Utility
Database Platform Support

The Import Utility provides you with inherent support of the following database
platforms and database file formats:
• Oracle (only if you have selected Oracle as your current database platform
during Setup)
• SQL Server (only if you have selected SQL Server as your current
database platform during Setup)
• Sybase Adaptive Server Anywhere (only if you have selected Sybase
Adaptive Server Anywhere as your current database platform during
Setup)
• Microsoft Access
• DBF
• Text files
The above databases are available to you as files in a folder (for example, DBF, Text
files) or as structured tables (for example, Excel, Microsoft Access).
The configuration of the above database platforms is done automatically during the
setup process (for details, refer to the appropriate section of the SmartPlant
Instrumentation Installation Guide for your platform.)
Note
• To install drivers and profiles of ODBC platforms other than those listed
above, you need to install the appropriate software, for example, Excel 7
or later, Microsoft Access, and so forth.
You can import data from a database platform (for example, Oracle, SQL Server or
Sybase Adaptive Server Anywhere) other than your current SmartPlant
Instrumentation database platform. To do this you will have to comply with the
appropriate system requirements of the external database platform. For example, if
your current SmartPlant Instrumentation database platform is Sybase Adaptive Server
Anywhere and you want to import data from an Oracle database, you must have
Oracle client installed and running on your computer.
You can also import from database platforms other than those specified above. To do
this you need to provide drivers and modify the appropriate configuration files.
SmartPlant Instrumentation provides you with examples of dbf files which are
installed to the Import folder during setup. You can use these example files to learn
how to import dbf files.

Import Utility
Import Prerequisites
Before importing data into SmartPlant Instrumentation, the following conditions must
be met:
• There must be a target SmartPlant Instrumentation domain containing at

least one plant hierarchy item at the lowest level of the hierarchy (by
default, this is a unit).
• There must be a naming convention (both loop and component) for each
<unit>. This is necessary only if you intend to work with tables whose
columns require naming conventions (for example, COMPONENT,
LOOP).
• The plant's custom fields must be declared if a custom field is targeted.
This is necessary only if you intend to work with tables whose columns
require naming conventions (for example, COMPONENT, LOOP).
Before you start importing data we recommend that you check and update the
Instrument Type table (in SmartPlant Instrumentation) where you declare all your
instrument types with their profiles, the default device panel with its default cable and
the connection type between them, and the default spec form.
Preparing the profile in advance will enable you to build a device panel automatically
and/or a spec when entering a tag.
Related Topics
• Matching Naming Conventions, page 145

Import Utility
Data Import Process

The data import process involves creating links that map between the source and the
target object (module or table). After defining the links, you perform the actions that
import the data into SmartPlant Instrumentation. The process is described in outline
as follows:
1. Select the type of target (module or table) for import.
2. Select the required target SmartPlant Instrumentation table / module for the
import. When importing data to tables, the order of the import is important. You
should first import data into a table that the next table refers to (for example,
before importing data into component table you should import data into
component_location table, if appropriate (for a full description of relationships
between the data tables, see Data Import Order, page 260).
3. Set the import parameters. This includes:
• selecting specific source rows.
• specifying a filtering condition.
• reviewing and modifying the table definition.
• defining a source consisting of more than one table or file.
4. Establish a link between the source and the target data. You can:
• use an existing link that was saved previously
• build a new link and save it (see step 5).
5. To build a new link, do the following:
a. Set the appropriate parameters for the import.
b. Where appropriate, define the structure of the import link.
c. Define the link mapping between the source and the target table columns.
6. Run an import test or perform the import process.
The results of running a test provide you with information about the expected
outcome of the actual import process.
Notes
• You can modify the source definition after creating the link to insure that
all required data exists in your source database. Use the SmartPlant
Instrumentation Data Dictionary to help you identify target SmartPlant
Instrumentation tables.
• You can run import links in batch mode from the command line. For
details, including the appropriate parameters, see Link Groups, page 244
and Running an Import Session Using Command-Line Parameters, page
147.

Import Utility
• If required, you can reset the import order as well as select the reference
tables to import. (To learn how to control the import order, See Setting the
Target Table Definitions and Working with Reference Tables, page 205).
The Import Utility also allows you to:
• Map source codes and units of measure (see System Codes Table, page
272 and Unit of Measure Codes Table, page 281).
• Move links between databases or domains (see Moving Links Between
Databases or Domains, page 168).
• Rename links.
• Delete links.
• Associate your links with other links and group them together for a batch
operation.
• Associate multiple sources for use as a single source.
• Define links using arithmetic functions (see Using Formulas and
Arithmetic Functions in Import Links, page 203).
• Expand the source data by associating the selected source data with
additional data.
• Coordinate the rows to be updated, inserted, or deleted.
• Set the import comparison criteria (for import to tables only): this enables
comparison between source and target data, filtering of rows for import, or
deleting rows in the target.
Related Topics
• Executing the Import of Data, page 206
• Testing the Import Process, page 208

Import Utility
Matching Naming Conventions

In general, the predefined import links apply to all naming convention standards (for
example, ISA, Loop, and so forth). The only thing that changes from one domain to
another is its naming convention. Therefore, it is very important to adjust the links so
that they match the naming conventions used in the domain into which you are about
to import.
For example, the SmartPlant Instrumentation demonstration domain (IN_DEMO)

uses the ISA naming conventions standard which exhibits the following tag structure:
108-AAAA-BBBB
where the prefix is the <unit> number (108), AAAA represents the instrument type
and BBBB represents the tag number (the hyphens are part of the naming
convention). Therefore, a block tag with tag number 108FE22212 should be
represented in the demonstration domain as:
108-FE -2212
Before starting the import setup process, you need to pay attention to the source table
columns that construct the source tag and loop and how they match the SmartPlant
Instrumentation tag and loop data. SmartPlant Instrumentation uses two naming
convention categories: Component (Tag) and Loop.
When you select an import link that is associated with either tags or loops, you will
be prompted to define the naming convention structure.
Caution
• When redefining the naming convention structure, make sure that no data
redundancy is created (for example, duplicate tags or loops). Such a
redundancy may be caused, for example, if the source table columns use
data segments that are shorter than those used in the target table columns.
For example, the 108PS2212 source tag uses only a two character table column for
the instrument type. In SmartPlant Instrumentation, this tag will appear as: 108-PS -
2212. This situation may cause data redundancy, since this tag can stand for either
108-PSH -2212 or 108-PSL-2212.

Import Utility
Starting the Import Utility

You can start an import session in one of two ways:
• By selecting the Import Utility from the SmartPlant Instrumentation

program group in the Windows Start menu.
• By running an import session using a command-line (see Running an
Import Session Using Command-Line Parameters, page 147).
Note
• The Import Utility is automatically installed when selected during
SmartPlant Instrumentation setup.
• However, if the Import Utility was not installed in your computer, you can
install it by running the SmartPlant Instrumentation setup and selecting to
install the Import Utility (see Installation Guide to learn how to install
SmartPlant Instrumentation.)
Important
• You must have Domain Administrator access rights to be able to perform
import activities.

Import Utility
Running an Import Session Using Command-Line

Parameters
You can use command-line parameters to start an import session that will execute an
existing import link. This way you can import data using the settings in the selected
link without having to utilize the Import Utility.
Start a Command-Line Import Session

1. On the Windows Start menu, click Run.
2. In the Run dialog box, type the following parameters (on one line):
[home folder]\import [username],[password],[Domain name],
[<plant> name], intermediate plant hierarchy item 1
[/intermediate plant hierarchy item 2][/intermediate plant
hierarchy item 3]...,[<unit> name],[link name] - or - @[group
name],[Project name]
Note
• Plant hierarchy item names into which you intend to import data may
not contain `/' characters because the software interprets these
characters as separators between successive hierarchy levels.
The phrases in brackets stand for the following parameters:
• [home folder] - the folder where you installed SmartPlant

Instrumentation.
• [username], [password] - the Domain Administrator's username and
password.
• [Domain name] - the target domain.
• [<plant> name] - the plant or equivalent highest level item in the
plant hierarchy.
• [intermediate plant hierarchy item 1][/ intermediate plant
hierarchy item 2][/ intermediate plant hierarchy item 3]… -
when you want to import source data from multiple plant hierarchies
into the target plant hierarchy and the intermediate plant hierarchy has
two or more levels, use the character defined in the Administration
module as the plant hierarchy separator for the domain, for example,
`/'. (If no separator is defined in the Administration module, use `/'as
the default.)
• [<unit> name] - the unit or equivalent lowest level item in the plant
hierarchy.

Import Utility
• [link name] - the name of the import link you want to execute in the
current import session.
• [group name] - the name of the group whose links you want to
execute in the current import session. When used, this parameter is
always preceded by a commercial àt' sign (`@').
• [Project name] - the target project when working in an Operating
owner domain.
Examples
The following are two examples of using the command-line syntax:

a. Importing data to the demonstration domain by executing a link named Flow
in an Operating owner domain (the following statement should be typed on
one line):
import DBA,DBA,Demo Domain,Plant 1 - DEMO,Main
Building/North/Room 1,Unit 3,Flow,Demo Project
b. Importing data to the demonstration domain by executing all the links in a

group named `Process Data' in an EPC domain (the following statement
should be typed on one line):
c. import DBA,DBA,Demo Domain,Plant 1 - DEMO,Main
Building/North/Room 1,Unit 3,@ Process Data
3. Press Enter.
You see the links that you specified in the statement being carried out.

Import Utility
Running an Import Session from the User Interface

Use this procedure to run an Import session from the user- interface. This can also be
performed using command line parameters described in the previous topic.
Start the Import User Interface

1. Select the Import application from the SmartPlant Instrumentation program
group in the Windows Start menu.
2. In the Login dialog box, type the Domain Administrator name and password.
3. In the Open dialog box, drill down to select the target <unit> into which you will
import data.
Tip
• Whenever you start the Import Utility, you are prompted to select a
target <unit>. For some data it is inapplicable to be associated with a
particular plant hierarchy item, however, you must always select a
<unit> to import data into.
4. In the Domain Name data field, select the target domain, for example, the
domain to which data will be imported.
5. In the data window, double-click the icons for the appropriate plant hierarchy
items to expand them and select the required target <unit>.
6. Click OK to open the Import Utility Link Explorer.

Import Utility
Working with Log Files

A log file allows you to keep track of all your import operations. Log files carry all
the information about your import activities. When you first start the Import Utility,
you will create your first log file. It will keep growing as you continue importing
data unless you decide to change the current log file. The information in the log file
is organized in an ascending chronological order. This information includes:
• The domain details.

• The source and target details (the source table/file name; the target
table/module name).
• Rejected data rows details (if there are any).
• The import results (the number of total rows, inserted, updated, and
rejected rows).
Note
• You can perform the import process without a log file but it is not
advisable, as you will not have a record of the import execution. If you
start the Import Utility with no log file defined, you will get a message
after you select the target <unit> in the Open dialog box.
You can create a new log file, open an existing log file, delete a log file, view a log
file, check the name of the current log file, or close the current log file.
Related Topics
• Checking the Name of the Current Log File, page 154
• Closing the Current Log File, page 155
• Creating a New Log File, page 151
• Deleting an Existing Log File, page 156
• logging the import parameters
• Opening an Existing Log File, page 152
• Viewing a Log File, page 153

Import Utility
Creating a New Log File

It is advisable to create a new log file each time you perform an important import
operation. You should also create a new log file if your existing log file has become
too long.
Create a New Log File

1. On the Log File menu, click New.
2. In the New Log File dialog box, type the name of your new log file, select the
required path and click OK.
The Import Utility opens a new (empty) log file automatically (even though you do
not see it).

Import Utility
Opening an Existing Log File

It is advisable to open a log file before you perform an import procedure so that you
have a record of the import process.
Open an Existing Log File

1. On the Log File menu, click Open.
2. In the Open Log File dialog box, select the name of the log file you want to open
and click OK.
Tip
• After you create a new log file or open an existing one, it stays open
even though you do not see it displayed. The log file will remain
active until you close the Import Utility. (See Closing the Current Log
File, page 155 to learn how to close the current log file manually.)
When you exit the Import Utility, the Log File closes automatically
and reopens when you restart the Import Utility.

Import Utility
Viewing a Log File

You can view the current log file to review the previous import process information.
You can also view any other existing log file.
View the Current Log File

• Click .
• On the Log File menu, click View.
The current log file is opened for viewing by Notepad.
Tip
• SmartPlant Instrumentation uses Notepad to view the log file.
However, Notepad is limited by file size that it can handle. If your log
file becomes too large for Notepad, you will get an appropriate
message. In this case you can view your log file using Windows Write
or another appropriate utility.

Import Utility
Checking the Name of the Current Log File

You can check which log file is currently in use.
Check the Name of the Current Log File

• On the Log File menu, click Log File Name.
The Import Utility shows you a message where it states the path and filename of your
current log file.

Import Utility
Closing the Current Log File

You can also import data without a log file. If you choose to do this and there is a
current log file, you can close it.
Close the Current Log File

• On the Log File menu, click Close.
The Import Utility immediately closes the current log file. After you close the current
log file you need to define a new log file to resume tracking the import process (see
Creating a New Log File, page 151 to learn how to define a new log file).

Import Utility
Deleting an Existing Log File

You can delete a log file when the information in it becomes unimportant.
Caution
• This action deletes the selected log file from your hard disk.
Delete an Existing Log File

1. On the Log File menu, click Delete.
2. In the Open Log File Name dialog box, select the name of the log file you want
to delete and click OK.
The specified log file is deleted from your hard disk.

Import Utility
Logging the Import Parameters

You can log the import parameters which you use in the current import process. See
Setting the Properties for a Link, page 171 to learn how to do this.
Log the Import Parameters

• On the Log File menu, click Show Link Parameters (repeat this step to
deselect this option).
The menu item you selected is checked.
After you run the import process, a section named Link Parameters is added in the
current log file, where you see the import parameters used in this import process.

Import Utility
Creating a New Link

Before the actual import can take place, you must have a link between the source and
the target data. If you do not have a previously saved link or you do not want to use
an existing link, you will need to build a new one.
The first step in building a new link is to define the source and the target data. You
do this by selecting the source and target database platform and the source and target
data. The source / target database platforms that you can select depend on the
database platform on which you installed SmartPlant Instrumentation (for example,
Oracle, SQL Server, Sybase Adaptive Server Anywhere), and the database platform
which is supported by your Windows environment.
Related Topics
• Creating a New Link for Platforms other than ODBC, page 163
• Creating a New Link for the ODBC Platform, page 159
• Selecting dBase / Text Files as the Source Profile, page 161

Import Utility
Creating a New Link for the ODBC Platform

This section describes the setup for the ODBC platform
Create a New Link (ODBC) With a Database As the Source

Data
• On the Actions menu, click New Group (or click ) to create a new
link group.
• In the link list, select an existing link group.
• Click .
• On the Actions menu, click New Link.
3. In the Link Definition dialog box, under Target, click Table or Module and
select the appropriate target table or module from the list.
Caution
• You can import data only into a target table which has a table
definition (for example, a table which has a correct definition of a
primary key, foreign keys, and reference tables). If you import data
into a target module, all the tables in the target module must have a
table definition.
• If you select a target table which does not have a table definition or has
an incorrect table definition, an appropriate message will be displayed.
In this case you will have to select another target table or modify the
table definition.
4. Under Source, from the Database type list, select ODBC as the source database
platform.
5. From the SQL Data Source list, select the required database profile.
Tip
• The database types that are currently available to you are those which
you have installed during SmartPlant Instrumentation Setup and those
which you have installed manually on your computer.
6. Click Connect to establish a connection to the selected source database.

Import Utility
Tip
If the connection attempt is unsuccessful, an appropriate message is
•
displayed. In this case make sure that the appropriate database server
is accessible to you.
7. From the Table Name list, select the required source table.
8. Click Save Link and in the Link name text box of the dialog box that opens, type
a name for the link.
9. Click OK.
10. Click Close to close the Link Definition dialog box.
11. Click to display the link you defined in the Link Explorer.
Related Topics
• Creating a New Link for Platforms other than ODBC, page 163
• Setting the Target Table Definitions: An Overview, page 212

Import Utility
Selecting dBase / Text Files as the Source Profile

When you select dBase files as the source profile, the options in the Link Definition
dialog box are a little different.

Import Utility
Create a New Link (ODBC) With Dbase / Text Files As the

Source Data
link group.
In the link list, select an existing link group.
•

• Click .
•On the Actions menu, click New Link.
Caution
•You can import data only into a target table which has a table
table definition. If you select a target table which does not have a
table definition or has an incorrect table definition, an appropriate
message will be displayed. In this case you will have to select another
target table or modify the table definition. To learn more about setting
the table definition, see Setting the Target Table Definitions.
4. Under Source, from the Database type list, select ODBC as the source database
platform.
5. From the SQL Data Source list, select the appropriate database file type.
6. Click Browse to open the Select File dialog box and navigate to the source
database file.
7. Click Open to return to the Link Definition dialog box where the source file
name with its path appears in the File Name data field.
Tip
•The Import Utility supports long filenames for the source.
9. Click OK.

Import Utility
Creating a New Link for Platforms other than ODBC

You can build a new link using a source database platform other than ODBC. To do
this you must have access rights to the database server as well as the appropriate
database drivers. You must also have the appropriate settings in the configuration
files (for example, ini files) and in the Windows registry.
Create a New Link (Other Platforms Than ODBC)

link group.
• In the link list, select an existing link group.
• Click .
• On the Actions menu, click New Link.
Caution
• You can import data only into a target table which has a table
table definition.
• If you select a target table which does not have a table definition or has
an incorrect table definition, an appropriate message will be displayed.
In this case you will have to select another target table or modify the
table definition. To learn more about setting the table definition, see
Setting the Target Table Definitions.
4. Under Source, from the Database type list, select a source database platform.
Tip
• Your selection affects the way you connect to the SQL data source and
the dialog box options change accordingly.

Import Utility
5. Type the required information in the other text boxes that are displayed for the
selected platform.
Tip
•The database types that are currently available to you (in the SQL
Data Source list), are those which you have installed during
SmartPlant Instrumentation Setup and those which you have installed
manually on your computer.
6. Click Connect to establish a connection to the selected source.
Tip
If the connection attempt is unsuccessful, an appropriate message is
•
displayed. In this case make sure that the appropriate database server
is accessible to you.
7. From the Table Name list, select the required source table.
9. Click OK.

Import Utility
Using the Link Explorer Window

You can perform the following actions in the Link Explorer window.
Related Topics
• Creating a New Link, page 158
• deleting_links
• Dissociating Links from a Group, page 246
To do With the mouse… From the Notes

this… keyboard…
Move a link Select a link in the left Press Ctrl+X to cut the The link always
pane and drag the link to selected link; press appears below
the new location Ctrl+V to paste in the the position you
new location drag it to; drag
to the group to
make it the first
link in the
group
Copy a link Select a link in the left Press Ctrl+C to copy The link always
pane and hold down Ctrl the selected link; press appears below
while dragging the link to Ctrl+V to paste in the the position you
the new location new location drag it to; drag
to the group to
make it the first
link in the
group
Move a Select a group in the left Press Ctrl+X to cut the If one or more
group of pane and it to the new selected group; press of the links
links location Ctrl+V to paste in the already exists in
new location the target, it is
not deleted in
the source
Copy a group Select a group in the left Press Ctrl+C to copy
of links pane and hold down Ctrl the selected group;
while dragging it to the press Ctrl+V to paste in
new location the new location

Import Utility
Move In the right pane, hold The links

multiple down Shift or Ctrl while always appear
links selecting the required below the
links and drag to the new position you
location in the left pane drag it to; drag
to the group to
make it the first
link in the
group
Copy In the right pane, hold The links
multiple down Shift or Ctrl while always appear
links selecting the required below the
links and drag to the new position you
location in the left pane drag it to; drag
while holding down Ctrl to the group to
make it the first
link in the
group
Change the Drag links up or down in Press Ctrl+X to cut the The link always
link order the group selected link; press appears below
Ctrl+V to paste in the the position you
new location drag it to; drag
to the group to
make it the first
link in the
group

Import Utility
Changing Link Source Paths

You can change the path or name of the source file of an existing link when you need
to update the source path. You can change the source path of a single link or you can
set one default folder for all your links in that group.
Change the Source Path of an Existing Link

1. In the Link Explorer, select the required group and click to expand the group
and display its links.
2. Click to open the Link Definition dialog box where you can edit the selected
link.
3. Click Browse.
4. Navigate to the required source file and click Open.
Specify a New Default Folder for All Links

1. In the Link Explorer, do one of the following:
• Click .
• On the Actions menu, click Folder.
2. In the Default Source File Folder dialog box, click .
3. Navigate to a file in the required folder and click Open.
4. Click Apply.
5. To undo the current default folder settings, click Clear next to the default path.
6. Click Close.
Tip
• You can change the source path only if its platform is a database file
(for example, dBase, Excel, ASCII, and so forth).

Import Utility
Moving Links Between Databases or Domains

You can move the links you have created to other databases or other domains (note
that links are used per domain). This process consists of two stages. First, you
transfer the link information to an ASCII file (export the links) and then you create a
group of links from that ASCII file in the other database (import the links). You can
export and import only a group of links and not an individual link. Hence, if you
want to move a single link, you need create a group to which you associate the link.
Caution
• Make sure that special data such as a tag naming convention is the same in
both databases / domains. In case the naming convention is not the same,
you will not be able to carry out the import process automatically. In this
case you will first need to modify the links of the naming convention of
the required part of the name. The source and the target domain / database
for the links have to be of the same version and subversion of the Import
Utility.

Import Utility
Exporting Links
The first stage in moving a link to another database or domain is exporting a group of
links. When you export a group of links you transfer the information about a group
of links to an ASCII file which has the .imp extension. You can then use the exported
links in other domains or databases.
Export a Group of Links

1. On the Service menu, click Export Links.
2. In the Export Link Groups dialog box, select the link group that you want to
export.
3. Click Export.
4. In the Enter Export Link File Name dialog box, do the following:
a. Type the filename of the link file name (you do not have to add the imp
extension).
b. Navigate to the required location where you will save the link file.
c. Click Save to save the link file.
The link information is saved to an ASCII file which you can use for import (see the
next section to learn how to import saved link groups.)

Import Utility
Importing Links
You can use a file with the .imp extension to create a group of links based on the
information you have saved in this file.
Note
• A number of predefined link groups are provided by Intergraph for use
with the interfaces (for example, PDS, SmartPlant P&ID, CENTUM CS,
and so forth). When you first install SmartPlant Instrumentation, you
must import these link groups as add-ins in the Administration module (an
appropriate license is required). After you have added the predefined
import links, you can export and import them freely between domains.
Import a Group of Links

1. On the Service menu, click Import Links.
2. In the Open File dialog box, navigate to the required ASCII file with the imp
extension which you want to use for import and click OK.
3. At the prompt, click Yes to import the group of links from the imp file you
selected in the Open File dialog box.
4. In the Database Table Definition dialog box, select the Import link table
definition check box to import the table definition saved in the group of links as
well as the links themselves, or clear the check box to import only the group of
links.
5. Under Duplicate table definition names:
• Click Create new to import the link table definition if the imported
table definition name is the same as the current table definition. This
way, the Import Utility will rename the imported table definition by
adding a `$' sign next to the table definition name.
For example, Process Data will be renamed as Process Data$.
•Click Skip to skip the import of the table definition if the current table
definition name is the same as the imported table definition.
6. Click OK to import the group of links.

Import Utility
Setting the Properties for a Link

After you define a link, setting the properties for the link is the next step in the import
setup process.
• To open the Link Properties dialog box, do one of the following:

• Click .
• On the Actions menu, click Properties.
The Link Properties dialog box consists of the following tabs:
• General: Setting general parameters of the import setup process.

• Import mode: From this tab, you can perform the following activities:
• Determining how the utility handles data in the target database.
• Setting parameters for handling source and target data with the same
key definition values.
• Setting refreshing parameters which you use to keep your target tables
up to date.
• Tag/Loop: Setting parameters for loop and tag naming conventions during
the import setup process.
• Source: From this tab, you can perform the following activities:
• Applying a filtering condition to the source data.
• Associating additional data to the currently selected source data.
• Defining source table columns as Instrument Types and Instrument
Type Descriptions.
• Comparison: Reviewing and defining import keys in the target data.
• Import Level: Targeting additional plant hierarchy items.
• Custom: Setting the custom field parameters. This option is only
available when importing instrument index data into the Instrument Index
or Process Data modules - Line.
• Specs: Selecting the specification form and the specification drawing and
revision. This option is only available when importing data into the
• Style: Selecting a browser view that will determine which table columns
will be displayed in the Import Link window.
In this dialog box, you can also click Target Definition to review and modify the
target table definition.

Import Utility
Setting General Parameters

By selecting the Parameter Settings screen General In the Link Properties dialog
box, you control various features which influence the import setup process. The
available options depend on whether you selected to import data to a module or to a
table. The options available will also differ slightly depending on the module that
was selected.
Notes
• When importing from a module where the same set of data appears in
more than one table (for example, loop name and loop name reference
when importing to the Instrument Index module), the Import module
automatically handles the data so that it only appears once in the link.
• Customizing drawing names may come in handy especially when you
want to use revisions for process data sheets, calculation sheets, or both.
However, if you decide to use revisions for any of these sheet types, you
must make sure that the drawing names associated with the process data or
calculation sheet are unique on the plant level.
• The Import revisions, Use custom drawing names, and Create
calculation sheet options may be utilized in conjunction, in which case
you need to +define the links for the appropriate data. You can use the
following table as a guide to the option combinations you can use and the
data for which you need to define the links:
Data to link Import Use custom Create
revisions drawing names calculation sheet
Revisions (Process Data) ü
Process Data drawing names ü
Process Data drawing names ü ü
and revisions
Calculation data ü
Calculation and Process Data ü ü
revisions
Calculation and Process Data ü ü
drawing names
Calculation and Process Data ü ü ü
drawing names and revisions
To handle mismatched data (for example, imported source rows with invalid empty
table columns which are defined as NOT NULL but contain no value) click one of the
following radio buttons:

Import Utility
• Use default value: This option sets any reference columns values in the
target table to zero during the import process if these columns do not
appear in the appropriate reference table.
• Reject rows: This option rejects all source rows that contain reference
columns which do not appear in the appropriate reference table during the
import process.
Note
• Selecting the Use default value option overrides any selections you make
in the Default column in the Table Definition dialog box. To learn how
to use the Table Definition dialog box, see Setting the Target Table
Definitions: An Overview, page 212.

Import Utility
Creating Complementary Elements (Import to Table)

This option allows you to select complementary elements which will be created
during the import of data to a target table. Some elements will be created in the
target database, while for other elements (for example, wiring data) only the
appropriate connection between the relevant items will be established. This option is
available to you when an additional task can be performed during the import process,
and when the appropriate profile definitions exist in target domain. To learn how to
define instrument type profiles, see Defining Instrument Type Default Settings.
When this option is accessible, an additional part of the General tab appears, where
you can select the required function(s) to perform from those available to you.
You can create any of the following elements, if available:
• Create a device panel and a cable for an instrument whose function type
profile indicates wiring, and which has the following default elements:
panel, cable, and connection type.
• Create a drawing row and a default revision row (which is initially empty)
for a specification, process data sheet and calculation sheet.
• Associate tags with the appropriate I/O type, location and hook-up
profiles.

Import Utility
Setting the Import Mode Parameters

The update operation is carried out automatically whenever a source row contains the
same key definition as the target row.
You can:
• Determine the way SmartPlant Instrumentation treats identical source and

target rows by setting the appropriate parameters in the Import mode tab.
• Determine how the Import Utility updates target rows during the import
process.
• Select source and target keys that the Import Utility will use to refresh the
target data during the import process. This option is available to you only
if the source and target tables have been already used in a previous import
session.
Set the Import Mode Parameters for Identical Source And

Target Rows
1. In the Link Properties dialog box, click the Import Mode tab.
• Click Insert & update to enable the Import Utility to insert new
source rows and update existing target rows during the import process.
• Click Insert to prevent the Import Utility from updating target rows
and to enable insertion of only new source rows in the target domain
during the import process.
• Click Delete to delete existing rows in the target domain during the
import process.
• Click Move to move the rows in the target domain to a different
<unit> in the same domain.
3. If you chose the Insert & update option in step 2, select one or more of the
following check boxes:
a. If the source contains a NULL value
• Select to overwrite the target table column even if the
corresponding source table column contains a NULL value.
• Clear to skip source table columns that contain a NULL value.
b. If the source contains a space or a zero value

Import Utility

corresponding source table column contains a space value or a zero
value.
• Clear to skip source table columns that contain a space value or a
zero value.
Tips
• Some database drivers interpret spaces in a source table column as
a NULL value. To avoid incorrect overwriting of data in the
target, it is highly recommended that you select both or neither of
the above two check boxes.
• When inserting null data for table columns of data type String that
can normally accept a NULL value, you can specify the insertion
of a single space instead of NULL. To do so, in the Intools.ini file,
under the [Import] section, type the line:
FillSpace=Y.
4. Do not insert
• Select to skip inserting source rows that do not exist in the target table.
• Clear to insert source rows that do not exist in the target table.
Related Topics
• Setting the Refresh Parameters, page 177

Import Utility
Setting the Refresh Parameters

You can keep tables that you have already used in a previous import session up to
date by refreshing them.
To refresh tables you previously imported, you need to select the same source and
target data as you did in the previous import session. Then you select the appropriate
source and target refreshing keys which are the source and target table columns
according to which contents the target data will be refreshed during the import
process.
If the Import Utility detects a change in the selected source refreshing key contents
(in comparison to the selected target refreshing key contents), the target table
column contents will be updated accordingly.
Refresh Previously Imported Data

1. In the Link Properties dialog box, select the Import Mode tab.
2. Click Insert & update to enable refreshing.
3. Under Refresh from source, select the Apply check box.
4. Click Parameters.
5. In the Refresh Parameters dialog box, under Target:
a. From the Table name list, do one of the following:
• Select the appropriate target table.
• Accept the given default value (the current target table).
Tip
• The target tables which are available to you in the Target section
Table name list depend on your target data type that you selected
in the beginning of the current import session:
• If you selected to import data into a target table, only that target
table would appear in the Table name list.
• If you selected to import data into a target module, all the tables
which are associated with that target module would appear in the
Table name list.
b. From the Refresh key list, do one of the following:
• Select the target table column to refresh during the import process.
• Accept the given default value (the current target table).

Import Utility
6. Under Source:
a. From the Table name list, select the appropriate source table (this data field is
empty by default).
b. From the Refresh key list, select the source table column to refresh from
during the import process (this data field is empty by default).
7. Select View saved parameters to automatically select the last saved refreshing
parameters.
8. Click Delete to delete the last saved refreshing parameters.
An appropriate message is displayed, where you need to either click Yes to delete
the refreshing parameters, or click No to keep the last saved parameters.
9. Click Save to save the refreshing parameters you currently selected in the
Refresh Parameters dialog box.
10. At the prompt to confirm the new selection, do one of the following:
• Click Yes to overwrite the last saved refreshing parameters and return
to the Link Properties dialog box.
• Click No to return to the Refresh Parameters dialog box without
overwriting the last saved refresh parameters.
Tip
• If you enable the data refresh option or select the Overwrite option,
you will be prompted to use data refreshing or overwrite the existing
target data during the current import session.

Import Utility
Filtering the Source Data

You can define a filtering condition which will be used by Import to selectively
import data from the source table. The filtering condition can contain any
combination of the following:
• Source table columns

• Operators or functions
• Alphanumeric values
Specify a Filtering Condition

1. In the Link Properties dialog box, click the Source tab.
2. Select Filter the source table to enable filtering during the import process.
3. Click Modify to open the Import Source Filter dialog box.
4. To create a filtering condition, do one or more of the following:
• In the Source table columns data window, double-click the table
column that you want to add to the filter condition in the data window.
• Under Operators and functions, click the appropriate operator or
function buttons to add the appropriate operator or function to the
filtering condition.
• Under Operators and functions, select the desired SQL function from
the appropriate list. Then right-click the selected SQL function to be
applied in the filter condition.
• In the Import Source Filter dialog box, type the appropriate
expression. You can also add this expression to the filtering condition
already displayed in the Import Source Filter data window.
The Filter feature provides you with the following built-in operators and
functions.
Tip
• The above built-in operators and functions are those used in the
WHERE SQL statement. See your database platform manual to learn
more about database statements.
The Filter feature also provides you with special functions which are native to the
source database.

Import Utility
5. Repeat step 4 to add as many table columns, operators, functions and values as
required.
The new condition appears in the window of the Import Source Filter dialog
box, for example:
6. To check the filter condition syntax, click Verify.

An appropriate message is displayed, notifying you that:
• The condition in the data window is valid - in this case the message
also indicates the number of rows which match the condition.
•The condition in the data window is invalid - in this case you can
correct the condition and try again.
7. To view the way the filtering condition affects the source data, click View Source
(see Viewing the Source Data, page 230 for details).
8. Click OK to close the Import Source Filter dialog box and return to the Source
tab where your condition appears in the data window.
Tip
You can disable the current filtering condition without deleting it. To
•
do this clear Filter the source table after you define a condition.
9. Under Associate source tables, select Apply to associate additional source data
with the source data that you selected when you started this import session. To
make the source data definitions, click Define (see Associating Additional Source
Data, page 236 to learn how to do this).
10. Under Assign process function, select Apply to assign SmartPlant
Instrumentation process functions to the imported data based on their instrument
types. To make the source data definitions, click Define (see Defining Source
Instrument Type Names and Descriptions to learn how to do this).

Import Utility
Importing Data into Additional Plant Hierarchy Items

You use the Import Level tab options when you want to import source tables which
are defined per plant hierarchy item from a database which contains more than one
plant hierarchy item.
In SmartPlant Instrumentation, tables are defined per plant hierarchy item. This
means that when a table is defined at a specified level, it contains data which is
unique at that level.
For example:
The CABLE table is defined per plant. Therefore the CABLE table contains data
which is unique only at the plant level.
When importing data that includes more than one plant hierarchy item, some of the
source rows may recur (due to the existence of several plant hierarchy items). In this
case, you can use the PAU options to instruct the Import Utility to differentiate rows
of different plant hierarchy items during the import process, thus importing data into
the appropriate plant hierarchy items.
Note
• If you do not use the PAU options, the Import Utility will reject all
recurring source rows during the import process (for example, the Import
Utility will not differentiate between rows of different plant hierarchy
items).
When you select to import data into additional plant hierarchy items you can also
specify the level of import, for example, if the Import Utility will differentiate rows
per plant, per area or per unit. If you select to import data per plant or per area, the
Import Utility will reject rows of lower subdivisions (for example, rows defined per
area or per unit).
For example:
If you select to import data per area, the Import Utility will distinguish only rows of
different areas during the import process. However, the Import Utility will reject
rows of different units if an area contains more than one unit.

Import Utility
The Import Utility defines the Primary Key and the Foreign Key columns of the
target table (which you selected in the Link Definition dialog box) in three possible
ways:
1. You select the same import level as the level of the target table (this is the default
option): in this case only the table columns regarding this level (for example,
UNIT_ID, AREA_ID, and so forth) will be automatically defined by the Import
Utility as a Primary Key in the target table.
For example:
The target table is COMPONENT (a table defined per unit) and you select in the
PAU tab the unit level: the UNIT_ID table column is also defined as a Primary
Key column in the target table.
2. You select a higher import level than the level of the target table: in this case all
the table columns regarding the level of the target table and the levels above (for
example, PLANT_ID, AREA_ID) will be automatically defined as Primary Key
columns in the target table.
For example:
The target table is COMPONENT (a table defined per unit) and you select in the
PAU tab the area level. In this case both the AREA_ID table column and the
UNIT_ID table column become Primary Key columns in the COMPONENT
Table.
3. You select a lower import level than the level of the target table: In this case all
the table columns regarding the level you select and the levels below will be
automatically defined as Foreign Key columns in the target table.
For example:
The target table is CHANNEL (a table defined per plant) and you select in the PAU
tab the unit level. In this case the AREA_ID and UNIT_ID table columns become
Foreign Key columns in the CHANNEL Table.
After you select the level for which the Import Utility will distinguish unique data
during the import process, you need to select the tag naming convention which will
be used during the import process.
Note
• When importing data, the Import Utility uses for each tag the tag naming
conventions of the <unit> to which that tag belongs.

Import Utility
Import Data Into an Additional Plant Hierarchy Item

1. In the Link Properties dialog box, click the Import Level tab to make it active.
2. Select Apply to make the options in the Import Level tab active during the
current import process.
3. Under Data import level, select the desired plant hierarchy level for defining the
target table.
4. If you selected to define the import target at the unit level, under Import unit
data using, do one of the following:
• Click Unit name to import the data according to the unit name.
• Click Unit number to import the data according to the unit number.

Import Utility
Setting the Import Mode Parameters

The update operation is carried out automatically whenever a source row contains the
same key definition as the target row.
You can:
• Determine the way SmartPlant Instrumentation treats identical source and

target rows by setting the appropriate parameters in the Import mode tab.
• Determine how the Import Utility updates target rows during the import
process.
• Select source and target keys that the Import Utility will use to refresh the
target data during the import process. This option is available to you only
if the source and target tables have been already used in a previous import
session.
Set the Import Mode Parameters for Identical Source And

Target Rows
1. In the Link Properties dialog box, click the Import Mode tab.
• Click Insert & update to enable the Import Utility to insert new
source rows and update existing target rows during the import process.
• Click Insert to prevent the Import Utility from updating target rows
and to enable insertion of only new source rows in the target domain
• Click Delete to delete existing rows in the target domain during the
import process.
•Click Move to move the rows in the target domain to a different
<unit> in the same domain.
3. If you chose the Insert & update option in step 2, select one or more of the
following check boxes:
a. If the source contains a NULL value
corresponding source table column contains a NULL value.
• Clear to skip source table columns that contain a NULL value.

Import Utility
b. If the source contains a space or a zero value

corresponding source table column contains a space value or a zero
value.
• Clear to skip source table columns that contain a space value or a
zero value.
Tips
• Some database drivers interpret spaces in a source table column as
a NULL value. To avoid incorrect overwriting of data in the
target, it is highly recommended that you select both or neither of
the above two check boxes.
• When inserting null data for table columns of data type String that
can normally accept a NULL value, you can specify the insertion
of a single space instead of NULL. To do so, in the Intools.ini file,
under the [Import] section, type the line:
FillSpace=Y.
4. Do not insert
• Select to skip inserting source rows that do not exist in the target table.
• Clear to insert source rows that do not exist in the target table.
Related Topics
• Setting the Refresh Parameters, page 177

Import Utility
Setting the Tag / Loop Parameters

You can determine the way the Import Utility handles the naming conventions of the
source data during the import process.
Note
• This option is available only if the target table/module you selected
requires naming conventions (for example, COMPONENT Table, LOOP
Table, Instrument Index module, and so forth).
Set the Tag/Loop Parameters

1. In the Link Properties dialog box, click the Tag/Loop tab to make it active.
• Select Define the naming conventions in the link to enable the
Import Utility to define the naming conventions structure
automatically by extracting the naming conventions structure from the
current link.
•Clear Define the naming conventions in the link to define the
naming convention structure manually by entering a naming
convention string in the Define Tag Name Structure dialog box
and/or the Define Loop Name Structure dialog box.
3. If you cleared the check box in the previous step, do one of the following:
• Select Redefine the naming convention to redefine links for the
tag/loop naming conventions parts of the source table.
• Clear Redefine the naming convention to use the current naming
conventions without redefining their links.
Tip
The tag naming conventions are defined in the Administration module.
•
If you select to redefine the naming conventions, you will need to
assign new values (for example, links) to the tag segments.
4. Select Validate tag and loop segments to verify the following during the import
process:
• Whether the instrument type values of the imported tags (in the
COMPONENT table) exist in the Instrument Type table (for example,
the COMPONENT_FUNCTION_TYPE table).
• Whether the loop function values of the imported loops (in the LOOP
table) exist in the Loop Function table (for example, the
LOOP_FUNCTION table).

Import Utility
• Whether the measured variables of the imported loops (in the LOOP
table) exist in the Loop Process Variable table (for example, the
LOOP_PROC table). Note that selecting this option will slow down
the import process.
Tip
• Validate tag and loop segments is selected by default, thus enabling
the validation check of the imported tags and loops before transferring
data. It is recommended you do not clear this box to avoid import
failure due to missing data.
• Select Use the loop reference data to also import loop reference
tables of the COMPONENT table during the import process.
• Clear Use the loop reference data to disregard any loop reference
tables of the COMPONENT table.
Caution
• To prevent import failure, clear Use Loop reference data if the
imported COMPONENT table contains empty loop reference columns.
6. If you selected in the beginning of the current import session to import into the
Instrument Index module, the Use Tag data check box appears in the Tag/Loop
tab folder. In this case, do one of the following:
• Select the check box to include source tag number data from
supporting tables in the current import. You will need to redefine the
naming conventions for all target <units> in the Administration
module before you start the import process.
• Clear the check box to exclude tag supporting table data from the
current import session.
Related Topics
• Defining the Naming Convention Structure, page 194

Import Utility
Setting Custom Parameters (Import to Module Only)

The selections that you make in this tab folder enable you to show in the Import
Link window only those table columns used in a selected Browser module view style.
This way, you can use these columns in creating the current import link.
Note
• This option is available to you only if you selected to import data into the
following modules: Instrument Index, Process Data - Line, or Dimensional
Data for Piping. (See Creating a New Link, page 158 to learn how to
select a SmartPlant Instrumentation module as a target.)
Set Custom Parameters

1. In the Link Properties dialog box, click the Custom tab to make it active.
2. To show the custom fields of a line style in the Import Link (module) window,
under Line, do the following:
a. Select Apply to include the custom fields of the selected style in the Import
Link (module) window.
b. From the list, select the Browser module view style whose custom fields you
want to show in the Import Link (module) window.
3. To show the custom fields of an equipment style in the Import Link (module)
window, under Equipment, do the following:
4. To show the custom fields of a loop style in the Import Link (module) window,
under Loop, do the following:
5. To select the dimensional group to be used in the Import Link (module) window
for importing data to the Dimensional Data for Piping module custom fields,
under Select dimensional group for custom name, do the following:
a. Select Apply to enable a selection to be made from the list.
want to show in the Import Link (module) window. The following options
are available:

Import Utility
• Computed Group Name: Selecting this option automatically

creates the source for the Dimensional Group Name field in the
Import Link (module) window, using the group from the
COMPONENT_DIMENSIONAL table to which the tag defined in
the link belongs.
• All Groups: Selecting this option will import data for all custom
fields in the module. The Dimensional Group Name section in
the Import Link (module) window consists of two table columns:
Dimensional Group CAD Code and Dimensional Group
Description. With this option, you can enter for the source name
an existing group or a new one.
Tip
• In the above cases, all the custom fields are displayed in the
Import Link (module) window and are assigned sequential
numbers.
• (Named Dimensional Group): Selecting this option will import data
for an existing dimensional group. In this case, the name of the group
appears as the source for the Dimensional Group Name table column,
and only the custom fields defined in the group's style are displayed
(with the appropriate names).
• Select Apply to include the custom fields of the selected style in the
Import Link (module) window.
• Clear the check box to import all the groups (equivalent to selecting
All Groups in the list).

Import Utility
Setting the Specification Sheet Parameters (Import

to Specifications Module Only)
When importing data into the Specifications module, the Link Properties dialog box
opens on the Specs tab. You need to select a form for inputting the data to and you
can also select other options that determine how the imported data is presented in
Set the Specification Sheet Parameters

1. From the Specification form data list, select the required spec form (the list is
arranged in alphabetical order and also shows the form numbers) into which the
data will be imported.
The form you select will affect which data tables are actually imported.
2. Click View Form if you want to see what the selected form looks like.
3. Under Specification Drawing & Revision, select the following check boxes as
required:
a. Custom drawing name:
• Select to use a custom drawing name for the imported specification
(you will need to define the name in the link). The drawing names
must be unique.
•Clear to use a default drawing name (made up of the tag number
and suffix).
b. Import revisions:
• Select to include imported data from previous revisions.
Clear to import data only from the last revision.
•
4. Custom drawing name for Process Data:

• Select to use a custom drawing name for imported process data. The
drawing names must be unique.
• Clear to use a default drawing name.
5. If the spec form is defined for multi-tag specifications, select the Multiple-item
specification check box to import the data into a multi-tag specification, or clear
the check box to import the data into a single-tag specification.
6. If the selected form has more than one format defined, do one of the following:
• Select the required format from the Multi-item spec format list.
• Select All formats to select all of the available formats.

Import Utility
Setting the Style Parameters (Import to Module)

Selecting the Style tab in the Link Properties dialog box allows you to control which
table columns are displayed in the Import Link window if you are defining a link
where data will be inserted into reference tables. When creating such a link in the
import to module mode, the Display all fields option lets you display all the data
fields in the target module and not only a limited set of data fields contained in a
special list. This special list is part of the SmartPlant Instrumentation database and it
serves two purposes:
• To shorten the list of table columns displayed in the Import Link window
• To display data field names instead of the table column names used in the
database.
Selecting the Display all fields check box adds the fields to the Import Link window
that are not included in the database list so that all the pertinent table columns are
displayed. The data field names will appear as they are in the database if they are not
included in the database list. The table columns that are included in the database list
will display data field names.
Important
• This option is not available when importing data into the Specifications
module.
Set the Style Import Parameters in the Import to Module

Mode
1. In the Link Properties dialog box, click the General tab.
2. Select the Insert data into reference tables check box.
• Select the Display all fields check box to display in the Import Link
window all the pertinent table columns of the target module.
• Clear the Display all fields check box to display in the Import Link
window only those table columns that are included in the database list.
Related Topics
• Setting the Properties for a Link, page 171

Import Utility
Setting the Style Parameters (Import to Table)

Selecting the Style tab in the Link Properties dialog box allows you to control which
table columns are displayed in the Import Link window if you are defining a link
where data will be inserted into reference tables. When creating such a link in the
ìmport to table' mode, you can select an existing browser view that will determine
which table columns will be displayed in the Import Link window. It is possible to
display all the table columns that are associated with the selected browser view or just
the ones selected in the browser view you highlight in the Style page of the Link
Properties dialog box. If there is no browser view that satisfies the needs of the
current import session, create a browser view in the Browse Manager.
Set the Style Import Parameters in the Import to Table Mode

1. In the Link Properties dialog box, click the General tab.
2. Select the Insert data into reference tables check box.
4. Highlight the required browser view in the data window.
Tip
• Click View to display the list of data field names and table columns
defined in the selected view. Initially only the data fields that are
selected for the current browser view are displayed. If you want to
display all the fields that are available in the Browser to which the
current view belongs, close the View Style dialog box and select the
Display all fields check box. You can now click View again to see
which data fields are displayed. When opening the Import Link
window, all the data fields associated with the current Browser will be
displayed if this check box is selected. You can define a new browser
view if you find no suitable browser view for the current import
session.
Tip
•Click Clear to deselect any highlighted browser view and not to use
any Style parameter options at all.
5. Click Save to apply the style settings.
Related Topics
• Setting the Properties for a Link, page 171

Import Utility
Link Definitions
Defining data links involves:
• Defining the Naming Convention Structure, page 194 (if required)

• Configuring Source Data for Variable Length Fields (if required)
• Opening Import Links, page 199
• Mapping Source and Target Data, page 200

Import Utility
Defining the Naming Convention Structure

This is the stage where you define the source naming conventions of the tag name and
the loop name. You will have to go through this stage in one of the following
situations:
• You have selected the Redefine the naming conventions check box in
the Tag/Loop tab in the Link Properties dialog box.
• You have started a new import session but you did not clear Define the
naming conventions in the link check box in the Tag/Loop tab in the
Link Properties dialog box.
You define the links for the naming conventions in the Define Tag Name Structure
dialog box and/or in the Define Loop Name Structure dialog box depending on
whether the target contains component names, loop names or both. You will have to
complete the definitions in one or both dialog boxes depending on whether the target
table(s) contains one or both naming conventions.
The current naming conventions are those that the Domain Administrator previously
defined in the Administration module.
In the procedure that follows, the Define Tag Name Structure dialog box is used as
an example.
Define Links for Naming Conventions

1. If required, do the following to instruct the Import Utility to put leading zeros in
front of the numeric part of the loop / tag name (for example, to have the Tag 108-
FT 0001 instead of 108-FT 1) for the loops or tags in all the available import
links:
a. On the File menu, click Preferences.
b. In the Import dialog box, click the Tag/Loop tab.
c. Select Insert leading zeros for numeric values and click OK.
2. In the Link Explorer, select the required links that include loop or tag data.
3. Click to open the Link Properties dialog box and click the Tag/Loop tab.
4. Do the following.
a. Clear Define the naming conventions in the link.
b. If required, select Redefine the naming conventions.
c. If required, select Replace null string with space to instruct the Import
Utility to translate any null strings in your source data into spaces.

Import Utility
d. Click OK.
Tip
•It is advisable to select the Replace null string with space check
box if you are not sure if any source table columns are null or not.
• Click to open the links.
• Click to import data using the links.
6. In the Define Tag Name Structure dialog box, select the name of the source
table from the Source Table Column List data window.
Tip
• You can search for a source name in the Source Table Column List
by pressing the key corresponding to the first letter of the source name.
(Make sure you highlight one of the rows in the Source Table
Column List data window first.)
7. Drag the selected source name to the Name Convention window (the target) and
drop it in the appropriate Source Name row.
Tip
• You should ensure that your source data configured correctly if the
loop or tag names are likely to be of variable length (for details, see
Configuring Source Data for Variable Length Fields).
8. In the Start column of the Name Convention data window, enter the starting
location of the string within the naming convention.
Tip
• If you click Cancel in the Define Tag Name Structure dialog box or
in the Define Loop Name Structure dialog box without completing
the tag or loop definition, an appropriate message will be displayed,
after which you will return to the Link Explorer.
9. Select Enable any source name for prefix to allow you to enter any value for the
prefix or clear the check box to restrict the prefix to a fixed value based on the
current plant hierarchy item.
Tip
10. If you are importing data for both loops and tag numbers, you must select or clear
this option for both the loop and tag name structures.
11. Click View Source to view the source table. (See Viewing the Source Data, page
230 to learn more about viewing the source data.)
12. Click OK to proceed with the import setup process.

Import Utility
Configuring Source Data for Variable Length Data

Fields
Where a source data field is likely to vary in length and it is only a sub-string of
another field, you should create a separate data field in the source for each of the sub-
strings (PREFIX, MEASURED VARIABLE, FUNCTION TYPE, and so forth).
For example, the source table may contain the following tags (the instrument type is
indicated in bold type):
108FT100
108ICP100
108FT100
108ILP100
In this case the data field in bold type varies in length according to the particular tag.
Therefore, you need to create a separate data field for each of the parts of the
instrument type, for example:
108 FT 100
108 ICP 100
108 FT 100
108 ILP 100
If you have defined a fixed-name string as a prefix, you do not have to link source
data to this part of the naming convention. The Import Utility will create this part
automatically during the import process.

Import Utility
Primary Keys
Each SmartPlant Instrumentation table contains a Primary Key data field, which,
like the Primary Key table column, is used as a prime key for accessing the table
data. The difference between the Primary Key table column and the Primary Key
data field is that you can only access the latter, whereas the Primary Key table
column is an internal database key used by SmartPlant Instrumentation only.
Example:
The COMPONENT table contains a Primary Key table column, CMPNT_ID, which
is an internal SmartPlant Instrumentation database key, and a Primary Key,
CMPNT_NAME, which contains the tag number. Both of these provide prime access
to the COMPONENT Table but you can use tags (for example, the Primary Key)
only while working in SmartPlant Instrumentation.
If you import data into a target table, you can:
• Allow the Import Utility to generate the Primary Key data field
automatically according to the naming conventions that you will enter; to
do this you will need to manually define appropriate naming conventions
for both the tag and the loop. This way, the Primary Key data field will
contain the value: Computed which means that its contents have been
predetermined by the Import Utility, based on the naming conventions you
entered.
• Use the naming conventions in the link; this way you will need to
manually create the Primary Key data field contents and naming
conventions by specifying the appropriate parts (for example, PREFIX,
SUFFIX). This way, you define the value of all the target data fields that
you require either by typing in the appropriate value in the target data
field, or by selecting the appropriate source table column and linking it to
the desired target data field.
Note
• If you select to import data into a target table you must define the links of
all Primary Key data fields. If you have selected to import data into a
target module, you do not need to define the links to all the Primary Key
data fields, because it is possible to limit the import of data only into
certain target tables.
At this stage you can also:
• Make a more precise selection by selecting the required source and target
rows which will be processed during the import process.
• Select the reference tables you want to import.

Import Utility
• Save the current link to be used in future import sessions.

• View the source rows.
• Perform a test run to evaluate the import process results.
• Carry out the import process.
After you map all the desired source and target data you can make a more precise
selection. You do this by selecting the source and target rows to be inserted updated
or deleted during the import process.
When you finish defining the mapping between the target and the source, you will
come to the end of the import setup process at which point you will be able to carry
out the actual import of data.

Import Utility
Opening Import Links

After selecting the required import links in the Link Explorer, you can open the links
to view or modify the mapping before importing data.
Open Import Links

1. In the Link Explorer, select the required groups or links in the Link list.
• On the Actions menu, click Open Link.
• Click .
3. In the Import Link window, make changes to the link mapping as required.
Related Topics
• Mapping Source and Target Data, page 200
• Viewing the Source Data, page 230

Import Utility
Mapping Source and Target Data

After creating the import links and defining the required parameters, the next stage is
to map the source and target data. Depending on whether the link is used to import
data into a module or a table, you define the link mapping in the appropriate Import
Link window. The table columns that you need to map depend on the target data
type.
Define the Import Mapping

1. In the Import Link window Source Name column, do one of the following:
• Click the desired row under Source Name in the Target data window,
and then select one or more table columns in turn from the Source
data window.
• Type known source table column values.
• Enter a fixed string (for example, a formula) instead of linking source
data. The fixed string must be enclosed in single quotes (`') if it is not
numeric.
• Drag one or more selected table columns from the Source data
window to the desired row under Source Name in the Target data
window.
Tips
• Whenever you drag a new source table column to the Source Name
data field, a + sign is automatically added before the added field, for
example: CMPNT_NAME + FUNC_DESC + FUNC_TYPE...
You can use formulas and arithmetic functions in the Source Name
•
column (for details, see Using Formulas and Arithmetic Functions in
Import Links, page 203).
2. Modify the data fields, if desired, as follows:
• Transfer a sub-string of a source table column value by adding the
starting character and the length of string parameters both between
brackets. For example, cab_name (3,2) indicating that you want to
transfer two characters from the cab_name table column starting from
the third character.
• Add an '&' symbol before the table column value to instruct Import to
trim any leading and / or trailing spaces in the source data.
• Add a '+' sign followed by a '#' sign to indicate the end of the current
line so that the rest of the values appear on the next line ( ...+#).

Import Utility
• Type @PROC_FUNC_NAME to use the predefined process function

macro. You can use this macro only if you have defined the required
process function in the Source tab folder of the Link Properties
dialog box and selected the Apply check box (see Associating Source
Tags with Instrument Types, page 238). This macro will be entered
under Source Name automatically whenever the
PROC_FUNC_NAME table column exists in the target table.
Tips
• The process function macro must appear on its own in the Source
Name column – it cannot be used with formulas or other strings.
• If the total length of the Source Name data field is longer than the
target field length (in the Length data field of the Target data
window), a scissors symbol ( ) appears to the left of the Source
Name data field.
• The target Primary Key data field and the target foreign key naming
conventions are represented by special templates which describe
different parts of the naming convention, for example:
• AAA-FFFF-9999\S
• AAA-EBBB-9999\S, and so forth.
• In a naming convention template:
• Each letter stands for a single character/digit, for example, AAA
stands for a three character part.
• Each group of repeating letters stands for a different segment/part
of the naming convention, for example, EBBBB describes two
segments/parts, where the E part contains one character part and
BBBB describes a four character part.
• Separators appear as selected for the target domain, for example, -
(hyphen), \ (backslash), and so forth.
• The naming convention template depends on the naming
conventions and the standard defined for the target domain in the
3. After defining all desired settings in the Import Link (table) or Import Link
(module) window, do one of the following:
• Click to start an import test run which helps you evaluate the import
results without saving data to the target table/module (see Testing the
Import Process, page 208).
• Click to start the import process (see the following procedure).

Import Utility
• Click to save the current link settings in the Import Utility. You
can use the saved link in other import sessions.
Tip
• In the Target data window, the names of the target data fields appear
in the following colors:
• Red — Primary key data field (must be defined)
• Blue— Foreign key data field
• Black
• Magenta — A data field defined as `NOT NULL' and which is
defined in the Table Definition dialog box as `NOT DEFAULT'.
Caution
• When importing data to a target module, you don't need to define the
Primary Key links. However, if you want to import any part of a table,
its supporting table, or its reference tables, you must define that table's
Primary Key links.

Import Utility
Using Formulas and Arithmetic Functions in Import

Links
When defining an import link, as an alternative to using individual source table
columns dragged from the left area of the dialog box, you can also link together
several values in the Source Name data field and use them as a single source. For
example, the source used for the drawing name is dwg + equip which is a
combination of the drawing ID and equipment ID (the `+' character is entered
automatically if you select both sources by dragging them to the same data field).
The source can be composed of several different functions using the arithmetic
operators (+, -, /, *) in addition to the string operators. The following conventions
apply:
• Arithmetic operators are treated as such only in data fields whose table
column type is number.
• Each arithmetic operator is preceded by the `!' character, for example:
param1 !+ param2 !- param3(If the values are: param1 = 2, param2 = 10, and param3
= 5, the result of the above formula will be 7.)
• Constants must be enclosed within single quotes, for example:

param1!+ `2' !* `5'
(Since the operations are performed from left to right, if the value of param1 is 2, the
result of the above formula will be 20.)
In the following example, the fluid temperatures are calculated using the base
temperatures in the following formulas:
• Normal temperature = Base temperature + 10

• Minimum temperature = (Base temperature + 10) / 1.2
• Maximum temperature = (Base temperature + 10) * 1.2
The syntax used by the Source Name data field is entered as follows:

Import Utility

Import Utility
Working with Reference Tables

This option enables you to specify that the Import Utility will insert new data into
selected reference tables when required. The Import Utility will insert new reference
data into the target reference tables during the import process whenever data exists in
the source table but it is missing in the target table.
Note
• This option is available only if you have selected Insert data into
Reference Tables in the Link Properties dialog box (for details, see
Setting the Properties for a Link, page 171).
Select the Reference Tables

1. In the Import Link window, click Ref. Tables.
2. In the Reference Table List dialog box, do one of the following:
• Select the appropriate reference tables for which you want the Import
Utility to insert new data during the import process when required.
• Clear the selected reference tables for which you want the Import
Utility to reject all new source data.
3. Click OK.
Tip
• If you click in the Import Link window without having selected a
reference table in the Reference Table List dialog box, the Import
Utility will insert by default a new row into the appropriate reference
table whenever possible.

Import Utility
Executing the Import of Data

After you finish defining the links between the source and target, you come to the end
of the import setup process. Now you can execute the import of data.
Caution
• The import process is irreversible: once you carry out the import process,
you cannot undo the changes Import made to the target database. We
therefore recommend that you use the Test feature to check the import
process before carrying out the actual data transfer.
At this stage the Import Link window is open and contains all the appropriate
definitions.

Import Utility
Execute the Import of Data

• In the Import Link window, click .
The Import Progress dialog box opens, displaying the following information:
Data Field Description

Source Table The total number of rows and number of rows currently imported
Rows: Total / in the currently selected source table.
Current
Target Table The number of rows of the current table that have already been
Rows processed by the Import Utility during the current import session,
according to their status (Inserted, Updated, Deleted, or Rejected).
Tables / Rows in The percentage of data which has already been processed (for a
current table module import link) for the entire module and for the table
(progress bars) currently being processed.
Progress bar The percentage of data which has already been processed (for a
table import link).
Cancel Stop the import process during execution.
Report View the report on rejected rows. This button is available only if
any rejected rows occurred and if you selected the Rejected data
report check box in the Link Properties dialog box. This option
allows you also to generate a hard copy of the current report.
(This button becomes active only after the import process was
stopped or was completed.)
Information View the import process information: the target table name and
the row count before and after import. (This button becomes
active only after the import process was stopped or was
completed.)

Import Utility
Testing the Import Process

You can run a test of the import process according to the parameters you have set in
the Import Link window. The test run will check the import process without
carrying out the actual import of data (for example, without inserting, updating or
deleting rows of the SmartPlant Instrumentation database).
Testing the import process can be useful when testing a single link before carrying
out a large batch operation. A test run is carried out slightly faster than the actual
import operation. It can give you an idea how the actual import will be carried out
depending on your computer hardware and load of the imported data. It can also give
you an indication on the rejected row(s) and allows you to fix the problem prior to a
batch operation.
Note
• You can perform a test run of a sub-set of the selected source and target
data by applying the appropriate filtering condition to the data (see
Filtering the Source Data, page 179) and / or partially linking the source
and target data (see Mapping Source and Target Data, page 200).
Test the Import Process

• With the Import Link (table) or Import Link (module) window open,
click to start checking the import process.
Note
• It is recommended that you define a log file, if you have not yet done so.
The Import Progress Test dialog box opens, where you can view the expected
import process results.
Note
• The test results will be inaccurate when:
• Importing data in a group of links of which some links are related as in the
example: cable, cable set, and wire.
• Importing one or more source tables containing multiple prime values.
Related Topics
• Link Groups, page 244

Import Utility
Import Comparison
After you have run an import session on a set of data at least once, you can run
subsequent sessions by comparing the new rows to be imported with previously
imported rows. You can do this from the Import Comparison List dialog box as
well as from the Comparison tab in the Link Properties dialog box. You can also
start transferring data after you have selected specific rows that you want to import
from the source to the target. For details of the import comparison criteria and how to
modify them, see Setting the Target Table Definitions.)

Import Utility
Run the Comparison List

• In the Import Link window for a table or module, click .
•Specify the deviation options in the Parameters Settings dialog box
Comparison tab. This method applies only if you started this import
session using a saved link.
2. In the Import Comparison List dialog box, under Show, click All to display all
the data rows.
Tip
•If you have already defined a source filter condition in this session (in
the Link Properties dialog box), only the source rows which comply
with this condition will be displayed in the Import Comparison List
dialog box. See Filtering the Source Data, page 179 for details.
3. Select the required data rows to be processed for import by doing one of the
following:
• Select the check box in the Select column for each row you want to
include.
• In the Select rows section, click the All radio button to select all the
rows.
In the Select rows section, select one or more of the check boxes to
•
include all the rows where the mode corresponds to the selection.
4. Select Re-open the Comparison List.
Tip
•Rows where data was changed are highlighted in light blue.
5. Click Test to check the import process without actually saving data to the target
table.
6. Modify the link mapping, if required, to correct any errors.
7. Click Run to import the data.

Import Utility
Setting the Import Comparison List Options

During the import process the Import Utility modifies the contents of the SmartPlant
Instrumentation database (for example, the target module or table). This is done by
inserting, deleting and updating rows in the SmartPlant Instrumentation database. It
is therefore advisable to be able to coordinate between these rows before you start the
import process.
This feature provides you with the means to coordinate between the rows to be
inserted, deleted or updated during the import process. You do this by reviewing the
source and target rows and selecting the appropriate rows which will be processed
Note
• The Comparison tab only becomes active after the first time you have
imported data and saved the selected link.

Import Utility
Setting the Target Table Definitions: An Overview

You can control the way in which the Import Utility regards the source and the target
rows as identical during the import process. This is important, because when the
Import Utility encounters identical source and target rows, it can overwrite the target
row or leave it intact, depending on the Comparison options which you select in the
Link Properties dialog box. You can therefore control the import process result by
selecting the appropriate import comparison criteria.
In SmartPlant Instrumentation, the database is organized in tables, for example:

CABLE, COMPONENT, CONTROL_VALVE, and so forth. These tables contain
data arranged in table columns, which represent properties of various item types such
as tags, cables, panels, and so forth.
For example, the COMPONENT table contains all the tag data together with the
appropriate links to other tables, which utilize tags, such as: COMPONENT_MFR
(Manufacturer table), COMPONENT_MOD (Component Model table), and so forth.
In the following example, the COMPONENTS table primary key is CMPNT_ID.

This means that each row in the COMPONENT table has a different value for the
CPMNT_ID table column.
The CABLE_MFR_MOD table key definition consists of the CABLE_MFR_ID and

CABLE_ MOD_ID keys. These keys ensure that the value of any particular cable
model is unique. Both keys are required because different manufacturers may use the
same model number, and therefore the manufacturer name must be included to
specify model uniqueness, as shown in the following example.

Import Utility
Every SmartPlant Instrumentation table has a key definition, which is used to specify
a unique set of values. You can use one or more table columns in each table as
components of the key definition.
Key Name – This is found in every table and is used only by SmartPlant
Instrumentation to access the corresponding table. The key name table column is
usually denoted by an _ID' suffix. In most cases, the key name is designated as a
primary key.
Reference Table Column – A reference table column is found in every table and is
used by the user to access the table. For the COMPONENTS table, the reference
table column is CMPNT_NAME. This means that each row in the COMPONENT
table has a different value in the CPMNT_NAME table column.
Foreign Key – In some tables, the key name is designated as a foreign key, which is
used as a reference table column to link to another table called a reference table. For
example, the CPMNT_MFR_ID foreign key in the COMPONENT table contains the
COMPONENT_MFR (Manufacturers) table value in its key definition. This way, the
CPMNT_MFR foreign key table column links the COMPONENT table to the
COMPONENT_MFR table. This allows SmartPlant Instrumentation to obtain the
required tag's Manufacturer data from the Manufacturer table.

Import Utility
Regular Table Column – This is found in most tables and contains the appropriate
table data such as Color, Item price, Remarks, Specifications, and so forth.
Caution
• Changing the settings in the Table Definition dialog box alters the
relations between the tables. We therefore recommend you do not change
these settings unless absolutely necessary and only if you are familiar with
the SmartPlant Instrumentation database structure.
Notes
• Both the key name and the reference table column provide access to the
SmartPlant Instrumentation database, but only the reference table column
is accessible to you (the key name is for SmartPlant Instrumentation
internal use only).
• When comparing rows, the Import Utility treats source and target rows as
identical only if both the source and the target Reference Table Column
values are the same. For example, if the COMPONENT table in both
source and target rows contains the same values in the Reference Table
Column data fields, both rows are considered as identical.
• When the Import Utility encounters identical source and target rows it can
either replace the contents of the target row with the source row contents
or leave this target row intact, depending on the import process settings.
You can select an appropriate reference table column for every table in the database.
This way you can create a different comparison criteria for each table.
You can also create a link to other tables by defining appropriate foreign key table
columns. This way the Import Utility imports additional reference data during the
import process, depending on the selection you make in the Source tab (in the Link
Properties dialog box).
You can perform the following actions:
• Modify the target table primary key and foreign key table column
definitions.
• Clear the current definitions of table columns.
• Save the changes that you make to the table structure in an existing
structure definition or create a new definition.

Import Utility
Modifying Table Column Definitions

Use this procedure to modify the table column definitions in the target database.
Modify Table Column Definitions

• On the Service menu, click Target Table Definition.
• With the Link Properties dialog box open, click Target Definition.
Tip
• If you open the Table Definition dialog box by clicking Target
Definition in the Link Properties dialog box, you will not be able to
modify the definition of tables other than the one you selected in the
Link Definition dialog box.
2. In the Table Definition dialog box, under Table List, highlight the table whose
column definitions you want to modify.
The appropriate option button (beneath the Table List section) becomes
automatically active. This option button indicates the plant hierarchy level of the
table in the target domain.
Tip
• Table Definition Note
3. Click Definition.
4. In the Definition Names dialog box, do one of the following:
• In the Description data window, select an existing definition.
• Click Insert to add a new definition in the Description data window
and type the new definition name.
Tip
• For certain tables with several available existing definitions, you must
select a definition that is appropriate for the type of association of the
items that you are going to import. For example, when importing
panel-strip data, you might have some panels with direct connections
to strips, and other panels that include items above the strip, such as a
panel- rack-apparatus-strip association. In this case, you would create
several links, each with an appropriate definition for the desired
association.
5. Click OK to return to the Table Definition dialog box.

Import Utility
6. In the Column Definition section:

a. Select Visible for each table column you want to display in the Import Link
window.
b. Select Default for each table column to apply the default value (space, zero or
asterisk) in the case where the data field is empty during the import process.
Caution
• For some table columns (for example, primary keys) the Import
Utility automatically clears the Visible check box. We recommend
that, to avoid import failure, you do not make these table columns
visible.
Tip
• Column Definition Colors
c. To set the type of the table column selected under Key Definition, do one of
the following:
• Click Primary key to use this table column as a primary key.
• Click Foreign key to use this table column as a foreign key, then
double-click to close the Foreign Key List window (see the

following step for more details).
• Accept the given default values.
Tip
• Column Status Note
d. To modify the definition of a foreign key, with the Foreign Key List window
open, drag the required foreign key from Foreign Key List to Key Definition
in the Table Definition dialog box.
Tip
• Key Note
e. To link the selected table column to a reference table:
a. From the Reference Table list, select the appropriate reference table.
b. From the Reference Column list, select the appropriate Primary Key
data field.

Import Utility
c. field.
Tip
• The value under Reference Column can be one of the
following:
• A table column name in the current table, if the current key
is not a foreign key.
• A table column name in the reference table specified under
the Reference Table column, if the current key is a foreign
key.
d. From the Reference Key list, do one of the following:
• Accept the given default values (recommended).
• Select the appropriate reference key if required.
Caution
• Key Caution
e. To determine the way the current key will be numbered in the target
database (note that this is an internal value which is not accessible to you),
• Select the Local check box to follow the previous- level
numbering to make the currently defined table column address
unique in the target database.
• Clear the Local check box to follow the global numbering in
Tip
f. To modify the definition of the additional column of the current table:
a. Drag the appropriate table columns from Column Definition to Key
Definition.
b. Specify the data fields that the Import Utility will create during the
import process before generating a selected target data field by
selecting Define parameters for Level Key. This way, the Import
Utility will create the table columns specified under Level Key (in the
Column Definition data window) before creating the corresponding
table columns under Column Name.
c. In the Column Definition data window, click to view the Level
Key data column.

Import Utility
d. In the Level Key data column, do one of the following:

• Type the names of the table columns to be created by the
Import Utility during the import process before it creates
the corresponding table columns under Column Name.
• Clear Define parameters for Level Key to discard the
table columns specified under Level Key.
Tip
• Key Level Note
e. Repeat all of the above steps in this procedure for each table column.
f. Click OK.
g. At the prompt, click Yes to confirm the changes and clear the Key Definition
data window.
Tip
• You can select another table and skip the changes you made to the
current table as follows:
• In the Table List data window, select another table.
• Click Definition and then click No in the message dialog box.
h. Click Save to save your selection of table keys.
i. At the prompt to confirm the new definitions, do one of the following:
• Click Yes to open the Definition Names dialog box and save the
new definition.
• Click No to return to the Table Definition dialog box and modify
your definitions.
j. Repeat steps 1 through 16 of this procedure for each required table.
k. Click Close to close the Table Definition dialog box and return to the Link
Explorer.

Import Utility
Modifying Table Column Definitions - Table

Definitions Note
Every SmartPlant Instrumentation table is defined at a specific plant hierarchy item
level. This means that the value of the primary key column of that table is unique on
the specified level.
For example:
The primary key column value of the COMPONENT table is CMPNT_NAME. If

you define the COMPONENT table on the <unit> level, then the CMPNT_NAME
value will become unique on the <unit> level. This means in the <unit> level there
cannot be more than one row with a particular value in the CMPNT_NAME table
column.

Import Utility
Modifying Table Column Definitions - Column

Colors Note
• The table columns appear under Column Definition in four possible
colors:
• Red— Primary key (must be defined)
• Blue— Foreign key
• Black— Regular column in the specific target table
• Magenta— Reference table column which is defined as a regular
table column (for example, not used to get linked data)
• In SmartPlant Instrumentation, each table column has a numeric address
which is used in the SmartPlant Instrumentation database to access the
information in that column. In the Table Definition dialog box you can
determine that the table column address will be unique either in the target
database (for example, locally) or in SmartPlant Instrumentation.

Import Utility
Modifying Table Column Definitions - Column

Status Note
You can use the Column status radio button also to change the target table column
type (for example, from char to number and vice versa). This is required if the
source table column and the target table column are of different types (for example,
one table column is defined as char and the other is defined as number). In this case
you can change the column type of the target table into char by defining it as a
foreign key or change the table column type into number by deleting this column key
definition (see Deleting the Column Key Definitions to learn how to delete the column
key definition).

Import Utility
Modifying Table Column Definitions - Key Note

A primary key and a foreign key may contain more than one table column.
For example:
The CABLE table primary key can contain both CABLE_ID and CABLE_NUM
table columns. Each key is numbered in the table. If a key contains more than one
table column, each table column is numbered in the key.
For example:
If CABLE_ID and CABLE_NUM are the table columns comprising the CABLE
table primary key, then each table column has a serial number within the CABLE
table primary key (for example, 1 and 2).

Import Utility
Modifying Table Column Definitions - Key Caution

Selecting a value for the Reference Key table column is not required if the current
key is a not a Foreign Key.
When the current key is a foreign key, two situations are possible:
• The value in the Reference Key data column is the same as the one
specified under Key Name; in this case the Reference Key data column is
left empty.
For example:
If using the CABLE_MOD_ID from the CABLE table in the key definition, the key
name CABLE_ID is identical to the reference key.
• The value in the Reference Key data column is different from the one
specified under Key Name; in this case the appropriate value appears
under the Reference Key data column, and the column title Reference
Key is displayed in bold text.
For example:
If using the CONNECTOR_SIDE1_ID from the CABLE table in the key definition,
the key name CABLE_ID is different from the reference key, the value of which in
this case is CONNECTOR_ID.

Import Utility
Modifying Table Column Definitions - Numbering

System Note
The software uses three numbering systems:
• A global numbering system: this way the selected key number originates
from a general number list that applies to the entire system.
• A local numbering system: this way the selected key is numbered within a
table or an object (for example, Panel, Cable, and so forth). For example:
• The PANEL_STRIP table Primary Key field consists of two sub-
fields:
• PANEL_NAME that originates from the PANEL Table and is
numbered globally.
• STRIP_NAME which is numbered locally.
This means that in every new panel, the strip numbering restarts from 1, whereas the
panel numbering continues the global numbering which exists in SmartPlant
Instrumentation.
• A local revision numbering system: this is a local numbering method

which starts from zero instead of from one.

Import Utility
Modifying Table Column Definitions - Key Level

Note
The key level operation is designated for tables that contain strip data
(STRIP_CONFIG, STRIP_MFR, and so forth).
You can specify what fields the Import Utility creates during the import process prior
to generating a selected target field. You do this by activating the level key option
and specifying the required target field(s) to create prior to generating the selected
target field.
For example:
The Strip Manufacturer Models (STRIP_MFR_MOD) table Primary Key field

contains two columns: STRIP_MFR_ID and STRIP_MOD_NAME.
To generate the STRIP_MOD_NAME field, the Import Utility will create the
STRIP_MFR_ID and the STRIP_MOD_ID fields prior to generating the
STRIP_MOD_NAME field.
If you select Define parameters for Level Key, the Import Utility will automatically
create the fields which you specify in the Level Key field (in the Column Definition
data window) prior to generating the corresponding field in the Column Name data
field.

Import Utility
Deleting Table Column Key Definitions

Use this procedure to delete existing table column key definitions.
Delete Table Column Key Definitions

1. With the Table Definition dialog box open, select the required table in the Table
List data window.
2. Click Definition.
3. In the Definition Names dialog box, under Description, select the required
definition.
• Click Delete to delete the required definition.
• Click OK to display the columns of the selected table in the Table
List data window.
The appropriate table columns appear in the Column Definition section. The
comparison definition also appears under Key Definition.
5. Click Delete Key to delete all the key definitions of the selected table.
6. At the prompt, click Yes to confirm the deletion
7. Click Save to save your selection of table keys in the Import Utility.
8. At the prompt, click Yes to save the changes you performed.
9. Repeat steps 1 through 8 of this procedure for every required table.
10. Click Close to close the Table Definition dialog box and return to the Link
Explorer.

Import Utility
Viewing the Source and Target Rows

You can view the source and target rows according to the selection you made, or per
process (for example, rows that will be inserted, rows that will be deleted, and so
forth).
View the Source And Target Rows

1. Under Show, do one of the following:
• Click All to view all target rows.
• Click Selected to view only the selected target rows. Selecting this
option displays only the rows you have previously selected.
• Click by Mode to view the displayed rows according to their import
mode.
2. Under Import mode, do one or more of the following:
• Select Inserted to select all the source rows whose status is Insert (for
example, the letter Ì' appears in the Mode column).
• Select Updated to select all source and target rows whose the status is
Update (for example, the letter Ù' appears in the Mode column).
• Select Deleted to select all source rows whose status is Delete (for
example, the letter `D' appears in the Mode column).
• Select Refreshed to select all source and target rows whose status is
Refresh (for example, the letter `R' appears in the Mode column).
Tip
• You can select more than one import mode by which the data in the
data window will be displayed. This way you show the source and
target data by more than one import mode.
3. Click Display to display rows according to the filtering options selected under
Show.

Import Utility
Filtering the Displayed Target Rows

You can filter the target rows displayed in the Import Comparison List dialog box.
Note that filtering the target rows this way will not affect the target rows currently
selected to be included in the import process.
Filter the Displayed Target Rows

• At the bottom of the Import Comparison List dialog box, click Filter to
open the Import Target Filter dialog box.
The source table columns available in this data window are only the ones currently
displayed in the Import Comparison List dialog box. These are the same table
columns that you linked in the Import Link window.
Related Topics
• Filtering the Source Data, page 179

Import Utility
Printing the Import Comparison List

This option enables you to preview and print out the source and target rows displayed
in the Import Comparison List dialog box.
Preview And Print Out the Source And Target Rows

• At the bottom of the Import Comparison List dialog box, click Report.
A preview window opens, where you can view and print out the displayed data.

Import Utility
Viewing the Source Data

This feature enables you to view the contents of the source table or database file that
you selected when entering the Import Utility. You can access this feature from the
following locations in the Import Utility:
• Link Definition dialog box (after you select the source data)
• Import Source Filter dialog box
• Import Link window
View the Source Data

• Do one of the following to display the Source Data window:
• In the Import Link window, click .
• In the Link Definition dialog box or the Import Source Filter dialog
box, click View Source.
You can perform the following actions:
• Display selected fields of the source data.

• Sort the displayed source data.
• Filter the displayed source data.
• Display the number of rows in the source data.

Import Utility
Displaying the Source Data Fields

The following viewing options are available:
• View all source data fields.

• View only linked source data fields.
• View only selected source data fields.
Select the Desired Viewing Option

1. With the Source Data window open, do one of the following:
• To view all the source data fields, on the View menu, click All Fields.
• To view only the fields of the displayed source data which are linked
to other tables or to the database, on the View menu, click Linked
Fields.
Tip
• You can view linked data fields only if you have already defined the
links between the source and the target data fields in the Import Link
window or if you have already used the definitions of a previously
saved link.
• To view selected source data fields, do the following:
a. On the View menu, click Display Fields.
b. In the Display Source Fields dialog box, drag the data fields you want to view
from Source Fields to Selected Fields.
c. Click OK.

Import Utility
Sorting the Displayed Source Rows

You can perform an alphanumeric ascending sorting of the information displayed in
the Source Data window according to one or more selected data fields.
Note
• Sorting the source data in this dialog box does not affect the import
results.
Sort the Displayed Source Rows

1. With the Source Data window open, on the Sort menu, click Custom Set.
2. In the Display Source Fields dialog box, drag the data fields by which you want
to sort the displayed source data from Source Fields to Selected Fields.
3. Click OK.

Import Utility
Filtering the Displayed Source Rows

You can filter the source data displayed in the Source Data section according to the
filtering condition you defined in the Source tab in the Link Properties dialog box.
To use this option, you must define a filtering condition.
Filter the Displayed Source Data Fields

• With the Source Data window open, do one of the following:
• On the Filter menu, click On to filter the displayed source data
according to the filtering condition you previously defined.
• On the Filter menu, click Off to display the source data without
filtering it.
Related Topics
• Filtering the Source Data, page 179

Import Utility
Associating Imported Tag Numbers with the Correct

Instrument Type Descriptions
The instrument type of a tag is an important part of the initial information for building
a tag. This is true both when working with SmartPlant Instrumentation as an
application as well as when entering tags using the Import Utility. The instrument
type information is designated in the function part of the instrument tag (for example,
100- FY400). Sometimes the source data lacks an instrument type description, for
instance, there is an FY function type name that is an I/P Converter and also a
Solenoid Valve. This option enables you to specify that each imported tag number
will be associated with the correct instrument type description.

Import Utility
Associate Tag Numbers With the Correct Instrument Type

Descriptions
1. Click Service > Preliminary Function.
2. On the Preliminary Function dialog box, click OK.
3. On the Select ODBC Profile dialog box, select the appropriate data source and
click OK.
Tip
• For this option, you can select only .dbf and .xls data file sources.
4. On the Enter File Name dialog box, navigate to the appropriate ODBC data
source file and click Open.
5. On the Preliminary Function dialog box, in the Source column list data
window, drag the appropriate column you will use for the instrument type name.
6. Repeat the previous step for each of the other properties: Instrument type
description, Process function type, and Tag number.
8. In the Define Function Type dialog box, do the following:
a. In the Function Type section, select a function type name from the Name
column.
b. In the Description column adjacent to your selection, display the list, and if
more than one description is available, select the required description.
c. Do one of the following:
• In the Tag Number section, select the instrument tags you want to
associate with the selected function type.
• In the Function Type section, select the All check box to associate
all the available instrument tags with the selected function type.
d. To use the same function type name with more than one description for
different instrument tags, click Duplicate and for the new row select the
required description from the list.
9. Click OK after you finish associating all function type names and tag numbers to
SmartPlant Instrumentation component function types.
Caution
• You need to associate all tag numbers to successfully import tags later.
content="Associating_Additio nal_Source_Data">

Import Utility
Associating Additional Source Data

You can import additional data and associate it to the source table that you selected in
the Link Definition dialog box. This way you can import data into your database
from more than one source table. You do this by associating columns from other
tables or database files with the source table or database file. The associated columns
automatically become a part of the source data which you have selected in the Link
Definition dialog box.
Note
• You can use associations which have been previously saved in a link. To
do this you have to start the import process using a previously saved link.
Associate Additional Data to the Source Table / Database

File
1. Select the desired link and click .
3. Under Source tables, click Define.
4. In the Associate Source Data dialog box, click Add to add a data set (for
example, a table or a database file) to the Source list data window.
5. Repeat the previous step to add as many data sets as required.
Tip
It is possible to use the same table more than once as a source.
•
6. Highlight the desired data set to associate to and under the Association group
box, click Select.
The selected data set is copied to the Source for association data window.
7. Expand the data sets as desired in each data window by double- clicking them,
then drag the required item in that data set to the appropriate data set item in the
Source for association data window.
The association between the two data items is indicated by the appearance of an
icon ( ) to the right of each data item in the appropriate section.
Caution
• In SmartPlant Instrumentation, table columns contain numbers (num
type columns) and characters (char type column). You cannot
associate a num type column with a char type column or the other
way around.

Import Utility
8. Repeat the previous step to associate other data items as desired.

Tip
• You can associate several items with a single data set item, however,
you cannot associate data from a data set with itself.
• To delete an association, select the desired item in the Source for
association data window and press Delete on the keyboard.
9. Click Verify to make sure your selections are valid (this way you can check, for
example, whether the associated table columns are both of the same data type –
numeric or alphanumeric).
An appropriate message is displayed: if the associations are valid, the total
number of rows of the source data set (including the associated data) is indicated,
or else you are notified that the associations are invalid, in which case you should
correct your selection in the Source Associations dialog box.
10. Click Confirm.
11. At the prompt, click Yes to save your associations.
The data sets disappear from the right data window and appear at the top of the
left data window.
12. To make the fields of the associated data appear in future dialog boxes, do the
following:
a. Expand the associated data sets by double-clicking them.
b. Click once on every item you want to view.
The icons appear as follows:
• Item selected: , Item not selected:

Tip
• You can view the contents of an associated data item in the Import
Link window. To be able to view the associated data, click when
available, after you select the required table (see Viewing the Source
Data, page 230 to learn how to view the source data).
Caution
• Make sure you remove all disassociated tables from the data windows
in the Source Associations dialog box before you click Save.
13. Click Save to save your association.
14. In the Link Properties dialog box, under Source Associations, do one of the
following:
• Select Apply to use your associations in the current import process.
• Clear Apply to skip the defined associations.

Import Utility
Associating Source Tags with Instrument Types

In SmartPlant Instrumentation, the Instrument Type of a tag is abbreviated and
therefore needs to be associated with a description that provides more information
about that instrument type, for example, the Instrument Type FV description is Flow
Valve.
Sometimes an instrument type, which is used as an acronym, may not be unique. For
example, in SmartPlant Instrumentation, FE can stand for both Flow Element and
Mass Flow Sensor.
If a source database that you import data from does not utilize instrument types or
instrument type descriptions, or if the source instrument type is not associated with a
process function, you need to associate the desired source data fields manually and
define them as instrument types, instrument type descriptions, and process functions.
See Instrument Index, Supporting Properties Tables to learn how to view and modify
instrument type and process function data in SmartPlant Instrumentation.
Note
• The combination of the instrument type name and description provides a
unique identifier for a tag's instrument type.
Associate Source Tags With Instrument Types

1. In the Link Properties dialog box, select the Source tab and under Process
Function, click Define.
2. If this is the first time you are running the link, in the Define Instrument Type
Fields dialog box, do the following. For more information, see Guidelines for
Selecting Source Fields:
a. From Source, drag the desired table column to Instrument type name.
b. From Source, drag the desired table column to Instrument type description.
c. Click OK.
3. In the Process Function Mapping dialog box, for each instrument type the left
section, drag the appropriate process function from the right section to either a
light-blue field (unassigned process function) or a white field (assigned process
function) in the Process function column next to the appropriate instrument type.
When done, click OK.
Tips
• After the first time you run the link, some of the instrument types will
already have process functions defined by default – these are

Import Utility
displayed with a gray background, and you cannot reassign the process
functions for them.

Import Utility
Guidelines for Selecting Source Data Fields

After you select the source table columns (data fields) to be used for the instrument
type name and the description, the Import Utility will refer to these data fields as
such. This means the source data and will be imported from the source database to
SmartPlant Instrumentation with respect to the values in the source instrument type
name and description fields that you selected. Therefore to carry out a successful
import you need to select the table columns which are most compatible with the
SmartPlant Instrumentation instrument type, instrument type description, and process
function conventions.
Use the data in the following table as guidelines when selecting source table columns
and defining them as instrument type data fields and instrument type description data
fields:
Parameter SmartPlant Instrumentation Conventions

Instrument Type maximum 6 characters
length
Instrument Type typeface upper-case (for example, FY - not - fy or Fy)
Instrument Type values These must start with a process function letter which
can be one of the following:
F (Flow)
L (Level)
P (Pressure)
T (Temperature)
A (Analyzer)
C (Control Valve)
R (Relief Valve)
Instrument Type Description 40 characters
maximum length
Define And Associate Source Instrument Type And

Instrument Type Description Data Fields
1. Select the desired link and click .
3. Under Assign process function, click Define.

Import Utility
4. If no instrument type fields have been defined for the current source, then in the
Define Instrument Type Data Fields dialog box, do the following:
a. From Source, select the desired table column and drag it to Instrument type
name.
b. From Source, select the desired table column and drag it to Instrument type
description.
c. Click OK.
Tip
• Source table columns that exceed 6 characters will be truncated
accordingly during the import process.
5. In the Process Function Mapping dialog box, for each instrument type, drag the
appropriate process function from the right section to the Process function
column.
Tip
• If desired, you can drag several source table columns to create a
concatenated source data string, or use formulas.
6. To filter the instrument types displayed in the left data window, under View the
Process Function Assignments, do one of the following:
• Click All to display assigned and unassigned instrument types.
• Click Unassigned to display only instrument types which are not
assigned yet with process functions.
• Click Assigned to display only instrument types which are assigned
with process functions.
Tip
• After the first time you run the link, some of the instrument types will
already have process functions defined by default – these are
displayed with a gray background, and you cannot reassign the process
functions. Unassigned data fields are shown with a light blue
background, and assigned fields with a white background.
7. When done, click OK to return to the Link Properties dialog box.
8. Under Assign process function, select the Apply check box to use the instrument
type and instrument type description source definitions for the current import
session.
Related Topics
• Associating Source Tags with Instrument Types, page 238

Import Utility
Moving Data
You can specify a link that will move existing data to a different <unit> within the
same domain. This option is available only for table links.
Move Previously Imported Data

1. In the Link Properties dialog box, click the Import mode tab.
2. Under Target database import mode, click Move to move the rows in the target
domain to a different <unit> in the same domain.
3. Click OK.

Import Utility
Deleting Data
You can specify a link that will only delete data that already exists in the database.
This option is available only for table links.
Delete Previously Imported Data

1. In the Link Properties dialog box, click the Import mode tab.
2. Under Target database import mode, click Delete to delete existing rows in the
target domain during the import process.
3. Click OK.

Import Utility
Link Groups
You can create a group of existing links by associating individual links to a group.
Grouped links are especially useful when you want to import data in batch mode, for
example, automatically use the links in that group one after the other to import data.
You can, however, use a single link from that group if you want to use just one link.
Related Topics
• Creating a New Link Group, page 245
• Deleting Links, page 248
• Dissociating Links from a Group, page 246
• Renaming Groups and Links, page 249

Import Utility
Creating a New Link Group

You can associate a number of existing links to a new group to import data.
Create a New Group And Associate Links With It

1. In the Link Explorer, click .
2. Under Link list, type the required name in the text box next to the new link.
• Click to add a new link to the group (see Creating a New Link, page
158 for more information).
• Click the link group All, select the required links in the right pane
(press Ctrl or Shift for multiple selections), and drag the links to the
group.
• Click any other link group, select the required links in the right pane
(press Ctrl or Shift for multiple selections), and drag the links to the
group.
Tip
• If you select to add a link that was already associated with a group,
you move it by dragging it to another group. Holding down Ctrl while
dragging copies it to the new group. You cannot move a link out of
the group All.
4. Arrange the links in the required sequence in the group by dragging each link to
the link below which it is to be located. To make a link the first one in the group,
drag it to the group itself.
Tip
• The sequence in which the links appear in a group is very important.
When executing an import session for the entire group, the links are
run in the order in which they appear in the group.

Import Utility
Dissociating Links from a Group

You can dissociate one or more links from a group. If a link is not associated with
any group, you can still locate it and run it from the All group, if required.
Dissociate Links From a Group

1. In the Link Explorer, click the group where you want to dissociate the links.
2. Select the required links in the right pane (press Ctrl or Shift for multiple
selections).
3. Click to dissociate the links from the group.

Import Utility
Moving and Copying Links

You can copy and move import links between groups by means of drag-and- drop
operations as well as using the keyboard.
Move a Link to Another Group

1. In the Link Explorer, click the group containing the links you want to move.
selections).
3. On the keyboard, do the following:
a. Press Ctrl+X.
b. Select the target group.
c. Press Ctrl+V.
Tip
• As an alternative method, drag the selected links to the target group.
Copy a Link to Another Group

1. In the Link Explorer, click the group containing the links you want to copy.
selections).
3. On the keyboard, do the following:
Tip
4. Press Ctrl+C.
5. Select the target group.
6. Press Ctrl+V.
Tip
• As an alternative method, drag the selected links to the target group while
pressing Ctrl.

Import Utility
Deleting Links
You can delete individual links or an entire group of links if they are no longer
needed.
Caution
• The deletion process is irreversible – any links you delete will be
removed from all link groups they are associated with, including All, and
will not be available for use afterwards. For this reason, you should
proceed with extreme caution when deleting links.
Delete Links
1. In the Link Explorer, click the group containing the links to be deleted.
• To delete the group with all of its links, leave the group highlighted.
• To delete selected links in the group, select the required links in the
right pane (press Ctrl or Shift for multiple selections).
3. Click to delete.
4. At the prompt, click Yes to confirm the deletion.

Import Utility
Renaming Groups and Links

You can rename an existing links or link groups required.
Rename a Group Or a Link

1. In the Link Explorer, click the group or link you want to rename.
2. Click .
3. Type the new name for the link or group as required.
Tip
• Since groups in the Link list are arranged in alphabetical order,
renaming a group may result in its moving to a different position in the
list.

Import Utility
System Codes
When importing data from a non-SmartPlant Instrumentation database that uses
system or UOM (Unit of Measure) codes different from the ones used in your target
SmartPlant Instrumentation database, you are required to adapt the source system
and/or UOM codes to the codes used in your target SmartPlant Instrumentation
database. This feature can also be used to adapt system and UOM codes of a
SmartPlant Instrumentation source domain, when importing data from one SmartPlant
Instrumentation domain to another.
For example:
A source table may contain a code (for example, A) which is used as a reference in
another source table. This code may be different from the one used in your
corresponding target SmartPlant Instrumentation database (for example, psia).
Therefore, prior to running import, you have to make the appropriate adaptations for
the system and UOM codes.
Note
• If you want to use system codes in your current import session, you must
select the appropriate source system and adapt its code prior to starting the
import of data (see the procedure below for details). Also note that the
target code values are predefined in the system and cannot be modified.
When importing process data and/or calculation data and the units of
measure are not defined, the Import Utility will insert default UOM values
belonging to the SmartPlant Instrumentation <unit> with which the
imported tag data is associated.
To adapt source system and UOM codes you need to:
• Select the source system whose codes you want to adapt (see Defining
Source Systems, page 251).
• Adapt the source codes to the target codes (see Adapting Source Codes,
page 252).
Using this feature you can also keep the code adaptation data in a text file (with a cds
extension) and use it in future import sessions. You can:
• Import a code file that contains adapted system codes, UOM codes or both
(see Importing Codes, page 256). Note that importing codes this way
doesn't overwrite the current code adaptations.
• Export a code file that contains adapted system codes, UOM codes or both
(see Exporting Codes, page 257).
• View the currently selected source system (see Viewing the Current
Source System Name, page 258).

Import Utility
Defining Source Systems

Before you can adapt the source codes to comply with the target codes, you need to
specify the source systems whose codes you want to adapt. At this stage, you also
select the current source system whose codes you want to use during the current
import session.
Define Source Systems

1. On the System Codes menu, click Select Source System.
2. In the Source System List dialog box, do one of the following:
• Add a new source system (see step 3).
• Edit an existing source system name (see step 4).
• Delete an existing source system (see step 5).
• Select the current source system (see step 6).
3. To add a new source system:
a. Click New.
b. Click in the highlighted line.
c. Type the new source system name.
d. To edit an existing source system name:
a. In the data window, highlight the source system whose name you want to
modify.
b. Click Edit to make the line selected in the data window.
c. Edit the source system name as required.
a. To delete an existing source system:
b. In the data window, highlight the source system you want to delete.
c. Click Delete to delete the line selected in the data window.
4. To select the current source system, in the data window, highlight the required
line and click OK.

Import Utility
Adapting Source Codes

In this stage you adapt the codes used in the source database to the codes used in your
SmartPlant Instrumentation database. There are two types of codes:
• System Codes - codes which are not associated with units of measure.
• UOM Codes - codes associated with units of measure.
Note, that several source code values can be represented by a single target code value.
For example:
The source code values AA, BB, CC, DD can be represented by (adapted to) a single
target code: XX.
See the following topics for a list of the codes you can adapt:
• System Codes Table, page 272

• Unit of Measure Codes Table, page 281
Note
• You can adapt system codes and UOM codes only if you selected a source
system. See the previous procedure to learn how to select a source
system.
Adapt System Codes

1. On the System Codes menu, click Adapt System Codes.
2. In the Source System List dialog box, select the source system whose codes you
want to adapt. The available source systems are the ones you entered in the
Source System List dialog box.
3. In the Adapt System Codes dialog box, under Module, do one of the following:
• Click All to make all properties available.
• Click the SmartPlant Instrumentation module whose properties you
want to make available (Process Data, Wiring, or Calculation).
Click Other to make the properties available for all modules except
•
for Process Data, Wiring, and Calculation.
4. From the Code Values list, select the property whose codes need adapting.
5. To set the code values, do the following:
a. In the data window, click the Source Code field of the appropriate code. The
selected Source Code field becomes editable (if the field color was light blue,
it changes to white).

Import Utility
b. Type the source value corresponding to the target system code value.
c. To clear the currently selected source system code value, click Unused.
d. To specify an additional source system code value for the target system code
value currently selected in the data window, click Duplicate and type an
additional value in the Source Code column of the new row.
Tip
• You can only set the values of source codes where the Source
Code field color is either light blue or white.
6. Repeat steps 3 through 5 for every required SmartPlant Instrumentation module.
7. Repeat steps 2 through 6 for other source systems whose codes need adapting.
8. Click OK to close the Adapt System Codes dialog box.
Related Topics
• Using Source Codes in an Import Link, page 259

Import Utility
Adapt UOM Codes

1. On the System Codes menu, click Adapt UOM Codes.
2. In the Adapt UOM Codes dialog box, from the Source System list, select the
source system whose codes you want to adapt. The available source systems are
the ones you entered in the Source System List dialog box.
3. From the UOM Type list, select the UOM category whose codes need adapting.
4. To set the code values, do the following:
a. In the data window, click the Source UOM Code field of the appropriate
code.
Tip
• You can only set the values of source codes where the Source
UOM Code field color is either light blue or white.
b. Type the source value which corresponds to the target UOM code value.
c. Click Unused to clear the currently selected source UOM code value.
d. Click Duplicate to specify an additional source UOM code value for the
target UOM code value currently selected in the data window.
Tip
Show me how to enter symbols using ASCII numbers
•
5. Repeat steps 3 and 4 for every required SmartPlant Instrumentation module.

6. Repeat steps 2 through 5 for other source UOM whose codes need adapting.
7. Do one of he following:
• Click OK to save the changes you made to the current UOM code
settings and close the Adapt UOM Codes dialog box.
• Click Save to save the changes you made to the current UOM code
settings and keep the Adapt UOM Codes dialog box open. This way
you can save the portion of the work you have done so far and keep
working in the Adapt UOM Codes dialog box.
Related Topics
• Unit of Measure Codes Table, page 281
• Using Source Codes in an Import Link, page 259

Import Utility
Adapting UOM Codes - Special Characters

To type power indexes (for example, 2 as in cm2) and other special characters (for
example, as in C), do the following:
• Run the Windows Character Map utility and select the appropriate
character to copy and click the Copy button.
• Switch to Import and paste the character in the required location.
• Hold down Alt and, with the Num Lock indication on, type the
required character's ASCII value (a four-digit number) using the
keyboard numeric keypad (see your Windows User Guide for
additional information about ASCII numbering).
For example:
Type Alt + 178 to add: 2
Type Alt + 179 to add: 3
Type Alt + 186 to add:

Import Utility
Importing Codes
This feature allows you to import from the same code file (with a .cds extension) both
the system codes and the UOM codes or just one of them, depending on whether
these codes exist in the ASCII file you are going to use. This way you can use code
adaptation settings that were previously saved in files without having to redefine the
code adaptation for every case.
Note
• Importing codes from an external file does not overwrite existing code
settings.
Import Codes
1. On the System Codes menu, click Import Codes.
2. In the Import System and UOM Codes dialog box, do one of the following:
• Under Select File, type the full path and filename of the ASCII file
from where you want to import the codes, if you know it.
Click
• to navigate to the required file.
3. Under Import Data, click the code type you want to import: System Codes,
UOM Codes, or both.
Tip
•The code type that will be imported depends on whether the file you
selected in step 1 in this procedure actually contains the code type that
you select in the Import Data section.
4. Click OK to import the selected codes.

Import Utility
Exporting Codes
This feature allows you to export the current code settings of any selected source
system(s) to a code file (with a .cds extension). You can export both the system
codes and the UOM codes or just one of them. This way you can keep code
adaptation settings in a file and use them in future import sessions without having to
redefine the code adaptation for every case.
Export Codes
1. On the System Codes menu, click Export Codes.
2. In the Export System and UOM Codes dialog box, select one or more source
systems whose code settings you want to export to a file. To deselect a system,
click it again.
3. Under Export Data click the code type you want to import: System Codes,
UOM Codes, or both.
4. Click OK.
5. In the Enter Export File Name dialog box, select the file where you want to keep
the codes of the system you selected in step 1 in this procedure.
6. Click Save to export the codes to the selected file.

Import Utility
Viewing the Current Source System Name

This option enables you to view the currently selected source system name.
View the Currently Selected Source System Name

• On the System Codes menu, click Current Source System.
An appropriate message is displayed, showing you the current source system name.

Import Utility
Using Source Codes in an Import Link

After you have adapted UOM and system codes, this procedure describes how to use
them in your import links.
Use Source Codes in an Import Link

1. In the Link Explorer, select the link where you want to use source codes.
2. On the Actions menu, click Properties.
3. On the Link Properties dialog box, click the Source tab.
4. Select Use system codes.
5. Click OK.
6. In update mode, if prompted to use the overwrite option, click Yes.
7. Open the link which you want to use to import your data.
8. Define the link mapping by dragging the appropriate source names to the target
window.
9. In the link, select the check boxes in the target window under the Code column
for those link parameters for which you want to use source codes.
Tip
• To use all available source codes in the link, on the Actions menu,
point to System Codes and click Check All.
Tip

Import Utility
Data Import Order

General Data
Order Table Name Table Primary Key Field
Description
1 component_function_type Instrument Type cmpnt_func_type_name
cmpnt_func_type_desc
2 component_mfr Manufacturer cmpnt_mfr_name
data
3 component_location Location data cmpnt_loc_name
4 equipment_type Equipment type equip_type_name
data
5 line_type Line type data line_type_name
6 Equipment Equipment data equip_name
7 Line Line data line_num
8 loop_function Loop function loop_func_name
data
9 loop_proc Loop measure loop_proc_name
variable
10 loop_type Loop type data loop_type_name
11 Loop Loop data loop_name
12 Drawing P&ID data dwg_name
13 Component Component cmpnt_name
14 udf_component Custom fields cmpnt_name
related to
component
15 spec_sheet_data Specification cmpnt_form_cnum
data cmpnt_name
16 control_valve or Process data cmpnt_name
level_instrument or
temperature

Import Utility
Wiring Data
Order Table Name Table Primary Key
Description Field
1 Cable_type Cable type Cable_type_name
information
2 Cable_color Cable color Cable_color_name
information
3 Cable_mfr Cable_mfr Cable_mfr_name
4 Cable_mfr_mod Cable Cable_mfr_name
model Cable_mod_name
information
5 Cable Cable Cable_num
information
6 Panel_type Panel type Panel_type_name
information
7 Panel Panel Panel_name
information
8 Panel_strip Strip Panel_name
information strip_name
9 Panel_strip_term Terminal Panel_name
information strip_name
term_seq
10 Wire_Terminal Terminal Panel_name
data with strip_name
special term_seq
function Cable_num
propagation Cable_set_name
set_level

Import Utility
Defining Tables in Excel Spreadsheets

The software is capable of processing tables originating from Excel spreadsheets,
using an Office profile.
Define A Table In Excel

1. With your Excel worksheet open, highlight the cells that you want to define as a
table.
2. Select the Define menu item from the Name sub-menu in the Insert menu.
3. In the Name in workbook data line of the Define Name dialog box, type the
table name in upper case. The name you type will be assigned to the group of
cells you selected in step 1 in this procedure.
Tip
• The table name that you assign to a group of cells in an Excel
spreadsheet must always be typed in upper case.
Tip
4. Click OK to return to your Excel spreadsheet.
5. Repeat steps 1 through 4 in this procedure for all required tables.

Import Utility
Common Error Messages

This table describes some of the most common error messages which appear in both
the Import Report and the log file after an import process takes place. Also included
in this table are possible causes and suggested solutions for each case.
Messag Possible Cause(s) Suggested Solution

e
Empty The imported Tag LOOP Modify the source data.
Compon IDENTIFIER segment is Modify the import naming conventions.
ent empty.
Number
of Tag
Number
Empty The imported LOOP Modify the source data.
Loop NUMBER segment is Modify the import naming conventions.
Number empty.
of Loop
Number
Illegal The imported Tag Modify the source data.
Instrum Instrument Type value does Import the Instrument Type Table
ent Type not exist in the target (COMPONENT FUNCTION TYPE) first.
of Tag domain (see Note 1). Clear the Validate Tag and Loop option (see
Number Note 4).
Illegal The imported Tag Modify the source data.
Equipm Equipment Name value Import the Equipment Table (EQUIPMENT)
ent does not exist in the target first (see Note 4).
Name of domain (see Notes 1, 2).
Tag
Number
Illegal The imported Loop Modify the source data.
Equipm Equipment Name value Import the Equipment Table (EQUIPMENT)
ent does not exist in the target first (see Note 4).
Name of domain (see Notes 1, 2).
Loop
Number
Loop FUNCTION segment value Import the Loop Function Table
Functio does not exist in the target (LOOP_FUNCTION) first (see Note 4).
n of domain.
Loop
Number

Import Utility

Measure MEASURED VARIABLE Import the Loop Function Table
d segment value does not (LOOP_PROC) first (see Note 4).
Variable exist in the target domain.
of Loop
Number
Illegal The imported <unit> When importing more than one plant
<Unit> number is different from hierarchy item, make sure that you have
Number the target <unit> number specified the data import level and selected
in Tag (see Notes 1, 3). Apply on the Import Level tab of the Link
Modify the source data.
Modify the import naming conventions.
Illegal The imported <unit> name When importing more than one plant
<Unit> is different than the target hierarchy item, make sure that you have
Name in <unit> name (see Notes 1, specified the data import level and selected
Tag 3). Apply on the Import Level tab of the Link
Illegal The imported Area number When importing more than one plant
Area is different than the target hierarchy item, make sure that you have
Number Area number (see Notes 1, specified the data import level and selected
in Tag 3). Apply on the Import Level tab of the Link
Illegal The imported Plant number When importing more than one plant, make
Plant is different than the target sure that you have specified the data import
Number Plant number (see Notes 1, level and selected Apply on the Import Level
in Tag 3). tab of the Link Properties dialog box.
Number Modify the source data.

Import Utility
The The imported Process Modify the source data.

Process Function Name is different
Functio than the target (note that
n is not this variable is case
found sensitive and that this value
is usually capitalized).
The Process Function
Name value (in the
Component Table or in the
Component Function Type
Table) is different than the
Process Function Name
value in the Process
Function Table (see Notes
1, 5).
The In the COMPONENT
Instrum Table, the
ent Type CMPNT_FUNC_TYPE_I
is not D field value contains an
found invalid reference to the
COMPONENT_FUNCTIO
N_TYPE Table.
Modify the link settings.
Clear the Validate Tag and
Loop option.
The In the COMPONENT
Instrum Table, the Instrument Type
ent Type value in the
does not COMPONENT_NAME
match field (Tag Number) is
the Tag different than the value in
Number the
CMPNT_FUNC_TYPE_I
D field.
Modify the link settings.
Clear the Validate Tag and
Loop option.

Import Utility
The The Process Function value

Instrum in the Tag Number does
ent Type not comply with the
does not Process Function type (for
match example, Flow,
the Temperature, and so forth).
Process Modify the link settings.
Functio Modify the source data.
n Clear the Validate Tag and
Loop option.
User has The Import Utility rejected You can modify the selection you made for
selected a mismatched source row this link, if appropriate. See Setting General
to reject (see Note 6). Parameters, page 172 to learn more about this
row on option
data
mismatc
h
User has The Import Utility has You can modify the selection you made for
selected rejected a source row this link, if appropriate.
to which is identical to an
disallow existing target row (see
overwrit Note 6).
e
User has The Import Utility rejected You can modify the selection you made for
selected a source new row (for this link, if appropriate.
to example, the Import Utility
disallow is only updating the target
insertion data) (see Note 7).
Unique The imported table primary Make sure the table which provides the value
value key value does not match for the primary key is selected for import.
not the value of in the table
found from which it is derived
(see Note 8).
This is An attempt has been made Make sure you selected the appropriate links
not a to import a non-numeric in the Link Explorer.
numeric field to a numeric field.
value
Invalid Inappropriate symbols Select the Check symbols option in the Link
data were used in one or more Properties dialog box. See Setting General
imported fields. An Parameters, page 172 to learn more about this
incorrect comparison option. Make sure you have correct
criteria was applied in the comparison criteria settings. See Setting the
current import process (see Target Table Definitions for more information
Note 9). about this option.

Import Utility
Data is The Import Utility has This message does not indicate an error.
empty imported a Zero-ID row
(see Note 10).
The following notes apply to this table:

1. This message is specific for the case in which you select the Validate Tag and
Loop option in the Parameters Settings dialog box. See Setting the Tag / Loop
Parameters, page 186 for more information.
2. These segments apply to the Flexible naming convention standard only.
3. By default, the target <unit> is the one you selected when you started the current
Import session. If you selected during the import setup process to import data
into additional <units>, the target <unit> would be any of these <units> which
data will be imported into during the import process. See Importing Data into
Additional Plant Hierarchy Items, page 181 for further information about
importing data into additional target <units>.
4. As a rule of thumb, always import reference tables before importing the tables
they refer to. When importing into a module, make sure all appropriate reference
tables have been selected for import. (The corresponding message in the table
varies according to the relevant reference table.)
5. The Process Function Name field value can be one of the following (note that
these values are capitalized):
• Flow
• Level
• Pressure
• Temperature
• Analyzer
• Control Valve
• Relief Valve
Caution
• Do not select the PROCESS_FUNCTION table for import; as this may
damage your target database.
6. This message is typical for the case in which you select the Do not overwrite
option in the Link Properties dialog box.
7. This message is typical for the case in which you select the Rejected
mismatched data in the Link Properties dialog box. See Setting General
Parameters, page 172 to learn how to handle mismatched data.
8. This message is typical for the case in which you import a table whose primary
key is derived from another table's primary key. In this case the table the primary
key belongs to must also be imported.

Import Utility
For example:
The PD_GENERAL table primary key, CMPNT_ID, is derived from the

COMPONENT table. Therefore, the PD_GENERAL table primary key value
must exist in the COMPONENT table.
9. This message is reported by your SQL platform. The name of the field the
problem occurred in appears under Column Name in the Import Report. In this
case we highly recommend that you refer also to the information regarding this
import attempt in your Log File.
10. Most SmartPlant Instrumentation tables contain a Zero-ID row which is used to
maintain the linkage between the tables in the database. During the import
process this row is not transferred from the source data to the target data, in which
case the Import Utility displays an appropriate message in the Import Report.

Import Utility
Built-In Operators and Functions

Operator / Description Example
Function
= Equal to cpmnt_mfr =
`Shell'
> Greater than cmpnt_num > 101
< Less than item_price < 100
>= Greater or equal to cmpnt_num >= 10
=< Less than or equal to item_price =< 30
<> Not equal to prefix <> ÀA'
AND Include the following expression in the filter (name <> `') AND
combination (num <> 0)
OR Accept either the previous or the following (loop = `') OR
expression in the filter combination (line = `')
NOT Select the value opposite to the following NOT (item_price
expression = 0)
LIKE[value] Select a similar value that is similar to the one in cmpnt_num LIKE
the `[value]' field.You can use the following `%AA%'
wildcard characters: % - any combination of
characters. _ - any single character.
IN Select a value that is equal to one of those cpmnt_num = IN
specified in the parentheses (101,103)
BETWEEN Select a value which is within the following item_price
interval BETWEEN 100
AND 500
IS NULL Contains an undefined value loop_name IS
NULL
IS NOT Not equal to NULL cpmnt_name IS
NULL NOT NULL

Import Utility
Native Database Functions

Function Descripti Example
on
LTRIM (<value>)dBase Sybase Removes LTRIM(cmpnt_mfr)
Adaptive Server Anywhere 7.0, Oracle, all cmpnt_mfr = ' Shell'
SQL Server leading LTRIM(cmpnt_mfr)='Shell'
spaces in
the field
indicated
in the
parenthes
es
RTRIM(<value>) dBase Sybase Removes RTRIM(cmpnt_num) IS
Adaptive Server Anywhere 7.0, Oracle, all trailing NULL cmpnt_num = '108-FT
SQL Server spaces in 100 '
the field RTRIM(cmpnt_num)='108-FT
indicated 100'
in the
parenthes
es
SUBSTRING(<value>,<begin>,<count Retrieves SUBSTRING(cmpnt_mfr,1,4)
>)dBase Sybase Adaptive Server a part of cmpnt_mfr = 'Shell'
Anywhere 7.0, Oracle the field SUBSTRING(cmpnt_mfr,1,4)
indicated ='Shel'
in the
[value]
data field
from the
[begin]
position
for the
number of
characters
indicated
in the
[count]
field
SUBSTR(<value>,<begin>,<count>)S SUBSTR (cmpnt_mfr,1,4)
QL Server cmpnt_mfr = 'Shell'
SUBSTR(cmpnt_mfr,1,4)='Sh
el'

Import Utility
UCASE(<value>)dBase Sybase The upper UCASE(cpmnt_name)

Adaptive Server Anywhere 7.0 case cmpnt_name = '101-aa'
format of UCASE(cmpnt_name)='101-
the AA'
contents
of the
field
indicated
in the
[value]
data field
UPPER(<value>)Sybase Adaptive UPPER(cpmnt_name)
Server Anywhere 7.0, Oracle, SQL cmpnt_name = '101-aa'
Server UPPER(cmpnt_name)='101-
AA
LCASE(<value>)dBase Sybase The lower LCASE(loop_name)
Adaptive Server Anywhere 7.0 case loop_name = '101-AA'
format of LCASE(loop_name)='101-aa
the
contents
of the
field
indicated
in the
[value]
data field
LOWER(<value>)Oracle, SQL Server LOWER(loop_name)
loop_name = '101-AA'
LOWER(loop_name)='101-aa

Import Utility
System Codes Table

Module Property Code Description Value
Process Build-up Free Value
Data Tendency
(lower fluid) No N
Yes Y
Coagulation Fluid Free Value
No N
Yes Y
Coagulation Free Value
Liquid
(lower fluid) No N
Yes Y
Colored Fluid Free Value
No N
Yes Y
Colored Liquid Free Value
(lower fluid) No N
Yes Y
Corrosive Fluid Free Value
No N
Yes Y
Corrosive Liquid Free Value
(lower fluid) No N
Yes Y
Erosive Fluid Free Value
No N
Yes Y
Erosive Liquid Free Value
(lower fluid) No N
Yes Y
Failure Action Close Close
Last Last
Open Open

Import Utility
Flag for Above/ Above Reference Line A

Below Reference Below Reference Line B
Line
Flag for Built-up Absolute Pressure A
Back Pressure Gage Pressure G
Process Flag for Center C

Data
(continued) Center/Tangent Tangent T
Line
Flag for Constant Absolute Pressure A
Back Pressure Gage Pressure G
Flag for Critical Absolute Pressure A
Pressure Gage Pressure G
Flag for Design Absolute Pressure A
Flag for Elasticity Gage Pressure G
Module
Flag for Fire/Non- Fire case F
fire Case Non-fire case N
Flag for Flow Mass flow
@ Operating conditions O
@ Base conditions B
@ Normal conditions N
@ Standard conditions S
Range
@ Operating conditions O
@ Base conditions B
Trip/
Alarm @ Operating conditions O
@ Base conditions B

Import Utility
Flag for Lever Free Value
No N
Yes Y
Flag for Maximum Mass flow
Discharge @ Operating conditions O
@ Base conditions B
Flag for Maximum Absolute Pressure A
Pressure (Relief Gage Pressure G
Valve)
Flag for Maximum Free Value
Pressure (Relief Absolute Pressure A
Valve)
Gage Pressure G
Flag for Pressure Free Value
Range Absolute Pressure A
Gage Pressure G
Process Flag for Pressure Free Value
Data Trip/
(continued) Alarm Absolute Pressure A
Gage Pressure G
Flag for Set Absolute Pressure A
Pressure
Gage Pressure G
Flag for Variable Absolute Pressure A
Back
Flag to enter Density to be imported D
Density
or SG Gravity to be imported G
Flag to enter Density to be imported D
Density

Import Utility
or SG (lower Gravity to be imported G

fluid)
Fluid Phase Gas G
Liquid L
Steam S
Water W
Fluid Phase Liquid L
(lower fluid) Water W
Fluid Phase Homogeneous 2-phase H
Non-Homogeneous 2-phase N
Single phase S
Foaming up Free Value
No N
Yes Y
Foaming up Free Value
(lower fluid) No N
Yes Y
Handwheel Free Value
No N
Yes Y
Oxidizing Fluid Free Value
No N
Yes Y
Pipe Material Plain Carbon Steel (SAE 1020) 1
Inconel X, Annealed 10
Hanel Stellite 25 (L605) 11
Copper (ASTM B152, B124, 12
B133)
Yellow Brass (ASTM B36, B134, 13
B135)
Alum. Bronz (ASTM B169 A) 14
Beryllium Copper 25 (ASTM 15
B194)
Cuperonickel 30% 16
K-Monel 17

Import Utility
Nickel 18
Pyrex Glass 19
301 S.S. 2
Process Titanium 20
Data
(continued) Tantalum 21
304 S.S. 3
310 S.S. 4
316 S.S. 5
330 S.S. 6
347 S.S. 7
Hastelloy B 8
Hastelloy C 9
Material Not Listed 99
Seat Leakage ANSI I ANSI I
ANSI II ANSI II
ANSI III ANSI III
ANSI IV (standard) ANSI IV
(standard)
ANSI V ANSI V
ANSI VI (TSO) ANSI VI
(TSO)
BS6755A BS6755A
BS6755B BS6755B
BS6755C BS6755C
No Tight Shut-Off No Tight
Shut-Off
Tight Shut-Off Tight Shut-
Off
Solidifying Fluid Free Value
No N
Yes Y
Solidifying Liquid Free Value
(lower fluid) No N
Yes Y
Toxic Fluid Free Value

Import Utility
No N
Yes Y
Toxic Liquid Free Value
(lower fluid) No N
Yes Y
Transparent Fluid Free Value
No N
Yes Y
Transparent Free Value
Liquid
(lower fluid) No N
Yes Y
Wiring Panel Category Junction Box 1
Code
Marshaling Rack 2
Cabinet 3
Field Device 4
DCS 5
PLC 6
Calculation Calc Type ISA Standard 1
IEC Standard 2
Calculated Orifice Diameter calculation B
Parameters
(D,W,DP) Differential Pressure calculation D
Flow Rate Calculation W
Flag for Full Scale Mass flow
Flow @ Operating conditions O
@ Base conditions B
Flag for Rupture Without Rupture Disk 0
Disk
With Rupture Disk 1
Flag to enter Compressibility to be imported C
Compressibility or Density to be imported D

Import Utility
Density (for Gas)

Flag to enter Specific Gravity to be imported G
Molecular
Mass or SG (for Molecular Mass to be imported M
Gas)
Meter Sub Type Flange Tappings (Quarter of Circle 11
Orifice)
Corner Tappings (Quarter of Circle 12
Orifice)
Classical Venturi (as cast 17
convergent section)
Classical Venturi (machined 18
convergent section)
Classical Venturi (rough-welded 19
sheet-iron conv)
Flange Tappings (Square Edge 2
Orifice)
Universal Venturi 20
ISO Long Radius Nozzle 23
ASME Long Radius Nozzle 24
ISA 1932 Nozzle 25
Venturi Nozzle 26
Diametrically Opposite Flange 28
Tappings (Eccentric Orifice)
Side Flange Tappings (Eccentric 29
Orifice)
Corner Tappings (Square Edge 3
Orifice)
Diametrically Opposite Vena 30
Contracta Tappings (Eccentric
Orifice)
Side Vena Contracta Tappings 33
(Eccentric Orifice)
Vena Contracta Tappings 34
(Segmental Orifice)
Radius Tappings (Square Edge 4
Orifice)
SBHO Meter Run with Corner 5
Tappings

Import Utility
SBHO Meter Run with Flange 6

Tappings
Pipe Tappings 7
AGA Report 3 (Flange Tappings) 8
AGA Report 3 (Pipe Tappings) 9
Meter Type Square Edge Orifice 1
Quarter of Circle Orifice 2
Conical Entrance Orifice 3
Lo-Loss Tube 4
Venturi Tube 5
Nozzle 6
Eccentric Orifice 7
Segmental Orifice 8
Orifice Material Plain Carbon Steel (SAE 1020) 1
Inconel X, Annealed 10
Hanel Stellite 25 (L605) 11
Copper (ASTM B152, B124, 12
B133)
Yellow Brass (ASTM B36, B134, 13
B135)
Alum. Bronz (ASTM B169 A) 14
Beryllium Copper 25 (ASTM 15
B194)
Cuperonickel 30% 16
K-Monel 17
Nickel 18
Pyrex Glass 19
301 S.S. 2
Titanium 20
Tantalum 21
304 S.S. 3
310 S.S. 4
316 S.S. 5
330 S.S. 6
347 S.S. 7

Import Utility
Calculation Hastelloy B 8
(continued) Hastelloy C 9
Material Not Listed 99
Relief Valve Style Bellows Valve B
Conventional Valve C
Pilot-operated Valve P
Sizing Basis Blocked Flow B
Valve Type Signal Seat Globe 1
Double Seat Globe 2
Angle 3
Ball 4
Butterfly 5
Well Material Austenitic Steel 0
Ferritic Steel 1

Import Utility
Unit of Measure Codes Table

Unit of Measure Type Unit of Measure Name Value
Area centimeter2 cm2
Foot2 ft2
Inch2 in2
Kilometer2 km2
meter2 m2
mile2 mile2
millimeter2 mm2
yard2 yd2
Capacitance F F
nF nF
pF pF
Capacitance/Length F/ft F/ft
F/km F/km
F/m F/m
F/ft F/ft
F/km F/km
F/m F/m
mF/ft mF/ft
mF/km mF/km
mF/m mF/m
nF/ft nF/ft
nF/km nF/km
nF/m nF/m
pF/ft pF/ft
pF/km pF/km
Capacitance/Length pF/m pF/m
Conductivity mho/cm mho/cm
S/cm S/cm
mho/cm mho/cm
mmho/cm mmho/cm
mS/cm mS/cm

Import Utility
S/cm S/cm
Current A A
mA mA
Density gram/milliliter g/ml
kg/cubic meter kg/m3
kg/liter kg/l
lb/cubic foot lb/ft3
lb/cubic inch lb/in3
lb/cubic yard lb/yd3
lb/ U.K. gallon lb/UK gal
lb/U.S. gallon lb/US gal
oz/cubic inch oz/in3
oz/ U.K. gallon oz/UK gal
lb/U.S. gallon oz/US gal
slug/cubic foot slug/ft3
ton(long)/cubic yard tonl/yd3
ton(short)/cubic yard tons/yd3
Diameter and Length 1/1000 inch MILS
centimeter cm
foot ft
inch in
Diameter and Length kilometer km
meter m
mile mile
millimeter mm
yard yd
Flow CANADIAN gallon/day CN gal/d
CANADIAN gallon/hr CN gal/h
CANADIAN gallon/min. CN gal/min
CANADIAN gallon/sec. CN gal/s
Cubic centimeter/min cm3/min
cubic ft/day ft3/d
cubic ft/hr ft3/h
cubic ft/min. ft3/min

Import Utility
cubic ft/sec. ft3/s

cubic inch/day in3/d
cubic inch/hr in3/h
cubic inch/min. in3/min
cubic inch/sec. in3/s
cubic kilofoot/day kft3/d
cubic kilofoot/hr kft3/h
Cubic kilofoot/min. kft3/min
cubic meter/day m3/d
cubic meter/hr m3/h
cubic meter/min. m3/min
cubic meter/sec. m3/s
grain/day grain/d
grain/hr grain/h
grain/min. grain/min
Flow grain/sec. grain/s
gram/day g/d
gram/hr g/h
gram/min. g/min
gram/sec. g/s
kg/day kg/d
kg/hr kg/h
kg/min. kg/min
kg/sec. kg/s
klb/day klb/d
klb/hr klb/h
lb/day lb/d
lb/hr lb/h
lb/min. lb/min
lb/sec. lb/s
Mega cubic foot/day Mft3/d
Mega cubic foot/minute Mft3/min
Mega cubic meter/day Mm3/d
Mega cubic meter/hr Mm3/h

Import Utility
Mega lb/day Mlb/d

metric ton/day t/d
metric ton/hr t/h
metric ton/min. t/min
metric ton/sec. t/s
U.K. gallon/day UK gal/d
U.K. gallon/hr UK gal/h
U.K. gallon/min. UK gal/min
U.K. gallon/sec. UK gal/s
Flow U.K. ton/day UK ton/d
U.K. ton/hr UK ton/h
U.K. ton/min. UK ton/min
U.K. ton/sec. UK ton/s
U.S. barrel/day US bbl/d
U.S. barrel/hr US bbl/h
U.S. barrel/min. US bbl/min
U.S. barrel/sec. US bbl/s
U.S. gallon/day US gal/d
U.S. gallon/hr US gal/h
U.S. gallon/min. US gal/min
U.S. gallon/sec. US gal/s
U.S. kilobarrel/day US kbbl/d
U.S. kilobarrel/hr US kbbl/h
U.S. megabarrel/day US mbbl/d
Force kilogram-force kgf
lb-force lbf
newton N
Inductance H H
mH mH
Inductance/Length H/ft H/ft
H/km H/km
H/m H/m
H/ft H/ft
H/km H/km

Import Utility
H/m H/m
mH/ft mH/ft
Inductance/Length mH/Km mH/Km
nH/km nh/km
pH/ft pH/ft
Inductance/Resistance H/ohm H/ohm
mH/ohm mH/ohm
Latent Heat Btu(39)/lb Btu39/lb
Btu(59)/lb Btu59/lb
Btu(60)/lb Btu60/lb
Btu(IT)/lb Btu IT /lb
Btu(M)/lb Btu M /lb
Btu(th)/lb Btu th /lb
cal(15)/g cal15/g
cal(20)/g cal20/g
cal(IT)/g cal IT/g
cal(M)/g cal M /g
cal(th)/g cal th /g
J/kg J/kg
kcal(15)/kg kcal15/kg
kcal(20)/kg kcal20/kg
kcal(IT)/kg kcal IT /kg
kcal(M)/kg kcal M /kg
kcal(th)/kg kcal th /kg
kJ/kg kJ/kg
Power mW mW
W W
Pressure atmosphere(standard) Atm (stand)
atmosphere(tech) at (tech)
bar bar
Pressure centimeter of Hg (0C) cmHg 0C
centimeter of water cmH2O (4C)
dyne/cm2 dyn/cm2
foot of water (39.2C) ftH2O

Import Utility
gram-force/cm2 gf/cm2
hecto pascal hPa
inch of Hg(32C) inHg
inch of water(60C) inH2O
kg-force/cm2 kgf/cm2
kg-force/m2 kgf/m2
kg-force/mm2 kgf/mm2
kilo pascal kPa
Ksi Ksi
lb-force/ft2 lbf/ft2
lb-force/in2 lbf/in2
mega pascal MPa
meter water(4C) mH2O 4C
millibar mbar
millimeter of Hg (0C) mmHg 0C
millimeter of water mmH2O 4C
pascal (Pa) Pa
psi psi
torr (mm Hg 0C) Torr
Resistance Kohm Kohm
ohm ohm
Resistance/Length kOhm/ft kOhm/ft
kOhm/km kOhm/km
Resistance/Length kOhm/m kOhm/m
MOhm/m MOhm/km
Ohm/ft Ohm/ft
Ohm/km Ohm/km
Ohm/m Ohm/m
statOhm/km statOhm/km
Specific Heat Btu(39)/(lbF) Btu39/lbF
Btu(59)/(lbF) Btu59/lbF
Btu(60)/(lbF) Btu60/lbF
Btu(IT)/( lbF) BtuIT / lbF
Btu(M)/(lbF) Btu M / lbF

Import Utility
Btu(th)/(lbF) Btuth/lbF
cal(15)/(gK) cal15/(gK)
cal(20)/ (gK) cal20/(gK)
cal(IT)/ (gK) calIT/(gK)
cal(M)/ (gK) cal M /(gK)
cal(th)/ (gK) calth/(gK)
J/(kgK) J/(kgK)
kcal(15)/(kgK) kcal15/kgK
kcal(20)/ (kgK) kcal20/kgK
kcal(IT)/ (kgK) kcal IT /kgK
kcal(M)/ (kgK) kcal M /kgK
kcal(th)/ (kgK) kcal th /kgK
kJ/(kgK) kJ/(kgK)
Temperature Degrees Celsius C C
Degrees Fahrenheit F F
Degrees Rankin R R
Temperature Kelvin K K
Velocity ft/h ft/h
ft/min ft/min
ft/s ft/s
in/s in/s
km/h km/h
m/s m/s
Viscosity centipoise cP
centistokes cS
cm2/s cm2/s
ft2/sec. ft2/s
in2/sec. in2/s
lb/(fthr) lb/(fth)
lb/(ftsec.) lb/(fts)
lb-forcesec/ft2 lbfsec/ft2
lb-forcesec/in2 lbfsec/in2
m2/sec. m2/s
mm2/s mm2/s

Import Utility
mPas mPas
pascal sec. Pas
poise P
slug/(ftsec.) slug/fts
stokes St
Voltage mV mV
V V
Weight gram g
kilogram kg
Weight metric ton ton
ounce oz
pound lb
Weight/Length kg/km kg/km
lbs/mft lbs/mft

SmartPlant Electrical Interface

The SmartPlant Electrical Interface allows you to exchange data between the two
applications using the following document types:
Power elements — You initially define power supply requirements in SmartPlant

Instrumentation for tag numbers and for any panel type except for junction boxes and
device panels. On publishing the data from SmartPlant Instrumentation, SmartPlant
Electrical uses the published power supply data to create instruments from SmartPlant
Instrumentation tag number data and cabinets from panel data in SmartPlant
Instrumentation. You can then publish the data and retrieve it back to SmartPlant
Instrumentation with SmartPlant Electrical PDB information.
Signals — Signal data originates in SmartPlant Electrical. You can define signal
data for generators, battery banks, converting equipment, loads, control stations, any
type of circuit, and disconnect equipment. On retrieving all SmartPlant Electrical
signals, SmartPlant Instrumentation creates special electrical tags, for which you can
perform wiring and I/O control system tag assignments. After the wiring is complete,
you can publish the data back to SmartPlant Electrical for further processing, and use
it to display PLC or other host I/O data in SmartPlant Electrical schematics.
Notes
• The documents published by the two applications do not contain the same
properties. For example, instrument and cabinet data includes power
supply parameters such as rated voltage, full load current, and so forth,
which originate in SmartPlant Instrumentation. However, SmartPlant
Electrical only publishes PDB/Cell/Circuit information. Similarly,
SmartPlant Instrumentation publishes host data for signals that originate in
SmartPlant Electrical, but SmartPlant Electrical does not publish the host
data back to SmartPlant Instrumentation. For this reason, if, in SmartPlant
Electrical, you change data values that originated from SmartPlant
Instrumentation, you should update those values accordingly in
SmartPlant Instrumentation, and vice versa.
• If you publish signals in SmartPlant Electrical for circuits that feed items
other than loads, converting equipment, generators, battery banks,
instruments, or cabinets, then on retrieving the items in SmartPlant
Instrumentation and running the tasks, SmartPlant Instrumentation does
not display the associated items.
Related Topics
• Flow of Activities for Creating Control Systems, page 292
• Prerequisites for Working with the SmartPlant Electrical Interface, page
290

Prerequisites for Working with the SmartPlant

Electrical Interface
Before you can work with the SmartPlant Electrical Interface, do the following:
1. Install the Intergraph Schema Component from the SmartPlant Electrical CD
Browser (click Add-In Software, and then click Schema Component
Installation).
Tip
• On the Select Optional Features page, make sure that you clear the
Schema Editor check box.
2. Install the SmartPlant Client from the SmartPlant Electrical CD Browser (click
Add-In Software, and then click SmartPlant Client Installation).
Tip
• On the Select Features page, make sure that you clear the SmartPlant
Automatic Retrieval check box.
3. In the Windows Registry, you need to specify the folder location of the .xml file
containing the published data. In the case where multiple users publish the data,
all the users must define the same path. The path is defined in the Registry
location HKEY_CURRENT_USER\Software\INTERGRAPH\INTOOLS using the
parameter OutputXMLFolder = <.xml file path>.
4. The System Administrator must enable the item registry.
5. The Domain Administrator must register the items.
6. Set up the plant hierarchy for which you are going to publish and retrieve data.
Tips
• To ensure the smooth functioning of the SmartPlant Instrumentation
backup and restore functions and to avoid duplicating data, each plant
in SmartPlant Electrical must map to SmartPlant Instrumentation at the
domain level. For this reason, make sure that each SmartPlant
Instrumentation domain that you map contains no more than one plant.
• At this stage, the prerequisites for working with the interface must also
be met on the SmartPlant Electrical side. For details, refer to the
SmartPlant Electrical Online Help topic: Prerequisites for Working
with the SmartPlant Instrumentation Interface.
7. In SmartPlant Instrumentation, retrieve the file Plant Groups.xml, (on the
SmartPlant menu, click Retrieve, and then navigate to the file which is
published in the folder of the current specified SmartPlant Electrical plant). This
file contains plant structure information to facilitate correlation of the plant
structures between both applications.

8. For each unit where data is to be published and retrieved, the Domain
Administrator must open the Unit dialog box and enter a unit number
corresponding to the unit code of the mapped SmartPlant Electrical unit.
You are now ready to use the interface to publish and retrieve data.
Related Topics
• SmartPlant Electrical Interface: An Overview, page 289

Flow of Activities for Creating Control Systems

The following steps constitute the primary flow of activities when you use SmartPlant
Instrumentation to create the detailed wiring and control system data for a SmartPlant
Electrical item:
1. In SmartPlant Electrical, create signals for the items you want to associate with
control systems in SmartPlant Instrumentation and publish the data from
SmartPlant Electrical. For details, refer to SmartPlant Electrical Online Help.
Tip
• SmartPlant Electrical publishes the data in an .xml file, which it
creates in the plant structure path.
2. Open SmartPlant Instrumentation and retrieve the data that originated in
SmartPlant Electrical. For details, see Retrieve SmartPlant Electrical Data, page
294.
3. Run the tasks that the software generates as a result of the retrieve. For details,
see Run a Task from the To Do List, page 427.
Tip
• SmartPlant Instrumentation automatically creates tag numbers from
the retrieved data and identifies them as SmartPlant Electrical tags.
4. View the SmartPlant Electrical tags created in SmartPlant Instrumentation. For
details, see Viewing Electrical Tag Numbers, page 295.
5. Associate the SmartPlant Electrical tags with loop numbers where needed; the
software populates the loop number data to SmartPlant Electrical later.
6. Create the necessary panels and cables and make the connections needed to
propagate the signal to the DCS or PLC that is used to define the control system
tag relationship. For details, see Create Wiring Items for SmartPlant Electrical
Signals, page 297.
Tip
• If a signal is associated with a circuit in SmartPlant Electrical, it
inherits its power distribution board (PDB) item tag as an associated
field and is considered as a preassigned signal for the PDB cabinet.
For circuit signals, SmartPlant Instrumentation automatically creates a
cabinet with the name of the power distribution board to which the
circuit was connected in SmartPlant Electrical. For other signals, you
need to create device panels manually in SmartPlant Instrumentation.
For details, see Create a Local Signal for Electrical Tags, page 299.
7. Publish the data to SmartPlant Electrical. This creates an .xml document
containing SmartPlant Instrumentation data such as the control system
configuration, I/O assignment, PLC I/O card and channel, instrument tags, loop

number, and so forth. For details, see Publish Data for SmartPlant Electrical,
page 302.
Tip
• The software creates the file in the path: <SmartPlant Instrumentation
home folder>\XML\IO Assignment_data.xml.
8. Retrieve (import) the configured data in SmartPlant Electrical.
9. Display the I/O assignment data in a SmartPlant Electrical schematic by including
in the schematic macros related to SmartPlant Electrical signal data. For details,
see SmartPlant Instrumentation Macro Structure.
Tip
• In Enhanced Report Utility reports and CAD drawings for a signal that
applies to a circuit, the loop macros cannot retrieve main or associated
electrical equipment names and types because the signal is not directly
linked with these items. Furthermore, it is possible for a circuit to feed
more than one item of equipment, and this is incompatible with the
way that macros function, where each macro can retrieve only a single
data value at a time. Likewise, if a signal is linked to an item of
electrical equipment, you cannot use macros to retrieve circuit data.
Notes
• You can repeat this procedure as many times as you want to; SmartPlant
Instrumentation recognizes new, modified, and deleted data that is
published from SmartPlant Electrical.
• The data is owned by the application that created it. If you modify or
delete the data in the application that does not own it, the next time you
retrieve the data from the owner application, it overwrites any modified
data, or reinserts data if it was deleted. A specific data property usually
belongs to one or other of the applications; however, the Sys I/O type
property is owned by both applications and in this case the software
overwrites the value in whichever application you retrieve the data.
Related Topics
290

Retrieve SmartPlant Electrical Data

1. Click Tools > Interfaces > SmartPlant Electrical.
2. Under Data Transfer mode, click Retrieve SmartPlant Electrical data.
3. On the Retrieve Document dialog box, type the path to the folder where the
source .xml files containing the published data are located, or click Browse to
navigate to the folder.
4. From the Document list, select the document that you want to retrieve.
Notes
• The software automatically retrieves the appropriate .xml files associated
with the document that you select.
• It is possible for SmartPlant Electrical users to delete items that originated
from SmartPlant Instrumentation, such as cabinets. In this case, when data
is next published from SmartPlant Electrical and retrieved back into
SmartPlant Instrumentation, the software creates Delete tasks for those
items in the To Do List window. If you do not want those items to be
deleted from the SmartPlant Instrumentation database, you should click
to remove the task from the To Do List window.
Related Topics

Table of Contents
Viewing Electrical Tag Numbers

On retrieving data from SmartPlant Electrical, SmartPlant Instrumentation creates
corresponding electrical tags. You can view these tags from the Domain Explorer or
in the Browser module.
Notes
• Some tag number properties apply to SmartPlant Electrical data only, and
are read-only. You can edit other properties such as Service, I/O type,
and Notes.
• When you retrieve a SmartPlant Electrical PDB (power distribution board)
preassigned circuit signal, SmartPlant Instrumentation automatically
creates a cabinet with the name of the power distribution board associated
with the signal. If you delete such a cabinet, its preassignment
relationship with the signal is lost and you will no longer be able to find
the tag for that signal when you select Pre-assigned signals only in the
Signal Filter dialog box. However, the next time you publish the signal
from SmartPlant Electrical and retrieve it into SmartPlant Instrumentation,
the cabinet is created afresh.
• When you download electrical tags from SmartPlant Electrical, after
making the I/O assignments, SmartPlant Instrumentation automatically
assigns a control system tag to each electrical tag.
• There are three categories of electrical signals, for each of which the user
interface differs slightly, as follows:
• Signals related directly to PDB circuits that are associated with main
equipment; for example, a signal created in a feeder circuit that feeds a
motor.
• Signals directly related to main equipment; for example, a signal
created under a motor or a transformer.
• Signals associated directly with control stations that are associated
with main equipment such as motors.
In the Domain Explorer, electrical tag numbers can be viewed by expanding the
Electrical Tags folder.
In the Browser module, you can view electrical tag numbers from one of the
following browsers:
• Electrical Tag Browser— Displays data for all tag numbers derived
from SmartPlant Electrical signals for all items but does not retrieve data
values of associated attributes for signals created under circuits. The
software displays data for the main item and also associated circuit data.

• Circuit Related Electrical Tag Browser— Displays data for tag

numbers derived from SmartPlant Electrical signals for circuits. If a
circuit relates to more than one electrical item, a separate data row appears
for each item.
• Electrical Power Element Browser— Displays electrical properties
owned by SmartPlant Instrumentation and SmartPlant Electrical for
instruments and cabinets.
Related Topics

Create Wiring Items for SmartPlant Electrical

Signals
1. If necessary, press F7 to open the Domain Explorer.
• Double-click the Panels by Location folder, right-click a location, and
then on the shortcut menu, click New > PLC Panel.
• Double-click the Panels by Category folder, right-click the PLC
Panels folder, and then on the shortcut menu, click New > PLC
Panel.
3. Create an I/O card for the PLC panel. For details, see Create an I/O Card.
Tip
• When entering channel addresses for the I/O card, the values must be
numeric only for publishing to SmartPlant Electrical.
4. Create the cables needed to make the connections.
5. Add terminal strips to the cabinets that SmartPlant Instrumentation created
automatically from circuit signals that you downloaded from SmartPlant
Electrical.
6. Create device panels for tags that do not come from preassigned signals. Such
tags usually originate from SmartPlant Electrical control stations or from one of
the types of electrical equipment (motors, heaters, transformers, generators, and
so forth).
7. Create tag signals. For details, see Create a Local Signal for Electrical Tags,
page 299.
8. Connect the PLC to the cabinet using the cable you created.
9. Re-propagate the tag signal to the PLC. For details, see Re-Propagate a Tag
Signal.
Note
• You can use macros related to SmartPlant Electrical signal data to
generate Enhanced Report Utility reports or CAD application-based
drawings. For details, see SmartPlant Instrumentation Macro Structure.
Related Topics

Create a Device Panel for an Electrical Tag

This procedure shows you how to create a device panel for a tag that was created
from retrieved data originating in SmartPlant Electrical.
1. Open the Wiring module.

• On the Actions menu, click Device Panels.
4. To display SmartPlant Electrical tags only, in the Filter dialog box, enter values
as shown:
5. Click OK to return to the Device Panels window.

6. Select a tag number and do one of the following:
• On the Actions menu, click Create.

7. In the Create Device Panel and Cable dialog box, select the required default
panel, default cable, and connection type.
8. To apply the values that you set to all of the tags with incomplete profiles that you
selected in the Device Panels window, select Apply to all selected tags with
incomplete profile.
Related Topics

Create a Local Signal for Electrical Tags

This procedure shows you how to create a local signal in SmartPlant Instrumentation
for tags that were created from retrieved data originating in SmartPlant Electrical.
1. If necessary, press F7 to open the Domain Explorer.
2. Select one of the following:
• A terminal strip that you created for an automatically generated
cabinet (derived from the PDB in SmartPlant Electrical).
• A field device panel.
3. Right-click the selected item , and on the shortcut menu, click Actions >
Connection.
• Right-click in the data window and on the shortcut menu, click
Manage Local Signals.
5. In the Local Signal dialog box, click Filter.
6. In the Filter dialog box, select SmartPlant Electrical tags only. This option
selects only tags related to SmartPlant Electrical that do not have any connections.
• Select Preassigned signals only to select only those electrical tags for
which the SmartPlant Electrical signals have preassigned associations
to a power distribution board.
• Clear Preassigned signals only to select all unconnected tags related
to SmartPlant Electrical.
8. Click OK to return to the Local Signal dialog box.
9. Select a tag number and click Create to create and associate the local signal with
the tag number. Repeat this action for each tag number.
Tip
• SmartPlant Instrumentation creates the local signal and its name
appears next to the instrument tag with which it is associated in the
Local Signal dialog box.
10. Click Close.
Related Topics

Flow of Activities for Defining Power Supplies

The following steps constitute the primary flow of activities when you use SmartPlant
Instrumentation to define power supply requirements for instruments and cabinets:
1. In SmartPlant Instrumentation, press F7 to open the Domain Explorer.
2. Expand the appropriate folder to display instruments or panels.
3. Right-click the desired instrument or panel, and on the shortcut menu, click
Properties.
4. On the General tab of the dialog box for the selected item , select Requires
power supply.
Caution
• If the cabinet originated from PDB information in SmartPlant
Electrical, the power supply data for that cabinet belongs to
SmartPlant Electrical. In this case, entering power supply data in
SmartPlant Instrumentation results in the creation of a task in
SmartPlant Electrical that generates an error when run. To prevent
publishing of power supply data in this case, make sure that you clear
Requires power supply.
5. Click the Power Supply tab and enter your electrical load data.
6. Click OK to close the dialog box.
7. Publish the data to SmartPlant Electrical. This creates an .xml document
containing all SmartPlant Instrumentation data in the current plant such as the
control system configuration, I/O assignment, PLC I/O card and channel,
instrument tags, loop number, and so forth.
Tip
• The software creates the file in the path: <SmartPlant Instrumentation
home folder>\XML\IO Assignment_data.xml.
8. Retrieve the data in SmartPlant Electrical and run the tasks there to create
instruments and cabinets.
9. After assigning a PDB and circuit for each load, publish the data from SmartPlant
Electrical.
10. In SmartPlant Instrumentation, retrieve the SmartPlant Electrical data. For
details, see Retrieve SmartPlant Electrical Data, page 294.

12. View the tag numbers or cabinets in SmartPlant Instrumentation and note that
power distribution board data appears on the Power Supply tab of the appropriate
dialog box.
Notes
• The power distribution board data is also available for displaying in loop
drawings.
• You can repeat this procedure as many times as you want to; SmartPlant
Instrumentation recognizes new, modified, and deleted data that is
published from SmartPlant Electrical.
• The data is owned by the application that created it. If you modify or
delete the data in the application that does not own it, the next time you
retrieve the data from the owner application, it overwrites any modified
data, or reinserts data if it was deleted. A specific data property usually
belongs to one or other of the applications.
Related Topics
290

Publish Data for SmartPlant Electrical

1. Click Tools > Interfaces > SmartPlant Electrical.
2. Under Data Transfer mode, do one of the following:
• For instrument and panel data, click Publish electrical power
elements.
• For signal data, click Publish electrical signals.
Tip
• If the Windows Registry does not specify a value for the folder
location of the .xml file containing the published data, the Publish to
File dialog box opens for you to enter a location.
3. To view the log of the publishing process, in the Process dialog box, click View
Log.
Related Topics

DCS Vendor Interfaces

The DCS Vendor interfaces allow you to share data between SmartPlant
Instrumentation and the appropriate DCS vendor software at the component/card
level. If, for example, you design a loop that needs to be controlled by a particular
DCS system, you need to connect the loop wiring to I/O cards in the DCS for the
vendor that you specify. SmartPlant Instrumentation supports the following DCS
vendors:
DCS Product Name Vendor Available Activities

ABB ABB Retrieve I/O card catalog definitions
only
DeltaV Emerson Publish data and retrieve definitions
only
Honeywell Honeywell Retrieve I/O card catalog definitions
only
Yokogawa - CENTUM CS Yokogawa Full publish and retrieve
3000
Notes
• All DCS vendors support both conventional and Foundation Fieldbus
instruments.
• You are allowed to specify only one DCS vendor per domain.
Related Topics
• Flow of Activities for Configuring DeltaV, page 306
• Flow of Activities for Configuring Yokogawa CENTUM CS 3000, page
308
• Prerequisites for Working with DCS Vendor Interfaces, page 304

Prerequisites for Working with DCS Vendor

Interfaces
General Prerequisites
The DCS vendor interfaces function for any Oracle or SQL Server database that is
approved for SmartPlant Instrumentation Version 2007. (For details, see SmartPlant
Instrumentation Installation Guide, SmartPlant Instrumentation on Oracle and
SmartPlant Instrumentation on SQL Server.)
Make sure that you have Internet access to the URL from which you download the
particular DCS vendor definitions document.
Before you can work with any DCS vendor interface, it is necessary to perform the
following actions:
1. The System Administrator must enable the item registry. For details, see Enable
Item Registry in the Administration User's Guide, under System Administration,
Domain Management.
2. The Domain Administrator must register the items. For details, see Register
Items in the Administration User's Guide, under Working in an Integrated
Environment.
3. You should optimize your SmartPlant Instrumentation preferences for the
interface with your selected DCS vendor. For details, see Interfaces > DCS
Vendors (Preferences).
Additional Prerequisites for Publishing from SmartPlant Instrumentation
for all DCS Vendors
To prepare a workstation for publishing SmartPlant Instrumentation data for a DCS
vendor, you must install the following software:
1. SmartPlant Schema Component (on the SmartPlant Instrumentation CD Browser,
click Add-In Software > SmartPlant Schema Component Installation).
2. SmartPlant Client (on the SmartPlant Instrumentation CD Browser, click Add-In
Software > SmartPlant Client Installation).
Additional Prerequisites for Publishing from SmartPlant Instrumentation
for DeltaV
To publish data in a domain where your default DCS vendor is DeltaV, after
installing SmartPlant Schema Component and SmartPlant Client, you must do the
following:
1. Copy the files IntoolsMap_DeltaV.xml, ContextMap.xml, and
NamingConventionMap.xml to another folder.

2. In the folder to which you copied the files, rename the IntoolsMap_DeltaV.xml
file to IntoolsMap.xml.
3. In the Administration module, map the XML path to this folder for each domain
where you intend to publish DeltaV data. For domains where you publish data for
DCS vendors other than DeltaV, you should map the XML path to the original
file locations. For further details of how to specify the XML path, see Configure
SmartPlant Instrumentation for an Integrated Environment in the Administration
User's Guide, under Working in an Integrated Environment.
Related Topics
308

Flow of Activities for Configuring DeltaV

This topic describes the primary flow of activities when you use SmartPlant
Instrumentation to design a plant to be run and controlled using the Emerson DeltaV
plant automation and control system. Note that the flow that follows may be
performed multiple times during the project life cycle.
1. Download DeltaV Definitions

The process of creating DeltaV definitions in SmartPlant Instrumentation involves
two stages. In the first stage, you download the DeltaV definition files to your local
computer or to a network. For more information, see Download DeltaV Definitions,
page 310.
2. Retrieve DeltaV Definitions

The second stage involves retrieving the DeltaV definitions into SmartPlant
Instrumentation. The DeltaV item definition documents that you download and
retrieve in SmartPlant Instrumentation constitute the engineering library of DeltaV
objects - the DeltaV DCS (Distributed Control System), Foundation Fieldbus
elements, and entries for supporting tables such as Manufacturer, Model, and so
forth. For more information, see Retrieve DeltaV Definitions, page 311.
3. Update Your Plant Design

Using the DeltaV-compatible objects now available in the Reference Explorer and
supporting tables of your SmartPlant Instrumentation database, update your plant
design. From the perspective of SmartPlant Instrumentation, the DeltaV DCS
(Distributed Control System) panel is a DCS in the Reference Explorer from which
you create a specific DeltaV DCS in the Domain Explorer.
For details, see:
• View DCS Vendor Items in SmartPlant Instrumentation, page 324

• Create Compatible Wiring Items for DCS Vendors in SmartPlant
Instrumentation, page 325.
For information on how to make associations between Foundation Fieldbus device
types, instrument manufacturers, and SmartPlant Instrumentation instrument types,
see Associate Foundation Fieldbus Device Types for DCS Vendors, page 327.
For information on how to create Foundation field devices, see Create Foundation
Fieldbus and Profibus Instruments.

4. Publish Data for DeltaV

The .xml document that you publish (export) is a partial set of the SmartPlant
Instrumentation database, including data such as the DeltaV configuration, I/O
assignment, conventional and fieldbus data, and so forth.
After you complete the process of designing your DeltaV-compatible plant in

SmartPlant Instrumentation, use this procedure to publish (export) the required data
for accurate and efficient DeltaV configuration. You publish a partial set of the
SmartPlant Instrumentation database, including data such as the DeltaV
configuration, I/O assignment, instrument tags, and so forth. (The process does not
export specification data, for example.) For more information, see Publish Data for
DeltaV, page 322.
5. Retrieve Data Published from SmartPlant Instrumentation into DeltaV

Following the retrieval, validate and — if necessary — reconcile the data retrieved
from SmartPlant Instrumentation with the DeltaV database.
Related Topics
• Crucial Fields for the DeltaV Interface, page 315
• DCS Vendor Interfaces: An Overview, page 303

Flow of Activities for Configuring Yokogawa

CENTUM CS 3000
This topic describes the primary flow of activities when you use SmartPlant
Instrumentation to design a plant to be run and controlled using the Yokogawa
CENTUM CS 3000 plant automation and control system. Note that the flow that
follows may be performed multiple times during the project life cycle.
1. Retrieve the Yokogawa CENTUM CS 3000 Definitions

The Yokogawa CENTUM CS 3000 item definition documents that you download and
retrieve in SmartPlant Instrumentation constitute the engineering library of
Yokogawa CENTUM CS 3000 objects - Yokogawa CENTUM CS 3000 I/O cards,
Foundation Fieldbus elements, and entries for supporting tables such as
Manufacturer, Model, and so forth. For more information, see Retrieve Yokogawa
CENTUM CS 3000 Definitions, page 312.
2. Retrieve Yokogawa CENTUM CS 3000 Panel Data

For more information, see Retrieve Yokogawa CENTUM CS 3000 Panel Data.
3. Update Your Plant Design

Using the Yokogawa CENTUM CS 3000-compatible objects now available in the
Reference Explorer and supporting tables of your SmartPlant Instrumentation
database, update your plant design. From the perspective of SmartPlant
Instrumentation, the Yokogawa CENTUM CS 3000 panel is a DCS in the Reference
Explorer from which you create a specific Yokogawa CENTUM CS 3000 DCS in
the Domain Explorer.
For details, see:

Instrumentation, page 325.
For information on how to make associations between Foundation Fieldbus device
types, instrument manufacturers, and SmartPlant Instrumentation instrument types,
see Associate Foundation Fieldbus Device Types for DCS Vendors, page 327.
For information on how to create Foundation field devices, see Create Foundation
Fieldbus and Profibus Instruments.

4. Publish Data for Yokogawa CENTUM CS 3000

The .xml document that you publish (export) is a partial set of the SmartPlant
Instrumentation database, including data such as the Yokogawa CENTUM CS 3000
configuration, I/O assignment, conventional and fieldbus data, and so forth.
After you complete the process of designing your Yokogawa CENTUM CS 3000-
compatible plant in SmartPlant Instrumentation, use this procedure to publish (export)
the required data for accurate and efficient Yokogawa CENTUM CS 3000
configuration. You publish a partial set of the SmartPlant Instrumentation database,
including data such as the Yokogawa CENTUM CS 3000 configuration, I/O
assignment, instrument tags, and so forth. (The process does not export specification
data, for example.) For more information, see Publish Data for Yokogawa CENTUM
CS 3000, page 323.
5. Retrieve Data Published from SmartPlant Instrumentation into

Yokogawa CENTUM CS 3000
Following the retrieval, validate and — if necessary — reconcile the data retrieved
from SmartPlant Instrumentation with the Yokogawa CENTUM CS 3000 database.
Related Topics
• Data Limitations for the Yokogawa CENTUM CS 3000 Interface, page
319

Download DeltaV Definitions

Important
• Before you start this procedure, make sure that you have an Internet
connection and a valid Intergraph customer user name and password.
1. In any SmartPlant Instrumentation module, click Tools > Interfaces > DeltaV.
2. Under Data transfer mode, select Retrieve DeltaV definitions and click OK.
3. On the Retrieve DeltaV Definitions dialog box, beside Click here to download
the definitions, click the link.
4. On the Welcome to Intergraph Process Power & Marine Web page that opens,
type your Intergraph customer user name and password, and then click the arrow
to the right of Log in.
5. To access the Emerson DeltaV website, on the Downloads page, click Products
> SmartPlant Instrumentation.
6. On the SmartPlant Instrumentation Customer Support Site page, click
Special Announcements.
7. Under Emerson Process Management DeltaV definition files for SmartPlant
Instrumentation now available for download, click Go.
8. On the Emerson DeltaV website, under DeltaV SmartPlant Instrumentation
Integration, confirm the terms of use agreement.
9. For each of the .zip files displayed, select the option button and then click
Download.
10. On the File Download dialog box, click Save.
11. On the Save As dialog box, navigate to the desired folder, and click Save.
12. On the Download Complete dialog box, click Close.
13. In Windows Explorer or comparable utility, unzip to a common folder the files
that you downloaded.
Related Topics
• Retrieve DeltaV Definitions, page 311
• SmartPlant Instrumentation - DCS Vendors: Comparative Terminology,
page 326
• View the Log File for a DCS Vendor, page 324

Retrieve DeltaV Definitions

Important
• Make sure that you have downloaded the DeltaV definitions to your local
computer or network. For details, see Related Topics.
• SmartPlant Instrumentation is only capable of handling certain I/O types
that DeltaV supports. For this reason, not all of the I/O cards that you
download in the DeltaV definitions are compatible with SmartPlant
Instrumentation: for example, the interface does not handle ASI and Serial
cards.
2. Under Data transfer mode, select Retrieve DeltaV definitions and click OK.
3. On the Retrieve DeltaV Definitions dialog box, click Browse, navigate to the
folder to which you unzipped the files that you downloaded, and click OK.
4. In the data window, under Select, select the documents that you want to retrieve
in SmartPlant Instrumentation, and click OK.
Note
• Once you have retrieved the definitions, you can use them to make
appropriate associations among Foundation Fieldbus device types,
instrument manufacturers, and SmartPlant Instrumentation instrument
types. For details, see Associate Foundation Fieldbus Device Types for
DCS Vendors, page 327.
Related Topics
• Download DeltaV Definitions, page 310
page 326

Retrieve Yokogawa CENTUM CS 3000 Definitions

Important
1. In any SmartPlant Instrumentation module, click Tools > Interfaces > Yokogawa
CENTUM CS 3000.
2. Under Data transfer mode, select Retrieve Yokogawa CENTUM CS 3000
definitions and click OK.
3. On the Retrieve Yokogawa CENTUM CS 3000 Definitions dialog box, click
Browse, navigate to the folder that contains the Yokogawa files, and click OK.
Note
Related Topics
308
page 326

Retrieve Honeywell Definitions

Important
• SmartPlant Instrumentation is only capable of handling the following I/O
types that Honeywell supports:
• PMIO.
• Series C IO.
• Safety Manager IO (SM).
• Fail Safe Controller IO (FSC).
1. In any SmartPlant Instrumentation module, click Tools > Interfaces >
Honeywell.
2. On the Retrieve Honeywell Definitions dialog box, click Browse, navigate to the
folder to which you unzipped the files that you downloaded, and click OK.
Note
Related Topics

Retrieve ABB Definitions

Important
• SmartPlant Instrumentation is only capable of handling certain I/O types
that ABB supports. For details of supported I/O card catalog definitions,
contact Intergraph Support.
1. In any SmartPlant Instrumentation module, click Tools > Interfaces > ABB.
2. On the Retrieve ABB Definitions dialog box, click Browse, navigate to the
folder that contains the ABB files, and click OK.
Note
Related Topics

Crucial Fields for the DeltaV Interface

When you prepare a SmartPlant Instrumentation domain for publishing to DeltaV,
you must be careful to enter values according to the table that follows.
Important
• If you diverge from the following table and its notes, the software does not
validate the data; however, the DeltaV reconciliation program will reject
data values that are incompatible. For complete details of the exact
DeltaV values to use, please refer to your DeltaV Hardware Manual.
• If you intend to publish fieldbus data, set the relevant option on the
Preferences dialog box. For details, see Interfaces > DCS Vendors
(Preferences).
Dialog Box Field Accept Enter Valid Optional
DeltaV Value Value
Value
DCS Properties Type - - Y
DCS Properties Manufacturer - - Y
Racks Number of Slots Y
See note #3
Racks Rack position Y
numbering See note #3
I/O Card Series Y - -
Properties,
General tab
I/O Card Type Y - -
Properties,
General tab
I/O Card Manufacturer Y - -
Properties,
General tab
I/O Card I/O type Y - -
Properties,
Control System
tab
I/O Card Rack/Carrier - Y -
Properties,
Control System
tab

I/O Card Controller/Processor - Y -

Properties, See note #4
Control System
tab
I/O Card Define a Redundant Y - -
Properties, I/O See note #5
Control System
tab
Controllers Controller - Y -
See note #4
Controllers Redundant - Y -
Controllers Manufacturer - Emerson -
Process
Terminal Terminal - Y -
Properties
Terminal Sequence Y - -
Properties
Terminal Terminal color - Y -
Properties
Terminal Channel Y - -
Properties
Channels Channel Y - -
Channels Enable - Y -
Channels Channel type - Y -
See note #6
Channel Types Channel type Y - -
See note #6
Tag Number Manufacturer - Y -
Properties See note #7
General tab
Tag Number Field device address - Y -
Fieldbus tab
Tag Number Fieldbus device - Y -
Properties revision See note #9
Fieldbus tab
Tag Number Backup link master - Y -
Fieldbus tab

Notes
1. The value Y (Yes) is an indication to act according to the column header as
follows:
• Accept DeltaV Value— Do NOT change the value of this field.
• Enter Valid Value— Accept the value retrieved from DeltaV, if one
exists, or enter a different valid value.
• Optional Value— Accept the value retrieved from DeltaV, if one
exists, or enter a different valid value, or enter no value.
2. Although there are additional optional fields in the dialog boxes listed, the table
only includes optional fields for which data is retrieved from DeltaV.
3. In the Racks dialog box, under Rack position numbering, accept the default
selection of Start from one. In the data window, for each rack that you create,
type the value 8 under Number of slots.
4. A controller name must be upper case, and not more than 16 characters. You
must assign the same controller to all of the I/O cards that share a given
rack/carrier.
5. If you are defining a DeltaV redundant I/O card for a DCS panel, make sure that
in the Primary location group box the value under Position is an odd number,
and that the secondary location position value is an even number one greater than
the position value for the primary location.
6. DeltaV redundant I/O cards are wide and therefore they occupy two adjacent slots
in their carriers. Note that the cards can only be placed in odd-numbered slots.
DeltaV I/O cards have their terminations on the I/O cards themselves, and so there
is no need for separate termination cards to be connected to the I/O cards. On the
Control System tab of the I/O Termination dialog box, you must select the
Define a redundant I/O card check box. On publishing the data, this indicates to
DeltaV that the card is defined as a redundant double-width I/O card.
7. You can use only the following DeltaV cards as redundant I/O cards:
• AI_8CH_HART_4-20_RED
• AO_8CH_HART_4-20_RED
• RFIC
• DI_8CH_24VDC_DCT_RED
• DO_8CH_24VDC_HSS_RED
• RED_PROG_SERIAL_32DS
• RED_SERIAL_32DS
8. After you retrieve DeltaV definitions, the Channel Types supporting table is
populated with DeltaV-compatible channel types for DeltaV-compatible I/O strip
types. These are the only DeltaV-compatible values for the Channel Type field in
the Channels dialog box.

9. When you create a fieldbus tag based on an given instrument type, on the
General tab of the Tag Number Properties dialog box, make sure that the value
that you select from the Manufacturer list is among the acceptable values that
you set for this instrument type during retrieval from DeltaV.
10. On the Fieldbus tab of the Tag Number Properties dialog box, under Field
device address, you must type a value between 20 and 35 (inclusive). If you
select the Backup link master check box, type the value 20 under Field device
address.
11. The values available on the Fieldbus tab of the Tag Number Properties dialog
box under Fieldbus device revision are determined by the value that you select
from the Manufacturer list on the General tab.
12. On the Fieldbus tab of the Tag Number Properties dialog box, select the
Backup link master check box only for a device that you verified is capable of
being a backup.
Related Topics
• Publish Data for DeltaV, page 322

Data Limitations for the Yokogawa CENTUM CS 3000

Interface
When you prepare a SmartPlant Instrumentation domain for publishing to Yokogawa
CENTUM CS 3000, you must be careful to enter values with limitations according to
the table that follows. In most cases, the software validates the data; however, it does
not validate data that you merge in the database or data that you enter via a browser
view; in these cases, it is up to you to check that the values comply with these
limitations.
Important
• SmartPlant Instrumentation validates the data only if the DCS
manufacturer name is CENTUM CS 3000.
• If you intend to publish fieldbus data, set the relevant option on the
Preferences dialog box. For details, see Interfaces > DCS Vendors
(Preferences).
• Only ONE I/O card is allowed per slot.
• Spaces are not allowed in Yokogawa CENTUM CS 3000 tags, therefore,
when publishing data, SmartPlant Instrumentation removes spaces in
instrument and Control System tags. You can specify a substitute
character, such as an underscore, to replace the spaces; to do so, you must
add the following line in the Intools.ini file under the [Framework]
section:
NameSpacesReplacement = "_"
It is recommended not to select any character that appears in the tag names
as the substitute character because when retrieving data back from
Yokogawa CENTUM CS 3000, SmartPlant Instrumentation replaces that
character with spaces again.
Item Type Limitation
Panel The panel name is not allowed to exceed 7
characters.
Panel The Panel DCS naming must start with
the string "FCS".
Panel The Panel DCS naming must contain two
2-digit numeric strings.
Panel The first number in the panel DCS must
be between 1 and 32.
Panel The second number in the panel DCS
must be between 1 and 64.

Panel The Naming Convention for a default

panel is read-only and must not be
modified.
I/O Card The DCS manufacturer name is
CENTUM CS 3000 and this must not be
modified.
I/O Card The following properties are read-only
and must not be modified: card type, I/O
type, model, module, controller.
I/O Card The card name and type must be the same.
I/O Card A card can only appear under a slot.
I/O Card The Naming Convention for default
Wiring Equipment is read-only and must
not be modified.
I/O Card The controller or the module for a default
card is read-only and must not be
modified.
I/O Card The series for I/O Wiring Equipment is
read-only and must not be modified.
Control System Tag The DCS function block name is not
allowed to exceed 16 characters.
Control System Tag The control strategy drawing number must
be between 1 and 200.
Control System Tag The control system tag description is not
allowed to exceed 24 characters.
Channel The channel name and sequence values
must be the same.
Channel The channel address is read-only and must
not be modified.
Rack The default rack name is read-only and
must not be modified.
Rack The cabinet rack name must be between 1
and 15 characters.
Slot The slot name must be between 1 and 8
characters.
Slot The controller for a default slot is read-
only and must not be modified.

Publishing Data for DCS Vendors

After you complete the process of designing your DCS vendor-compatible plant in
SmartPlant Instrumentation, you publish (export) the data for accurate and efficient
configuration in the DSC vendor software. SmartPlant Instrumentation publishes a
partial set of the database, including configuration data, I/O assignment data,
instrument tags, and so forth.
Important
• The published data does not include certain items, for example,
specification data.
• Before you publish SmartPlant Instrumentation data for a DCS vendor,
you must comply with certain prerequisites. For details, see Prerequisites
for Working with DCS Vendor Interfaces, page 304.
• On publishing data other than for the first time, the DCS vendor program
identifies changes as follows:
• The software identifies new items created in SmartPlant
Instrumentation as new items to be created in the DCS vendor
program.
• If you move items, cards, CS tags, or if you modify item fields in
SmartPlant Instrumentation, the software identifies these as items to be
updated in the DCS vendor program.
• The software identifies items deleted in SmartPlant Instrumentation as
items to be deleted in the DCS vendor program.
Related Topics
Instrumentation, page 325
page 326

Publish Data for DeltaV

2. On the DeltaV Interface dialog box, under Data transfer mode, click Publish
SmartPlant Instrumentation data, and then click OK.
Tip
• If prompted to enable item registry (even though your System
Administrator has already activated this option as required), contact
SmartPlant Instrumentation support.
• .
3. On the Plant Controller Selection dialog box, do one of the following:
• To publish all relevant database fields for DeltaV, select the Select all
check box.
• For publishing of data associated with a given controller, select the
Select check box next to that controller.
4. On the Publish to File dialog box, under Folder to save XML files, type the path
for DeltaV publishing, and click OK to publish the .xml file for the first controller
that you selected.
5. For each additional controller that you selected in the SmartPlant Instrumentation
Plant Controller Selection dialog box, when the Publish to File dialog box
reopens, click OK.
Note
• SmartPlant Instrumentation publishes the data associated with each
controller into a separate .xml file.
Related Topics
• Crucial Fields for the DeltaV Interface, page 315
• Publishing Data for DCS Vendors, page 321

Publish Data for Yokogawa CENTUM CS 3000

Important
• Spaces are not allowed in Yokogawa CENTUM CS 3000 tags, therefore,
when publishing data, SmartPlant Instrumentation removes spaces in
instrument and Control System tags. You can specify a substitute
character, such as an underscore, to replace the spaces; to do so, you must
add the following line in the Intools.ini file under the [Framework]
section:
NameSpacesReplacement = "_".
1. In any SmartPlant Instrumentation module, click Tools > Interfaces > Yokogawa
CENTUM CS 3000.
2. On the Yokogawa CENTUM CS 3000 Interface dialog box, under Data
transfer mode, click Publish SmartPlant Instrumentation data, and then click
OK.
Tip
• If prompted to enable item registry (even though your System
Administrator has already activated this option as required), contact
SmartPlant Instrumentation support.
3. On the Plant Panel Selection dialog box, do one of the following:
• To publish all relevant database fields for Yokogawa CENTUM CS
3000, select the Select all check box.
• For publishing of data associated with a given DCS panel, select the
Select check box next to that panel.
4. On the Publish to File dialog box, under Folder to save XML files, type the path
for Yokogawa CENTUM CS 3000 publishing, and click OK to publish the .xml
file for the first DCS panel that you selected.
5. For each additional DCS panel that you selected in the SmartPlant
Instrumentation Plant Panel Selection dialog box, when the Publish to File
dialog box reopens, click OK.
Note
• SmartPlant Instrumentation publishes the data associated with each DCS
panel into a separate .xml file.
Related Topics
319
• Publishing Data for DCS Vendors, page 321

View the Log File for a DCS Vendor

Note
• After you retrieve item definition documents from a DCS vendor into
SmartPlant Instrumentation, you can use this procedure to view and save
the log. You can then open the .txt file in a word processor or text editor
and print it.
1. On the appropriate DCS vendor dialog box, for example, Retrieve Yokogawa -
CENTUM CS 3000 Definitions, click View Log.
2. On the Log dialog box, view the log.
3. To save the log as a .txt file, click Save.
4. On the Select File dialog box, navigate to the desired folder and type a file name.
5. Click Save.
Related Topics
View DCS Vendor Items in SmartPlant Instrumentation

After you retrieve the item definitions document into SmartPlant Instrumentation, use
this procedure to view the DCS vendor I/O cards.
Important
• In the Reference Explorer, do not change any of the values in the items
that you retrieved from the DCS vendor.
1. Open the Reference Explorer.
2. Expand the hierarchy of a downloaded DCS panel to the I/O card level.
3. Right-click an I/O card, and on the shortcut menu, click Properties.
Related Topics
Instrumentation, page 325
• Retrieve Yokogawa CENTUM CS 3000 Definitions, page 312
page 326

Create Compatible Wiring Items for DCS Vendors in

Use these procedures to create actual wiring items in the plant that you are designing.
First you must retrieve definitions for the selected DCS vendor into your SmartPlant
Important
• For specific guidelines regarding data values that are acceptable for the
selected DCS vendor, see:
• Crucial Fields for the DeltaV Interface, page 315.
319.
1. Open the Reference Explorer and the Domain Explorer.
2. In the Domain Explorer, create and populate a DCS panel by dragging the I/O
cards that are contained in the DCS vendor panel in the Reference Explorer.
Related Topics

SmartPlant Instrumentation - DCS Vendors: Comparative

Terminology
Although the SmartPlant Instrumentation - DCS vendor interfaces effect automated
transfer of definitions and data, it is important to understand some of the differences
in terminology between SmartPlant Instrumentation and different DCS vendors. The
following is a partial list:
SmartPlant SmartPlant DeltaV CENTUM CS

Instrumentation Instrumentation Terminology 3000
Dialog Box Terminology Terminology
Distributed Control Rack Carrier Node
System (DCS)
Properties;
Racks
Racks Slot Position
Card Module
I/O Card Properties; Strip Type I/O Card Type
Strip Type
Channels; Channel Type I/O Channel
Channel Types Type
Channels; Channel Channel Terminal
Terminal Properties (conventional)
Channel (fieldbus) Port
I/O Termination Termination
Board
Fieldbus Instrument Instrument Type + Device Type
Tag Association Description
Related Topics

Associate Foundation Fieldbus Device Types for

DCS Vendors
Use this procedure to make associations between Foundation Fieldbus device types,
instrument manufacturers, and SmartPlant Instrumentation instrument types.
1. Click Tools > Interfaces > Associate Foundation Fieldbus Device Types.
2. In the Tree View pane, click to expand the Certified Fieldbus Instruments list
and display the available manufacturers.
• Select a manufacturer to view details of all the devices available for
that manufacturer.
• For a particular manufacturer, click and select a device to view
details of that device.
4. In the Details pane, select the desired function block of a particular device and
click Associate.
5. In the Instrument Types dialog box, do one of the following:
• Select an existing fieldbus instrument type for which the I/O type
value is Fieldbus, for association with the current device type.
• Create a new fieldbus instrument type or edit an existing one.
Important
• When you create fieldbus tags that are compatible with the DCS
vendor, the only acceptable values for instrument type are those that
you associated with device types for that vendor during the
downloading process.
6. Click OK to associate the selected instrument type with the current device type
and close the Instrument Types dialog box.
Important
• When you create a fieldbus tag based on the displayed instrument type,
the only acceptable values for the manufacturer are those displayed in
this dialog box. If you select other manufacturers, this will prevent
validation in the DCS vendor's database.
• You can associate only one function block for each device type with a
particular instrument type.

Notes
• For general guidelines regarding fieldbus devices, see Foundation
Fieldbus Design: An Overview and Profibus Design: An Overview.

Fluke Interface
Fluke Interface
This interface allows you to exchange calibration data with the Fluke Documenting
Process Calibrator models 743B and 744. By means of wizards, you can download
(export) tag number data to the calibrator, and after collecting the calibration data,
you can upload (import) calibration data into SmartPlant Instrumentation for all of the
calibrated tag numbers.
Note
• If you are working on a Citrix console to which a Fluke Calibrator is
connected, to enable the software to detect the calibrator on the serial port
located on the client machine, you must first map the serial port to the
client machine as follows:
1. Within the Citrix console, at the server location, click Start > Run.
2. On the Run dialog box, in the Open box, type: cmd
3. At the command prompt, type: net use
A summary of the mapping between local and remote ports similar to the
following should appear:
4. If the desired port, for example COM 1, does not appear in the summary, then
type: net use COM1: \\Client\COM1:
5. At the command prompt, type net use again and check that the desired serial
port is now included in the mapping.

Fluke Interface

You use this dialog box to perform point-to-point publish and retrieve operations
between SmartPlant Instrumentation and SmartPlant Electrical.
Data transfer mode

• Publish electrical power elements— Allows you to publish SmartPlant
Instrumentation load instrument and cabinet data for retrieval into
SmartPlant Electrical. In general, you select this option after making the
appropriate changes in cabinet and instrument power supply data.
• Publish electrical signals— Allows you to publish SmartPlant
Instrumentation signal data for retrieval into SmartPlant Electrical. In
general, you select this option after making the appropriate wiring
connections and control system associations for the tags that SmartPlant
Instrumentation creates based on SmartPlant Electrical data.
• Retrieve SmartPlant Electrical data— Allows you to retrieve
SmartPlant Electrical signals into SmartPlant Instrumentation. This option
allows the SmartPlant Electrical user to benefit from the ability of
SmartPlant Instrumentation to make wiring definitions. The data is
contained in files that are in the same folder location as the SmartPlant
Electrical plant.
DeltaV Interface
You use this dialog box to perform data exchange operations between SmartPlant
Instrumentation and the DeltaV application. For further information, see DCS
Vendor Interfaces: An Overview, page 303.
Data transfer mode

• Retrieve DeltaV definitions — Opens a dialog box from which you
open a Web browser to the Intergraph customer website, access the
Emerson DeltaV website, and download item definition documents in .zip
format. After you manually unzip the files that you downloaded, you
import the definitions into SmartPlant Instrumentation.
• Publish SmartPlant Instrumentation data— Allows you to publish
SmartPlant Instrumentation data for retrieval into DeltaV. In general, you
select this option after designing a DeltaV-compatible plant in SmartPlant
Instrumentation, based on the DeltaV definitions.

Fluke Interface
Retrieve DeltaV Definitions

From this dialog box, you begin the process of data exchange between DeltaV and
SmartPlant Instrumentation. The software opens a Web browser to the Intergraph
customer website, from which you access the Emerson DeltaV website, and
download item definition documents in .zip format. After you manually unzip the
files that you downloaded, you import the definitions into SmartPlant
Instrumentation.
Click here to download the definitions — Click the link to open a Web browser to
the Intergraph customer website, from which you access the Emerson DeltaV
website, and download item definitions documents in .zip format.
DeltaV definitions folder — After you download and unzip the item definition
documents, type the path to the folder to which you unzipped them, or click Browse
to navigate to the folder.
(Data Window)
If there are no files to show, this window displays messages, rather than the Select
and Document fields.
Select — Select the check box to the left of documents that you want to import.
Document — Displays the XML files available for importing into SmartPlant
Instrumentation.
OK — Imports into SmartPlant Instrumentation the XML files that you selected in
the data window. If you selected a file with fieldbus definitions, opens a dialog box
where you associate SmartPlant Instrumentation instrument types with DeltaV device
types.
View Log — Opens a dialog box to display the DeltaV interface log.

Fluke Interface
Plant Controller Selection

This dialog box opens automatically in the course of publishing (exporting)
SmartPlant Instrumentation data for the DeltaV application. You have the option of
selecting sets of data grouped according to I/O card controllers (processors) that you
manage in the Controllers dialog box. For more information, see Publish Data for
DeltaV, page 322.
(Data Window)
Displays the controllers defined for your plant in the Controllers dialog box.
Select — To select for export to DeltaV all of the data associated with a given
controller, select this check box.
Controller — Displays the controller name.
Description — Displays the controller description.
Select all — To select for export to DeltaV data associated with all of the controllers
displayed in the data window, select this check box.
Yokogawa CENTUM CS 3000 Interface

You use this dialog box to perform data exchange operations between SmartPlant
Instrumentation and the Yokogawa CENTUM CS 3000 application. For further
information, see DCS Vendor Interfaces: An Overview, page 303.
Data transfer mode

• Retrieve Yokogawa CENTUM CS 3000 definitions — Opens a dialog
box from which you open a Web browser to the Intergraph customer
website, access the Yokogawa website, and download item definition
documents in .zip format. After you manually unzip the files that you
downloaded, you import the definitions into SmartPlant Instrumentation.
• Publish SmartPlant Instrumentation data— Allows you to publish
SmartPlant Instrumentation data for retrieval into Yokogawa CENTUM
CS 3000. In general, you select this option after designing a CS 3000-
compatible plant in SmartPlant Instrumentation, based on the Yokogawa
CENTUM CS 3000 definitions.
• Retrieve Yokogawa CENTUM CS 3000 data— Allows you to retrieve
Yokogawa CENTUM CS 3000 item definitions into SmartPlant
Instrumentation.

Fluke Interface
Retrieve Yokogawa CENTUM CS 3000 Definitions

From this dialog box, you begin the process of data exchange between Yokogawa
CENTUM CS 3000 and SmartPlant Instrumentation. You browse to the folder
containing the Yokogawa definitions and select the documents that you want to
retrieve into SmartPlant Instrumentation.
Type the path to the folder containing the item definition documents or click Browse
(Data Window)
Select — Select the check box to the left of documents that you want to retrieve.
Document — Displays the .xml files available for importing into SmartPlant
Instrumentation.
Progress — Displays the percentage of the definition retrieval process that has been
completed.
Activity — Displays the current activity of the definition retrieval process.
OK — Imports into SmartPlant Instrumentation the XML files that you selected in
where you associate SmartPlant Instrumentation instrument types with Yokogawa
CENTUM CS 3000 device types.
View Log — Opens a dialog box to display the Yokogawa CENTUM CS 3000
interface log.

Fluke Interface
Plant DCS Panel Selection

This dialog box opens automatically in the course of publishing (exporting)
SmartPlant Instrumentation data for the Yokogawa CENTUM CS3000 application.
You have the option of selecting sets of data grouped according to I/O card DCS
panels (processors) that you manage in the DCS Panels dialog box. For more
information, see Publishing Data for Yokogawa CENTUM CS3000.
(Data Window)
Displays the DCS panels defined for your plant in the DCS Panels dialog box.
Select — To select for export to Yokogawa CENTUM CS3000 all of the data
associated with a given DCS panel, select this check box.
DCS panel — Displays the DCS panel name.
Description — Displays the DCS panel description.
Select all — To select for export to Yokogawa CENTUM CS3000 data associated
with all of the DCS panels displayed in the data window, select this check box.

Fluke Interface
Retrieve Honeywell Definitions

From this dialog box, you begin the process of data exchange between Honeywell and
SmartPlant Instrumentation. You browse to the folder containing the Honeywell
definitions and select the documents that you want to retrieve into SmartPlant
Instrumentation.
Honeywell definitions folder

(Data Window)
Instrumentation.
completed.
OK — Imports into SmartPlant Instrumentation the .xml files that you selected in
where you associate SmartPlant Instrumentation instrument types with Honeywell
device types.
View Log — Opens a dialog box to display the Honeywell interface log.

Fluke Interface
Retrieve ABB Definitions

From this dialog box, you begin the process of data exchange between ABB and
SmartPlant Instrumentation. You browse to the folder containing the ABB
definitions and select the documents that you want to retrieve into SmartPlant
Instrumentation.
ABB definitions folder

(Data Window)
Instrumentation.
completed.
OK — Imports into SmartPlant Instrumentation the .xml files that you selected in
where you associate SmartPlant Instrumentation instrument types with ABB device
types.
View Log — Opens a dialog box to display the ABB interface log.

Fluke Interface
Associate Foundation Fieldbus Device Types with

Instrument Type
You use this dialog box to associate one or more SmartPlant Instrumentation
instrument types with each device type for DCS vendors from which you retrieve
definition files.
For information as to how your preferences settings influence this process, see
Interfaces > DCS Vendors (Preferences).
Tree View
Certified Fieldbus Instruments — Displays certified fieldbus instrument device
types organized by manufacturer. Click the icons to expand the view of the items
in the tree.
Details
Manufacturer — Displays the manufacturer of the given instrument.
Device Type — Displays the fieldbus device type.
Revision — Displays the device type revision.
Function Block — Displays the number of the function block.
Instrument Type — If an instrument type is associated with the function block,

displays the description of that instrument type.
Associate — Opens the Instrument Types dialog box to allow you to select a
SmartPlant Instrumentation instrument type for associating with a function block.
Dissociate (active after you select a row in the Association data window) —
Dissociates the selected row from the function block.

Working with SmartPlant Integration

SmartPlant integration standardizes and improves the communication among the
various authoring tools you use in the course of designing, constructing, and
operating a plant. SmartPlant integration manages data exchange among these
authoring tools, which enables sharing and re-use of plant information throughout the
plant lifecycle. SmartPlant Foundation acts as a repository for data and a medium
through which information is shared among other tools, such as SmartPlant Electrical,
SmartPlant P&ID, and Zyqad.
Most of the commands that provide access to SmartPlant integration functionality

exist in the common user interface available on the SmartPlant menu in SmartPlant
Instrumentation.
The following graphic displays what SmartPlant Instrumentation publishes and

retrieves and shows the flow of data and the different types of data.
SmartPlant Instrumentation interacts with SmartPlant Foundation by correlating items

between the plant database and the SmartPlant Foundation database, retrieving such
documents as Cabinets, Electrical Signals, P&IDs, and the like from SmartPlant.
Also, SmartPlant Instrumentation creates a set of tasks in the To Do List that you can
run to update the plant database. In SmartPlant Instrumentation, you can also use the

SmartPlant menu to publish documents and retrieve data, access the SmartPlant
Foundation Web Client in order to browse data, and subscribe to change notifications
and compare documents.
You can only use the SmartPlant menu commands after your plant is registered. For
more information, see Configuring SmartPlant Instrumentation for an Integrated
Environment: An Overview in the Administration User's Guide, under Domain
Administration, SmartPlant and Item Registry and Related Topics.
Registering Tools
Before you can publish and retrieve information from any of the authoring tools, you
must register each plant in SmartPlant Instrumentation with a SmartPlant Foundation
database. The connection allows SmartPlant Instrumentation to use the SmartPlant
integration commands. A SmartPlant Instrumentation Domain Administrator
typically performs the registration.
The software maps a plant and all its projects to a single SmartPlant Foundation URL,
which points to one, and only one, SmartPlant Foundation plant database and its
projects. When you use the Register command in any of the authoring tools, you are
registering an authoring tool plant with a SmartPlant Foundation URL and plant that
you specify.
The Domain Administrator must register each plant in the authoring tool once; this
action takes place in the Administration module. After the plant is registered, you can
publish and retrieve documents.
Note
• When working with SmartPlant integration, there are certain requirements
relating to As-Built and projects. For a description of these and other
requirements, see Working with SmartPlant Instrumentation in an
Integrated Environment.
Related Topics
• Access the SmartPlant Foundation Web Client, page 350
• Publishing in an Integrated Environment: An Overview, page 396
• Retrieving in an Integrated Environment: An Overview, page 417
• Using the To Do List: An Overview, page 423

Setting Up SmartPlant Instrumentation for an Integrated Environment
Setting Up SmartPlant Instrumentation for an

Integrated Environment
The following lists include rules that must be followed when using SmartPlant
Instrumentation in an integrated environment. Following these rules allows
SmartPlant Instrumentation data to be shared correctly with other integration tools.
The software retrieves instrument data at the lowest plant hierarchy level in the plant
hierarchy item that you logged on to in SmartPlant Instrumentation, for example a
unit. The software retrieves wiring data, such as panels and cables, in the highest
plant hierarchy level. Provided a plant is registered, you can publish and retrieve data
in SmartPlant Instrumentation, subject to the limitations indicated in the following
sections.

Integrating SmartPlant Instrumentation with

SmartPlant P&ID
General
• Both SmartPlant Instrumentation and SmartPlant P&ID must have the
same plant hierarchy structure, with a minimum of three levels.
• The domain name in SmartPlant Instrumentation must be different from
the plant name in SmartPlant P&ID.
• You cannot change the plant hierarchy template or names of plant
hierarchy levels after retrieving documents from SmartPlant P&ID for the
first time. You can, however, change the names of individual plant group
items, if you desire.
Working with Projects
• You can edit items in the project where you are publishing or retrieving
new objects, however, you CANNOT edit As-Built items unless you have
claimed them to a project, other than for publishing data. In Options
Manager, under General Settings, you can disable editing in As-Built
using the Allow Full Access to As-Built option.
• In Options Manager, under General Settings, you must set the Claim
Mode option to Exclusive only. As a result, you cannot claim the same
items for multiple projects.
• You cannot perform a manual claim of any items belonging to the
following item types that are shared between SmartPlant Instrumentation
and SmartPlant P&ID: tag numbers, loops, lines, equipment, and control
system tags. This requirement exists because SmartPlant P&ID performs
the scoping and SmartPlant Instrumentation automatically claims scoped
items when you retrieve data. You can manually claim any unshared
items such as panels, strips, terminal, cables, cable sets, wires, and so
forth.
• In SmartPlant Instrumentation, the software automatically claims control
systems tags for pre-assigned instruments to the project whenever the
instruments are claimed. However, for unassigned instruments, you must
claim the control system tags separately in order to assign them to these
instruments in the project.
• You must merge all shared items at the same time; you cannot perform a
partial merge of shared items.

Publishing Data
• You are not allowed to publish data from As-Built. Doing so results in
items appearing more than once (for As-Built and for each project where
the item is claimed). Instead, you must open the specific project from
which you want to publish the data.
Retrieving Process Function and Instrument Type Data
While there is no requirement to specify process function and instrument type values
when publishing from SmartPlant P&ID, you should be aware of the following:
• SmartPlant P&ID has a property, InstrumentComponentType, that

sometimes, but not always, matches the instrument type in SmartPlant
Instrumentation. This property is part of the SmartPlant P&ID symbol.
Only by replacing the symbol can you change the value of the
InstrumentComponentType property for in an instrument that was
already placed on the drawing. If the symbol does not provide enough
information to publish an instrument type that is recognized by SmartPlant
Instrumentation, on retrieving data in SmartPlant Instrumentation, the
software specifies the process function and instrument type based on the
name of the instrument, where the instrument naming convention includes
an Instrument Type segment. For example, if the name of the instrument
is FT-100, the software assigns to it instrument type FT and process
function Flow.
• If SmartPlant Instrumentation recognizes a particular instrument type that
has more than one description, the software assigns to the instrument the
instrument type description designated as the default.
• If SmartPlant P&ID cannot publish an instrument type, or if it publishes
an instrument type that SmartPlant Instrumentation is unable to recognize,
then on retrieving the data, SmartPlant Instrumentation does not assign an
instrument type. You can then specify the instrument type manually in
• If you have already specified an instrument type in SmartPlant
Instrumentation and you run an update task that has a null or unrecognized
instrument type, the software does not overwrite the existing instrument
type.

Integrating SmartPlant Instrumentation with

SmartPlant Electrical
In order to have a successful data exchange between SmartPlant Instrumentation and
SmartPlant Electrical, make sure that:
• Both SmartPlant Instrumentation and SmartPlant Electrical have the same

plant hierarchy structure, with a minimum of three levels.
• In SmartPlant Instrumentation, instruments and I/O signals are defined on
the lowest plant hierarchy level.
• In SmartPlant Instrumentation, cabinets are defined on the highest plant
hierarchy level.
• In SmartPlant Electrical, you defined a registered report for both the I/O
lists and for Instruments requiring power supply.
You must also ensure that the following SmartPlant Electrical select lists and
SmartPlant Instrumentation supporting tables contain identical values:
• System I/0 type

• Rated Voltage
• Power Supply AC/DC Flag
• Number of Phases
• Operating Mode
• Process Function
• Frequency
Furthermore, in the Administration module, in the Domain Definition window, the
System Administrator must clear the check box Allow claims for multiple projects
(if working in an operating owner domain).

In the two tools, the units of measure of certain properties might be defined using a
different precision accuracy. For example, 1.2 kW (one-digit accuracy of precision)
in SmartPlant Electrical corresponds to 1.23 kW (two-digit accuracy of precision) in
SmartPlant Instrumentation. This may result in inconsistencies and could be
interpreted as an update when retrieving data.
These properties are:
• Rated Active Power

• Rated Reactive Power
• Rated Apparent Power
• Full Load Current
• Operating Mode Coincidence Factors (X, Y, Z, ZZ)
• Starting Current

Naming Convention Requirements when Publishing

and Retrieving Items
Instruments, Loops, Control System Tags and other objects in SmartPlant
Instrumentation have a naming convention. The names of these objects are made of
segments with predefined length and separators between the segments.
The mapping between the segments of the name and properties in the SmartPlant
schema is determined by the content of the NamingConventionMap.xml file. For
details, see Naming Convention Mapping
Instrument Retrieval
When you retrieve an instrument, the software populates the tag number segments
from the retrieved instrument object properties according to the following mapping:
Segment Property
1 InstrTagPrefix
2 MeasuredVariable+InstrFuncModifier
3 InstrTagSequenceNo
4 InstrTagSuffix
Segment 1 is populated with the InstrTagPrefix
Segment 2 is populated with the concatenation of MeasuredVariable and

InstrFuncModifier
Segment 3 is populated with the InstrTagSequenceNo
Segment 4 is populated with the InstrTagSuffix
The segments are then trimmed and put together according to the naming convention
to create the tag number.
If the naming convention in other tools (for example, SmartPlant P&ID) does not
include a prefix, the first segment length needs to be set to 0.

Loop Retrieval
When you retrieve a loop, the software populates the loop name segments from the
retrieved instrument object properties according to the following mapping:
Segment Property
1 LoopPrefix
2 LoopIdentifier
3
4 LoopSequenceNo
5 LoopSuff
Segment 1 is populated with the LoopPrefix
Segment 2 is populated with the LoopIdentifier
Segment 4 is populated with the LoopSequenceNo
Segment 5 is populated with the LoopSuff
Segment 3 is not populated and needs to be set to length 0

Instrument Publishing
When you publish an instrument, the software populates the published object
properties by the naming convention segments as follows:
Property Segment Comment

InstrTagPrefix 1
MeasuredVariable 2 Left side of segment 2
InstrFuncModifier 2 Right side of segment 2
InstrTagSequenceNo 3
InstrTagSuffix 4
The object name is populated by the tag number with all spaces removed. If the
length of prefix is more than 0, the prefix will be part of the object name. Other
applications that publish instruments (for example, SmartPlant P&ID) need to be
configured to publish the instrument object name with the prefix.
The MeasuredVariable and InstrFuncModifier are both populated be the second

segment. If the first two characters of segment 2 are included in the
TwoLetterMeasuredVariable list that was defined in the SmartPlant Instrumentation
mapping file, then the MeasuredVariable gets these two letters; if not then the
MeasuredVariable gets the first character of segment 2. In both cases, the
InstrFuncModifier gets the rest of the characters of segment 2. This allows correct
publishing of instruments such as PDT or DPT.
TwoLetterMeasuredVariable
DP
PD
FQ
FF
TD
WD
ZD
FO

Loop Publishing
When you publish a loop, the software populates the published object properties by
the naming convention segments as follows:
Property Segment
LoopPrefix 1
LoopIdentifier 2+3
LoopSequenceNo 4
LoopSuff 5
The object name is populated by the loop name with all spaces removed. If the length
of prefix is more than 0, the prefix will be part of the object name. Other applications
that publish loops (for example, SmartPlant P&ID) need to be configured to publish
the loop object name with the prefix.
An example of an instrument naming convention:

An example of a loop naming convention:

Access the SmartPlant Foundation Web Client

Click SmartPlant > Browser.
Tip
• This command is available only if the active plant has been registered.
For more information, see Configuring SmartPlant Instrumentation for an
Integrated Environment: An Overview in the Administration User's Guide,
under SmartPlant Integration and Item Registry and Related Topics.
Note
• From the SmartPlant Foundation Web Client, you can perform a number
of tasks, such as publishing or retrieving documents, comparing
documents, subscribing to document changes, and so forth. Many of these
tasks can be performed from the authoring tools, such as SmartPlant P&ID
or SmartPlant Electrical, but the Web Client provides unique access to
other features such as the Web Client To Do List and search capabilities.
Related Topics
• Working with SmartPlant Integration: An Overview, page 338

Document Publish and Retrieve Matrix

The following table lists authoring tools that participate in integration and the
documents that those authoring tools publish and retrieve.
Authoring Tool Publishable Retrieved By

Documents
Zyqad SmartPlant P&ID SmartPlant
Electrical
Zyqad Equipment X
Datasheets
Equipment Lists (published X
as Equipment Datasheets)
Process Flow Diagrams X
Stream Datasheets X
(published as Equipment
Datasheets)
SmartPlant P&ID P&IDs X X X X
SmartPlant Electrical Cable Schedule X
Reports
SPEL Electrical Power X
Elements Reports
SPEL Electrical Signal List X
Reports
SmartPlant Instrumentation Browsers
(Viewable Files)
Dimensional Datasheets X
(DDP)
Instrument Index X
Documents
Instrument Loop Diagrams
Instrument Process
Datasheets
Instrument Specification
Sheets
SPI Electrical Power X
Elements Reports
SPI Electrical Signal List X
Reports

SmartPlant 3D 3D Model Data

(SmartPlant
Review File Type)
3D Model Data filtered for X
cable schedule data
(SmartPlant Review File
Type)
Drawings (Viewable File
with Links to Data)
Reports (Viewable File
with Links to Data)
PDS Drawings
Model
Reports
SmartPlant Foundation Equipment Lists X
Instrument Process X
Datasheets
Instrument Master Lists X
Plant Breakdown Structure X X X X
(PBS)
Project Breakdown X
Structure
Project Definition X X
Documents
Project Lists X X
Notes
• SmartPlant Engineering Manager retrieves plant and project information
for SmartPlant P&ID and SmartPlant Electrical.
• SmartPlant Review is integrated with SmartPlant Foundation for
interactively reviewing 3D models.
Related Topics
• Retrieving in an Integrated Environment: An Overview, page 417

Updating SmartPlant Information in Title Blocks
Updating SmartPlant Information in Title

Blocks
Update Title Block is a SmartPlant Foundation add-in that allows you to update
published SmartPlant Instrumentation reports to the latest revisions and include issue
data in the custom title blocks. Also, the add-in converts the published reports with
their title blocks from SmartPlant Instrumentation native format (.brw , .ssf, and .spd
files) to .pdf files.
Notes
• For the .brw , .ssf, and .spd file types, SmartPlant Foundation uses the
following component address (ProgID):
SPITitleBlock.TitleBlockInfo
• These file types are already configured in the delivered database dump
files.
For a detailed flow of activities, see Updating SmartPlant Information in Title
Blocks: Flow of Activities, page 354.

Updating SmartPlant Information in Title Blocks:

Flow of Activities
The following is the required flow of activities for the Update Title Block add-in.
1. Configure the Custom Title Blocks for Integration Reports

Prior to running the Update Title Block add-in, you need to configure your custom
title blocks so that they meet integration requirements. For more information, see
Title Block Requirements for Integration Reports, page 355.
2. Configure the PDF Generator

In order to generate your reports as PDF files, you need to configure your PDF
generator according to integration requirements. For more information, see
Configuring the PDF Generator, page 360.
3. Install the Update Title Block Component

After you have configured your custom title blocks and the PDF generator, you need
to install the Update Title Block Component. This component contains the DLL file
that enables the imprint of issue data in your custom title blocks in native SmartPlant
Instrumentation format and the conversion the reports to PDF. For more information,
see Install the Update Title Block Component for SmartPlant Instrumentation, page
368.
4. Define PDF Generation Settings

This option allows you to update the .ini file of the Update Title Block add-in. You
can set the location of the PDF generator and define the default printer. For more
information, see Define PDF Generation Settings, page 369.
5. Run the Update Title Block Add-In

This option allows you to run the Update Title Block add-in. Note that you need to
retrieve the relevant reports from the SmartPlant Foundation server. The software
retrieves these reports as .zip files. For more information, see Run the Update Title
Block Add-In, page 370.
Related Topics
• Updating SmartPlant Information in Title Blocks: An Overview, page 353

Title Block Requirements for Integration Reports

The title blocks in the reports used for integration contain macros that specify issue
data. You can generate these reports either in SmartPlant Instrumentation native
format (.brw, .ssf. or spd) or enhanced report (.sma) format. For both of these
formats, there are shipped files that you can use that include the correct formatting
and data for the reports. There are also certain requirements that you need to follow
if you intend to customize your own reports.

PowerSoft Reports
The title block files for the reports in .psr format are in the location <SmartPlant
Instrumentation installation folder>\PSR\ and the available files are as follows:
• A3tall_inchunit.psr
• A3tall_pbunit.psr
• A3wideborder_inchunit.psr
• A3wideborder_pbunit.psr
• A4tall_inch.psr
• A4tall_pbunit.psr
• A4tall_pbunit_general.psr
• A4widerborder_inchunit.psr
• A4widerborder_pbunit.psr
If you are creating your own custom reports in .psr format in which you want to
include issue data, you must create a custom title block and add macros as shown in
the following table.
Section Heading Macro Name

ISSUE issueno_x
REV issuedrevision_x
MATERIAL OR JOB SPEC materialorjobspec_x
BID (DATE ISSUED FOR) bid_x
FAB (DATE ISSUED FOR) fabrication_x
CONST (DATE ISSUED FOR) construction_x
REF (DATE ISSUED FOR) reference_x
SITE sitename
SITE LOCATION sitelocation
DIVISION divisionname
DIVISION LOCATION divisionlocation
For the macro names, 'x' represents an integer used to specify the sequence, for
example, issueno_1, issueno_2, and so forth.

Enhanced Reports
The title blocks that use the .sma format are designed to be used by all the tools that
communicate in an integrated environment; however, if you use them in SmartPlant
Instrumentation as delivered, parts of the drawing may overlap the margins of the
drawing area. For this reason, you need to set values of the working area margins for
any templates that you intend to use for generating reports in an integrated
environment. To prepare the templates, you define the settings under Preferences >
Enhanced Reports (for all layouts of a particular report type) or for a specific layout
as desired.
The template files are installed on the SmartPlant Instrumentation machine. The
default location for enhanced report templates for the reports used in an integrated
environment is:
<SmartPlant Instrumentation installation folder>\RAD\Template\Generic\*.sma
The title block files are installed on the SmartPlant Instrumentation machine. The
default location for enhanced report title blocks for the reports used in an integrated
environment is:
<SmartPlant Instrumentation installation
folder>\RAD\Template\Generic\TitleBlocks\*.sym
The following settings represent the minimum values required for the working area
margins:
Title Block Left Right Top Bottom

D Wide 0.44 0.3 0.3 0
C Wide 0.7 0.3 0.3 0
B Wide 0.3 0.3 0.3 0
A1 Wide 0.7 0.3 0.5 0
B Tall 0 0 0.3 0
A3 Tall 0 0 0.3 0
A Wide 0 0 0.3 0
A2 Wide 0.7 0.2 0.5 0
A3 Wide 0 0 0.3 0
A4 Wide 0 0 0.4 0
Note
• To place issue data on other title blocks for enhanced reports, use the
SmartPlant Instrumentation 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.

Associating a Custom Title Block with SmartPlant

Instrumentation
After you have finished creating a report title block and customized it in InfoMaker to
fit your needs, you need to associate it with SmartPlant Instrumentation so that the
Domain Administrator can assign it to the appropriate reports. If needed, you can edit
the associated title block properties by defining the headers for revision custom fields
and defining the headers for the drawing records.
Note
• There are title blocks that come shipped with SmartPlant Instrumentation.
For the list of available title blocks and their descriptions, see Title Block
Descriptions in the Administration User's Guide, under Domain and
Project Administration, Report Management
Open a Custom Title Block

Blocks.
2. In the Title Blocks dialog box, click New to open the Title Block Properties
dialog box.
• Navigate to the .psr file that you have created containing the new
custom title block, and select this file.
• Navigate to the default tb with in units.psr file, or the default tb with
pb units.psr file.
4. Click Open.
5. In the Title Block Properties dialog box, do the following if required:
title block.
Tip

6. Click OK to save the edited title block and add it to the inventory of title blocks
7. In the Title Blocks dialog box, click Close to return to the main window.
Related Topics

Configuring the PDF Generator

In order to generate your reports as PDF files, you need to configure your PDF
generator according to the requirements for integration or for SmartPlant
Instrumentation Server. Note that for Acrobat Distiller, you must have Administrator
privileges in the account where you installed the software.
Follow the steps in the procedure appropriate for your PDF generator:
• Configure Adobe PostScript Printer Driver

• Configure Adobe Acrobat Distiller 7, page 363
Related Topics
• Updating SmartPlant Information in Title Blocks: Flow of Activities, page
354
Configure the Generic PostScript Printer

1. Click Start > Settings > Printers and Faxes > Generic PostScript Printer.
2. Click Printer > Properties.
3. On the Ports tab, select the new redirected port you created when creating your
generic postscript printer, and then click Configure Port.

4. On the <Port> Properties dialog box, enter the path to the GPL Ghostscript
software executable file in the Redirect this port to the program box. For
example, type:
c:\gs\gs8.54\bin\gswin32c.exe
Tip
• If the program is installed in a location other than C:\gs\, after
installing SmartPlant Instrumentation, open the Intools.ini file, and
under the [PRINTER] section, add the line PDFDIR=<folder path>,
for example, type:
PDFDIR=d:\gs\gs8.54\bin\
5. In the box Arguments for this program are, type:

@c:\gs\pdfwrite.rsp -c .setpdfwrite -f -dCompatibilityLevel#1.5 -
Caution
• You must have a space between #1.5 and -.
Tips
• If the GPL Ghostscript software is installed in a location other than the
default c:\gs\ folder, create the folder c:\gs\ and give the
SmartPlant Instrumentation Server user read/write access to this
folder. This folder will be used to store the pdfswrite.rsp file.
• If you do not want to use the c:\gs\ folder, you can use any other folder
according to the following criteria:

• The SmartPlant Instrumentation Server user has read\write access

to this folder.
• Replace the @c:\gs\ at the beginning of the argument with @<your
folder path>.
6. In the Output list, select Program handles output, and in the Run list, select
Normal.
Tip
• If you are installing the printer driver on the SmartPlant server for
integration or if you are using Ghostscript from Citrix or a remote
desktop, make sure that the Run as User check box is selected to
avoid errors when generating PDF files.
• If you are installing the printer driver on the SmartPlant
Instrumentation Client or Server, make sure that the Run as User
check box is cleared to avoid errors when generating PDF files.
7. Click OK on the <Port> Properties dialog box.
8. On the Advanced tab of the Generic PostScript Printer Properties dialog box,
verify the following:
• The Always Available option is selected.
• The Print directly to the printer option is enabled.
9. Click OK to close the Generic PostScript Printer Properties dialog box.
Related Topics
354

Configure Adobe Acrobat Distiller 7

1. Log on to the Windows account where you have administrator privileges.
2. In the SmartPlant Instrumentation home folder, create a new folder PDF Output
for the output .pdf files.
3. Click Start > Settings > Printers and Faxes > Adobe PDF.
4. Click Printer > Properties.
5. Click the Ports tab, and then click Add Port.
6. On the Printer Ports dialog box, select Adobe PDF Port.
7. Click New Port and navigate to the SmartPlant\Instrumentation\PDF Output
folder path.
8. Create a new port pointing to the PDF Output folder.
9. Close the Printer Ports dialog box.
10. Click the Advanced tab and ensure that the Print directly to the printer option
is selected.
11. Go to the General tab and click Printing Preferences.
12. On the Adobe PDF Printing Preferences dialog box, click the Adobe PDF
Settings tab.
13. Beside Adobe PDF Output Folder, select the path to the PDF output folder that
you defined.

14. Clear the View Adobe PDF results check box.
Related Topics
• Configuring the PDF Generator, page 360
354
Test the PostScript Printer Configuration

1. Open Notepad and create a text file named PDFWrite.rsp in the folder specified
for PDF generator path. This file creates a Ghostscript device named PDFWrite
and sets some parameters for the device.
2. Type the following lines in the PDFWrite.rsp file:
-Ic:\gs\gs8.54\lib;c:\gs\fonts
-sDEVICE=pdfwrite
-r300
-dNOPAUSE
-dSAFER
-sPAPERSIZE=A4
-sOUTPUTFILE=c:\gs\test\gs_test_output.pdf

Tips
• If the library and font files are installed in locations other than the
default, or if your GPL Ghostscript version is other than 8.54, type
appropriate parameters in the first line, for example:
-Id:\gs\gs8.15\lib;d:\Program Files\gs\fonts
For more information about the Ghostscript installation folder, see Install
GPL Ghostscript.
• You can change -r300 to -r600 to use a higher resolution (600dpi).

• You can change -sPAPERSIZE=A4 to -sPAPERSIZE=Letter to use
letter paper size.
• If you want the output file to be generated in a location other than the
path shown, type an appropriate path for the -sOUTPUTFILE
parameter. If you are using Ghostscript from Citrix or a remote
desktop, the output path must be on the same machine as the
Ghostscript installation. The software updates the -sOUTPUTFILE
parameter automatically when Ghostscript generates a PDF file.
3. Test the generation of .pdf files by opening the Generic PostScript Printer
Properties dialog box and clicking Print Test Page.
Tips
• The .pdf file should appear in the output folder that you specified. If a
Save As dialog box opens, or the .pdf file opens automatically, it is
recommended that you check the printer settings and ensure that all the
file paths are specified correctly, and then perform this procedure
again.
• If you obtain a .pdf file of the printer test page in the location specified
by the pdfwrite.rsp file, this indicates that the PostScript printer driver,
port redirection and Ghostscript are configured correctly.
• If the software is unable to print the test page but the print job still
appears in the queue, cancel the printing by going to Control Panel >
Administrative Tools and then double-click Services. Next, select
the Print Spooler service and click Actions > Restart.
4. Verify that this file is readable by opening it with Adobe Reader.
Important
• After testing your PostScript printer configuration, you must delete the
PDFWrite.rsp file, to avoid problems later on when publishing DDP
data.
Related Topics
• Configure the Generic PostScript Printer, page 360

Test the Acrobat Distiller Driver Configuration

Important
• When performing the printing test, make sure that no Acrobat Distiller
dialog boxes are open.
1. Log on to your IIS user (IDEAL_USER) account.
2. Access Windows Printers (Start > Settings > Printers).
3. Right-click Acrobat Distiller, and on the shortcut menu, click Properties.
4. Click the Ports tab and select the PDF port that you defined:
5. Click the General tab and click Print Test Page.

Tips
• The .pdf file should appear in the output folder that you specified. If a
Save As dialog box opens, or the .pdf file opens automatically, it is
recommended that you check the printer settings and ensure that all the

file paths are specified correctly, and then perform this procedure
again.
• If you obtain a .pdf file of the printer test page in the location specified
for the port, this indicates that the Acrobat Distiller printer driver is
configured correctly.
• If the software is unable to print the test page but the print job still
appears in the queue, cancel the printing by going to Control Panel >
Administrative Tools and then double-click Services. Next, select
the Print Spooler service and click Actions > Restart.
6. Verify that this file is readable by opening it with Adobe Reader.
Related Topics

Install the Update Title Block Component for SmartPlant

Instrumentation
The SmartPlant Instrumentation title block component is only required if you are
using SmartPlant Instrumentation in an integrated environment. The SmartPlant
Instrumentation title block component software must be installed on the same
computer as the SmartPlant Foundation Title Block component and PDF Generator
software. These components are usually installed on the SmartPlant Foundation
server, but may be installed on another server.
1. Insert the SmartPlant Foundation CD into the CD-ROM drive. If the installation
does not start automatically, double-click setup.exe on the CD.
2. Click SmartPlant Software in the SmartPlant Foundation Installation
window.
3. Click SmartPlant Instrumentation Title Block Installation.
Tip
• If you have installed the SmartPlant Instrumentation Title Block
component previously, the software prompts you to modify, repair, or
remove the older version of the component. After you uninstall the
older version, click SmartPlant Instrumentation Title Block
Installation again in the SmartPlant Foundation Installation
window.
4. Click Next.
5. To accept the default installation location for the SmartPlant Instrumentation Title
Block component, click Next.
Tip
• If you want to change the installation location, click Browse and
navigate to the new folder. Then, click Next.
6. Click Finish.
Related Topics
354

Define PDF Generation Settings

1. At the command line, type:
UpdateCTB.exe /s
Note
• By default, the UpdateCTB.exe file is delivered in the SmartPlant
Instrumentation home folder.
2. On the PDF Generator Settings dialog box, do one of the following:
• Under PDF generator path, type the file path that defines the location
of your PDF generator.
• Click Browse and navigate to the location you require.
3. Under Default printer, type the name of the default printer that will be used to
print out your PDF reports.
Related Topics
354

Run the Update Title Block Add-In

Although this command is generally used to update title blocks and generate PDF
files from within SmartPlant Instrumentation or SmartPlant Foundation, you can also
run it from the command line for testing purposes, or to generate a PDF file outside
the integrated environment.
• At the command line, type:

UpdateCTB.exe <path and name of the retrieved .brw, .ssf, or .spd
file> <path and name of the output .pdf file>
Example:
UpdateCTB.exe C:\Program Files\SmartPlant\Retrieved
Reports\Report1.brw D:\My_Reports\Report1.pdf
Related Topics
354

Schema Mapping
Schema Mapping
This section describes the assumptions, rules, and limitations imposed by the
SmartPlant Instrumentation adapter on schema mapping.
This section describes the structure of the tool schema and how it is used by the
authoring tool SmartPlant integration adapter in support of the publish and retrieve
operations. This topic does not provide a list of the classes, properties, or enumerated
lists (select lists) that are mapped by the delivered SmartPlant Instrumentation tool
schema. You can obtain this information by viewing the tool schema directly. This
set of topics does not describe the user interface of the Schema Editor.
Before modifying the mapping for SmartPlant Instrumentation, you must understand:
• The SmartPlant Instrumentation software

• The SmartPlant Instrumentation data model
• The delivered mapping for SmartPlant Instrumentation
• How the delivered mapping for SmartPlant Instrumentation works
• SmartPlant schema modeling
• The Schema Editor
• The To Do List feature of SmartPlant Instrumentation
In the topics that describe schema mapping, the following terms are frequently
referenced:
• Tool schema — Defines the SmartPlant Instrumentation objects to be

published or retrieved and how they map to objects in the SmartPlant
schema. The tool map schema implements mapping between the objects
in the SmartPlant Instrumentation data model and the objects in the
SmartPlant schema. Users who customize either the SmartPlant
Instrumentation data model or the SmartPlant schema may also need to
customize the mapping contained in the tool schema.
• SmartPlant schema — Defines the SmartPlant integration data model.
• Adapter — The SmartPlant Instrumentation code module that supports
the SmartPlant integration commands.
When you publish SmartPlant Instrumentation data, the SmartPlant integration
adapter extracts data from the SmartPlant Instrumentation database and converts it
into a set of objects and relationships that are compatible with the SmartPlant schema.
These objects and relationships are defined in an .xml file, which is sent to
SmartPlant Foundation for further processing. For SmartPlant Instrumentation, the
name of this file is INtoolsMap.xml, and it must be located in the folder specified in
the Path for SmartPlant XML files box of the Domain Definition window.

Schema Mapping
General Information About Schema Mapping

This topic provides general information about the mapping in SmartPlant
Instrumentation.
SmartPlant Instrumentation Adapter

Each authoring tool has an adapter that processes information during the publish and
retrieve operations. One of the adapter's functions is to map information between
SmartPlant Integration and the particular authoring tool. The SmartPlant
Instrumentation adapter is a component that belongs to SmartPlant Instrumentation
and requires installation of SmartPlant Instrumentation Version 2007 on one of the
following database platforms:
• Oracle 9.2.0 or 10g

• SQL Server 2000 or 2005
Any communication between SmartPlant Foundation and SmartPlant Instrumentation
is performed via this adapter, which sends information to SmartPlant Integration
through the Common UI where the user is shown the appropriate user interface and
data available.
The adapter does not handle tool schema files directly, but uses them indirectly. The
tool schema files are used to define the retrieve map file, which is then used by the
adapter. Direct use of the schema files would mean that the adapter accessed them
directly to do its work. Both retrieve and publish operations only work through map
files.
Mapping Configuration
The SmartPlant Instrumentation adapter uses the tool schema map file and the
Schema Editor, delivered with the SmartPlant Schema Component, to perform
mapping between the SmartPlant Instrumentation object structure and the structure of
objects in SmartPlant integration. The map file is installed with SmartPlant
Instrumentation Setup. This file includes all objects that are mapped for SmartPlant
integration (not the entire set of objects in SmartPlant Instrumentation, nor all
properties, but only those that are relevant for other applications that use SmartPlant
Integration).
Tool Schema Location

The name of the SmartPlant Instrumentation tool schema files are: INtoolsMap.xml,
ContextMap.xml, and NamingConventionMap.xml. SmartPlant Instrumentation uses
these files for all types of published and retrieved documents. They are installed by
default in the path <SmartPlant Instrumentation home folder>\XML\ and should be
treated as installation files. If you move or copy these .xml files to a different folder,
the System Administrator can specify the location in the Administration module,

Schema Mapping
Domain Definition window, by typing it in the Path for SmartPlant XML files
box. This allows you to specify a different tool schema for each domain.

Schema Mapping
Upgrading the SmartPlant Instrumentation Tool

Schema for a New Software Version
If you have previously customized the SmartPlant Instrumentation tool schema for a
previous version, you will need to upgrade the latest INtoolsMap.xml file in order to
preserve your custom changes.
Caution
• Before removing the previous version of SmartPlant Instrumentation, be
sure to back up your existing INtoolsMap.xml file so that you do not lose
your custom changes. The INtoolsMap.xml file is located in the path
<SmartPlant Instrumentation home folder>\XML\.
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 388
• Export a New Schema Configuration, page 390
• Workflow for Extending the Schema, page 375
Upgrade the SmartPlant Instrumentation Tool Schema

1. In the SmartPlant Instrumentation Administration module, log on as Domain
Administrator in the domain where you are going to work in an integrated
environment.
2. Click File > Domain Definition.
3. On the Domain Definition window, select the desired domain.
4. On the Module Toolbar, click Edit .
5. Beside Path for SmartPlant XML files, click Browse to navigate to the location
of the IntoolsMap.xml file containing your custom definitions.
6. Click SmartPlant > Upgrade Schema.
The software upgrades the IntoolsMap.xml file with the latest version data from
the files in the '<SmartPlant Instrumentation home folder>\XML\Backup' folder
path, and registers the schema version at the beginning of the file.
Related Topics
• Schema Mapping: An Overview, page 371

Schema Mapping
Workflow for Extending the Schema

When you need to extend the SmartPlant schema, such as when new properties or
select list entries are added, you or an administrator must take steps to update the data
in SmartPlant Instrumentation. The overall steps include:
1. Generate component schemas using the Schema Editor.
2. Run the SmartPlant Instrumentation Schema Configuration Wizard to extend the
configuration of the SmartPlant Instrumentation data model, which provides a
view of your data.
The wizard output is a schema hierarchy with the following structure:
Schema name
Document type
Object type (class)
Interface
Properties
The following example illustrates how the hierarchy is organized for two object
types, 'Loop' and 'Instrument', both belonging to the document type
'InstrumentIndex':
TEFPublish(publish)
InstrumentIndex
Loop
ILoop
LOOP_NAME
LOOP_SERV
Instrument
IInstrument
CMPNT_NAME
CMPNT_SERV
For details of the procedure, see Define a Schema for SmartPlant Instrumentation,
page 388.
3. Run the Export Schema Configuration Utility to create a new tool schema map
file using the classes that you selected with the SmartPlant Instrumentation
Schema Configuration Wizard. For details of the procedure, see Export a New
Schema Configuration, page 390.
Tips
• The tool schema class is identified by a unique name consisting of
<schema name>_<document name>_<class>.
• For SmartPlant Instrumentation, the source file is INtoolsMap.xml.

Schema Mapping
4. Using the Schema Editor, open the newly-created tool map class and synchronize
it with the SmartPlant Instrumentation tool schema. For more information, see
Synchronizing Schemas, page 383.
Important
• To be able to publish data that includes the new classes, you need to
rename the target .xml file to 'INtoolsMap.xml'.
Related Topics

Schema Mapping
Modify the Tool Schema for a Custom Plant Hierarchy

1. Create a hierarchy in SmartPlant Instrumentation that contains the same number
of levels as the one defined in the SmartPlant Foundation custom hierarchy. For
details, see Create a Plant Hierarchy in the Administration User's Guide, under
Domain Administration, Plant Design and Structure.
2. Modify the following information in the delivered INtoolsMap.xml file to map it
to the levels in the example custom hierarchy.
Tips
• The INtoolsMap.xml file is installed by default in the path
<SmartPlant Instrumentation home folder>\XML\.
INtoolsMap.xml File Level Mapped To Custom Hierarchy Level
TEFRetrieve_PBSDocument_Plant County Top level
TEFRetrieve_PBSDocument_Area City & District Intermediate levels
TEFRetrieve_PBSDocument_Unit Precinct Lowest level
• The values in the Mapped To column are for this example only. You
should substitute the appropriate values for your hierarchy.
• You will need to create new map classes ICity, IDistrict, and IPrecinct.
For details of the procedure, see Creating New Objects and
Relationships in the Schema: An Overview in the Schema Editor
User's Guide.
3. Launch Schema Editor.
4. On the Workflows dialog box, click the Tool Schema tab.
5. Click Open.

Schema Mapping
6. Navigate to the file path: Program Files > Common Files > Intergraph >
EFSchema > EFSchema.xml.
Tip
• The file may take some time to open.
7. Click Open to select the tool schema file.

Schema Mapping
8. Navigate to the INtoolsMap.xml file.

9. Click View.
10. On the View Tool Schema dialog box, from the Form list, select Tree/Table
Horizontal, and then click OK.
11. In the tree view, expand the SPMapClassDef node.
12. Scroll down to the TEFRetrieve_PBSDocument_Plant node.

Schema Mapping
13. Right-click this SPMapClass and on the shortcut menu, click Edit
INTL_TEFRetrieve_PBSDocument_Plant.
14. On the Edit Map Class Definition dialog box, under the Retrieve map section,
clear the value IPlant and click the ellipsis button as shown:
15. On the dialog box Possible ClassToMapClass\Classes for TEF

Retrieve_PBSDocument_Plant, in the Search box, type iplant.
16. Select IPlant as shown and click OK.

Schema Mapping
Tip
• The top level interface (IPlant in this example) cannot be renamed.
Therefore in the custom hierarchy, the top level will always be mapped
to IPlant. Consequently, the IPlant interface remains mapped to the
IPlant interface (as shown in the graphic) and no mapping changes are
required.
17. Click OK to close the Edit Map Class Definition dialog box.
18. Right-click the TEFRetrieve_PBSDocument_Area node, and on the shortcut
menu, click the Edit option.
clear the value IFunctionalArea and click the ellipsis button.
Retrieve_PBSDocument_Area, map the intermediate level interface to ICity and
IDistrict.
22. Right-click the TEFRetrieve_PBSDocument_Unit node, and on the shortcut
menu, click the Edit option.
clear the value IFunctionalUnit and click the ellipsis button.
Retrieve_PBSDocument_Unit, map the lowest level interface to IPrecinct.
26. Click File > Save.

Schema Mapping
27. Close the Schema Editor, and at the prompts to save the data and to load the
changes to the SmartPlant Foundation Server, click Yes.
Related Topics

Schema Mapping
Synchronizing Schemas
This section describes how to use the Schema Editor to synchronize the tool metadata
(stored in the tool's database) and the map schema file (INtoolsMap.xml) when you
define new properties for publishing or retrieving.
You can begin the update by first adding a new property to the tool metadata and then
synchronizing the map schema file to it, or you can first modify the map schema file
and then synchronize the metadata with it.
There is a special procedure for synchronizing newly-defined enumerated lists (select

lists). For details, see Synchronize an Enumerated List.
Note
• For SmartPlant Instrumentation, new properties are created using custom
fields.
Important
• You are not allowed to delete a property that you have already
synchronized between the tool metadata and the map schema file because
the software cannot determine whether data values exist for that property.
Related Topics
Synchronize the Map Schema File with the Tool Schema

1. In the SmartPlant Instrumentation Administration module, log on as Domain
Administrator in the domain defined for an integrated environment.
2. Click Activities > Custom Fields.
3. Select the plant that you have registered for integration.
4. Select the item type appropriate for the property you want to add.
5. Add the desired property name in the Definition column of a vacant custom field
(with field type Char).
6. Click Apply and then click Close.
7. Click Start > Intergraph SmartPlant Foundation > SmartPlant Schema
Component > SmartPlant Schema Editor.
8. In the Schema Editor Workflows window, click the Application Metadata tab.
9. Connect to the SmartPlant Foundation database as shown.

Schema Mapping
.
10. On the SmartPlant Foundation URL page of the SmartPlant Registration
Wizard, type the node name and virtual directory of the SmartPlant Foundation
database where you registered your plant. Use the following format:
http://<SPFServer>/<VirtualDirectory>.
For example:
http://<SPFServer>/SPFASP.
Tips
• Replace <SPFServer> with the name of your SmartPlant Foundation
Web server.
• Replace <VirtualDirectory> with the name of the virtual directory for
the SmartPlant Foundation Web Client. By default, the virtual
directory for the first instance of the Web Client that you install is
SPFASP. However, if you install multiple instances of the Web Client
to connect to multiple databases, the virtual directory name may be
different.
11. Click Next.
12. On the SmartPlant Foundation Plant page, select from the Plant name list the
SmartPlant Foundation plant in which you want to synchronize your data.
13. Click Next.
14. On the Engineering Application Options page, select from the Engineering
application/map schema list the schema for the tool that you want to
synchronize.

Schema Mapping
15. Under Startup options, select the Load map schema check box.
Tip
• For SmartPlant Instrumentation, the software automatically selects the
Connect to application schema check box.
16. If desired, select the Automatically synchronize schemas check box.
Tip
• You can select more than one schema from the Engineering
application/map schema list (if available) and specify the startup
options. In this case, the software will load the map schema for each
application and perform connection and synchronization as specified.
17. Click Finish to complete the connection.
The Synchronize window opens with all the properties selected by default for
synchronizing in the map schema file (located in this example in the path
C:\Program Files\SmartPlant\Instrumentation\XML\INtoolsMap.xml).

• Leave the properties selected where you want the software to
synchronize the map schema file by updating it with the value in the
database.
• Select the properties in the SPI Database column where you want the
software to update the database with the current value from the map
schema file.

Schema Mapping
19. Click OK to synchronize the data and open the Map Environment window.
20. Expand the SmartPlant Instrumentation node by clicking the icons.
21. Under the Map Classes node, scroll down to the IInstrumentUDF map class (the
instrument custom field where you created the new properties in SmartPlant
Instrumentation) and expand the node to display these properties.

Schema Mapping
Related Topics

Schema Mapping
Define a Schema for SmartPlant Instrumentation

1. In the Intools.ini file, add a new section, [FRAMEWORK], and type the
following parameter:
EnableTEFWizard=1
2. In the SmartPlant Instrumentation home folder, double-click the file spiscw.exe.
3. On the Logon Information dialog box, type your user name and password.
4. In the SmartPlant Instrumentation Schema Configuration Wizard, on the
Welcome page, click Next.
5. Select a SmartPlant Instrumentation domain and click Next.
6. On the Schema Options page, select whether to create an entirely new schema
definition or to modify an existing schema definition.
• For a new schema, on the Define New Schema Configuration page,
type a schema name and select the appropriate option according to
whether the purpose of the schema is to publish or retrieve
information. If you select to use the schema for publishing, type the
name of the target application.
• For an existing schema, on the Select Schema page, select the desired
schema and click Next.
Tip
• When selecting an existing schema, the word 'publish' or 'retrieve' in
parentheses indicates the purpose of the schema.
8. On the Select Document Type page, select from the list the document type that
you want to add to the schema and click Next.
Tips
• You can select only one document type at a time to add to the schema.
• Document types that have already been added to the schema are
indicated with an asterisk.
9. On the Select Object Types page, select the objects, representing a class of items
that you want to represent in the schema and click Next.
Tip
• All object types are available for any document type that you have
selected, although it is recommended that you select related object
types for a particular document type, for example, Cable, CableSet,
Wire.

Schema Mapping
10. On the Define Object Levels and Restrictions page, select the level at which to
set each object for determining parent-child relationships.
Tips
• The highest level must always be 0.
• The software publishes or retrieves data for object types at each
successive level associated with the object type at the next highest
level. For example:
Line (level 0)
Instrument (level 1)
Piping port (level 2)
Loop (level 2)
11. Select the check boxes as desired beside each object type to specify restrictions
according to the requirements of the target application.
12. When done, click Next.
13. For a publish schema, if desired, on the Define Filter Condition page, specify a
filter condition for each level 0 object type by selecting the object type and typing
an appropriate SQL command.
14. When done, click Next.
15. On the Select Object Interfaces page, select for each object type the desired
interfaces and click Next.
Tip
• Double-click an interface to view its properties.
16. On the Completing the Schema Configuration Wizard page, select the desired
options and click Finish.
Tip
• To prepare for the next stage of the mapping, select the Export to tool
schema check box.
Related Topics

Schema Mapping
Export a New Schema Configuration

1. In the SmartPlant Instrumentation home folder, double-click the file
UpdateToolSchema.exe.
2. On the Logon Information dialog box, type your user name and password.
3. In the Export Schema Configuration Utility, beside the Source tool schema field,
click the ellipsis button and navigate to the INtoolsMap.xml file.
4. Beside the Target tool schema field, click the ellipsis button and specify the
name of the .xml file that you want to use as the target.
Important
• After testing the updated schema to ensure that it works correctly, you
must rename the target file to 'INtoolsMap.xml' to enable the software
to publish the data successfully.
5. Click Connect to SmartPlant Instrumentation Domain.
6. On the Logon dialog box that opens, select the desired domain.
7. From the Object schema list, select the object schema that you want to export.
8. To export the object schema to the target tool schema, click Export.
Related Topics

Schema Mapping
Define and Map DDP Data

The following procedure is used when you want to publish instruments that have
dimensional data but where those instruments are not included in the schema. In an
integrated environment, the software supports publishing of dimensional data sheets
for certain dimensional groups only. For the full list of supported dimensional
groups, see List of Publishable Dimensional Groups.
1. The SmartPlant 3D user must define a symbol in the catalog for each instrument
that is going to be published from SmartPlant Instrumentation.
2. The SmartPlant 3D user must inform the SmartPlant Instrumentation user which
DDP attributes for the instrument need to be published.
3. Add the appropriate DDP attributes to the SmartPlant schema using the Schema
Editor.
4. The SmartPlant 3D user must map the DDP attributes to the SmartPlant schema.
5. Define the appropriate DDP attributes for the instrument in SmartPlant
Instrumentation.
6. Define the mapping between SmartPlant Instrumentation and the SmartPlant
schema.
Related Topics

Schema Mapping
Welcome to the SmartPlant Instrumentation Schema

Configuration Wizard
The Schema Configuration Wizard enables you to define, modify, or delete schemas
that you use to define the data set for publishing or retrieving. A schema definition
consists of the schema name and the target application. You can specify one or more
document types for each schema, and in the target application, you retrieve or publish
data for individual documents based on a single document type. After you generate a
schema, you need to map it to the .xml file used for publishing or retrieving your
data.
Select Domain
Select the SmartPlant Instrumentation domain for which you want to define a new
schema for publishing or retrieving data, modify an existing schema, or delete an
existing schema.
Schema Options
Select the desired schema option.
Define New Schema Configuration

Ensure that the schema name that you enter is unique for the domain. If the schema is
intended for publishing data, you must type a target application name that matches the
name of a supported application in an integrated environment.
Select Schema
Select the existing schema that you want to modify or delete. Note that there may be
more than one schema for a particular application and that separate schemas are
defined for publish and retrieve operations.

Schema Mapping
Select Document Type

Examples of document types are loops, cables, or PBS Documents. The document
type that you select is for recognition by the target application. You may add as
many document types to the schema as desired, however, you can select only one
document type at a time for addition to the schema. To add another document type,
run the wizard again after completing the current definition.
Select Object Types

All object types are available for selection regardless of the document type that you
selected; nevertheless it is recommended that you select object types that are
appropriate for the specified document type.
Define Object Levels and Restrictions

The options on this page apply to schemas used for retrieving data only. For objects
that you want to be at the highest level, you must specify a value of 0 for the level.
The software retrieves or publishes data for objects at lower levels based on the
appropriate object at the next highest level. Select restrictions for the objects
according to the requirements of the target application, for example, you may want to
specify a restriction that does not allow the creation or deletion of instruments.
Specifying a restriction generates a manual task for the restricted activity in the To
Do List after retrieval.
Define Filter Condition

Filter conditions apply to schemas used for retrieving data only. The software retains
the filter definition that you make for each object. Click Validate to verify that the
syntax of the filter condition is correct.
Select Object Interfaces

On this page, after you select an object type, highlight an object interface under
Available interfaces and click Add to select it for the object type. You cannot
perform multi-selection of interfaces, therefore you must repeat this action for each
interface that you want to add. Each interface consists of a group of related
engineering properties – these properties are hard-coded.

Schema Mapping
Select Interface Properties

On this page, after you select an object type, highlight an object interface under
Available interfaces and click Add to select it for the object type. You cannot
perform multi-selection of interfaces, therefore you must repeat this action for each
interface that you want to add. Each interface consists of a group of related
engineering properties – these properties are hard-coded.
Completing the Schema Configuration Wizard

The following options are available:
• To save the schema definitions to the database, select Save schema

definitions and then click Finish.
• To discard the current definitions and start again, select Restart wizard to
make another modification and then click Finish. If you select this
option with one or both check boxes selected, you can still create an SQL
file or export the definitions to the tool schema.
• To perform the mapping directly, select Export to tool schema.
• To save the definitions in an SQL file that you use to generate the
mapping to the XML component manually, select Create SQL file. The
software saves the SQL file in the SmartPlant Instrumentation home
folder.

Schema Mapping
Export Schema Configuration Utility

The Export Schema Configuration Utility enables you to copy existing map file data
into a new class definition so that the interfaces belonging to that class are exposed in
the tool schema.
Source tool schema — The name and path of the XML file that you use as the map
source. Click the ellipsis button to navigate to the desired location.
Target tool schema — The name and path of the XML file that you will obtain as
the output. Click the ellipsis button to navigate to the desired location.
Connect to Domain — Opens the Logon dialog box where you select the desired
SmartPlant Instrumentation domain.
Object schema — Select from the list the object schema that you want to export.
Export — Exports the selected object schema to the target tool schema.

Schema Mapping
Publishing in an Integrated Environment

In an integrated environment, the authoring tools share data and relationships when
you publish documents containing the data and relationships. The publishing process
involves selecting a document to publish, assigning it to a workflow when necessary,
and specifying a version and revision of the document if specified in SmartPlant
Foundation. For most documents, the software also publishes the data that is
associated with the document when you publish.
The authoring tools (SmartPlant P&ID or SmartPlant Instrumentation, for instance)

publish data in .xml format. All leading and trailing spaces are trimmed from all
strings and from all values without units. These spaces will not appear in the
published data file. The software then loads the data from the .xml files to the
SmartPlant Foundation database. After the data is loaded into SmartPlant
Foundation, you can retrieve the data from into other authoring tools.
When you publish documents, the software does the following things:
• Creates a new master document and the first revision in SmartPlant

Foundation the first time that you publish a particular document. From
that point on, the software creates new versions and revisions each time
that you publish the document. The software relates revisions to the
master document. You can publish subsequent revisions into a workflow,
which can be a different workflow from the original publish action.
Changes in the document status of a related revision change the status of
the subsequently published versions and revisions of the document.
• Publishes a visual representation of the document that you can view
without the authoring tool. For many applications, this is an Intergraph
proprietary file, called a RAD file. The viewable file can also be an Excel
workbook or another viewable file type, such as .pdf or .doc. Users can
review and edit the visual representation of the document using
SmartPlant Markup.
• Publishes associated data, depending on workflow approval. If the data is
approved and loaded, it is used for reporting and subsequent retrieval by
downstream applications. The software publishes only meaningful
engineering data. The published data is not enough to recreate the
document in the original authoring tool.
• The software publishes some document types without the associated data,
such as reports from authoring tools (for example, line lists in P&ID).
You can submit documents published without data to workflows just like
documents with data. The document types and data that you can publish
depend on the authoring tool that you use.
For more information about revisions and versions, see the SmartPlant Foundation
Web Client User's Guide.

Schema Mapping
Reasons to Publish
You can publish documents and associated data for several reasons:
• To exchange and enhance data among tools, to avoid creating data

multiple times in multiple authoring tools
• To report on common data that originates in multiple tools
• To provide enterprise-wide accessibility to published documents
• To manage change, including workflow history and document revision
management
You can also publish documents to share information with users in other tools
without going through a formal workflow. To share data, you can publish a
document to a For sharing workflow that has only a load step so that the data is
loaded into SmartPlant Foundation as soon as you publish the document.
You can also publish a document by not assigning the document to a workflow, but
rather by using the default workflow from SmartPlant Foundation. When you do not
select a workflow for a document during publishing, the SmartPlant Loader loads the
document into SmartPlant Foundation as soon as it reaches the top of the Loader
queue.
Document Types for Publishing

Each authoring tool publishes different documents and data. For details of documents
that each authoring tool can publish and retrieve, see Tool Documents That are
Published and Retrieved.
The published PBS document contains information about the physical plant with a
structure consisting of plants, areas, and units. The default structure is plant/area/unit,
but you can define a custom hierarchy in the Schema Editor. When a PBS document
is published from SmartPlant Foundation, the authoring tools are notified about the
plant, areas, and units that need to be created in each authoring tool.
The project breakdown structure, project definition document, and project list contain
information about projects and their statuses.
The project breakdown structure contains a single project and the hierarchy of
contracts under that project in a plant/project structure. The project definition
document contains information for a single project that needs to be created in the
authoring tool. The project list contains a list of all projects in a plant, and it is used
by those authoring tools that create all projects at one time.
Note
• The plant breakdown structure and project breakdown structure used in the
authoring tools must match the structure in SmartPlant Foundation for
publishing from the authoring tools and object correlation to work
correctly.

Schema Mapping
Publishing Files without Data

You can also browse to other file types on the file system, such as Microsoft Word or
Excel files, or SmartSketch® files, in order to publish them. These documents are
always published without data. The primary reasons to publish documents without
data are that the SmartPlant Foundation Change Management functionality can
manage document changes and reviews using workflows and that you can view the
documents electronically.
Note
• When you publish data from an authoring tool, you may not be able view
all the properties that you published in the SmartPlant Foundation client.
You can customize view definitions to allow you to see additional
properties. For more information about defining view definitions in the
SmartPlant schema, see Working with View Definitions: An Overview and
Create a View Definition in the Schema Editor User's Guide. For further
assistance with visualizing data in SmartPlant Foundation, contact
Intergraph Support Services.
Related Topics
• Access the SmartPlant Foundation Web Client, page 350

Schema Mapping
Publish Documents from SmartPlant Instrumentation

Caution
• When publishing documents, select a unit from a plant hierarchy.
• After you start to publish documents from an Instrument Index Standard
Browser view, you should not change the default view. Changing the view
can result in incorrect revision numbers and inconsistencies between the
graphical and XML output files.
Important
• Before you can publish SmartPlant Instrumentation engineering
documents, you must make a revision for each document you want to
publish. The software finds only those documents for which you have
made revisions. If you have made several revisions for one document, the
software finds a document containing the most recent revision.
• When publishing data from different units, you must specify separate
document numbers and sets of revisions for each unit. To do so, open the
Intools.ini file, and under the section, type the following line:
DrawingPerLevel=Y
1. Display one of the following:
• The main SmartPlant Instrumentation window with no modules
open.
• The Instrument Index Standard Browser view.
• An open instrument specification.
• An open process data sheet.
• An open dimensional data sheet.
• An open loop drawing sheet.
2. Click SmartPlant > Publish.
Tips
• This command is available only if you have registered the active plant
using the SmartPlant Registration Wizard.
• If you logged onto SmartPlant Instrumentation with a user name that is
not defined in the integrated environment, you are prompted to log on
when you use this command.
• The documents that appear in the Selected documents list on the
Publish dialog box when it first appears are documents that were
selected within SmartPlant Instrumentation before you accessed the
Publish command.

Schema Mapping
3. Add any additional documents to the Selected documents list by clicking the
Engineering Tool, File System, or Find toolbar buttons and choosing other
documents to publish.
4. In the Document Selection Wizard, on the Select Document Type page, select
the check boxes for the types of documents you want to publish.
5. Click Next.
6. On the Select Unit page, navigate to the lowest level plant hierarchy item, such as
a unit, from which you want to publish documents.
Tips
• Double-click the icons to expand the plant hierarchy.
• The Next command is enabled only after you select a unit.
7. Click Next.
8. Depending on your document type selection, select engineering documents on
each Select page that opens as follows:
• Specify search parameters as necessary, and then click Find.
• In the Search results data window, select the rows for the documents
that you want to publish, and then click Next.
Note
• If you select the Instrument Index check box on the Select
Document Type page, the software automatically finds the instrument
index document that exists in the unit.

Schema Mapping
9. On the Document Selection Summary page, review your selections, and click
Finish to exit the Document Selection Wizard and return to the Publish dialog
box.
Tip
• To redefine your selections, click Back.
10. On the Publish dialog box, review the documents that you want to publish and
edit information as necessary.
Tips
• When multiple documents are selected, only property values shared by
all the selected documents appear in the table. Changing a value in the
table changes that value for all of the selected documents.
11. Specify a method of publishing in the Operation box:
• Click Publish now to immediately start the publishing process as soon
as you click OK.
• Click Background publish to publish the selected documents
immediately as a separate process, allowing you to perform other tasks
at the same time. When you use this feature, an e-mail message alerts
you when the process is complete.
• Select the Scheduled publish option to indicate that the publish
process should be run in batch mode, if the authoring tool supports
scheduled batch publishing.
12. Click OK to complete the publishing procedure.
Note
• When the publish is complete, the following dialog box appears. If the
View Log button on the dialog box is enabled, messages are available
concerning the operation. These messages may include errors or warnings
or even informational messages. Click the View Log button to see these
messages.
Related Topics
• Retrieve Documents to SmartPlant Instrumentation, page 420

Schema Mapping
Find Documents to Publish from SmartPlant

Instrumentation
1. Click SmartPlant > Find Documents to Publish.
Tips
• This feature is also available by clicking Find File: . on the Publish
dialog box.
• The Find Documents to Publish command determines which
documents need to be published or re-published and displays the
results on the Find Documents to Publish dialog box.
2. From the Select documents to publish list on the Find Documents to Publish
dialog box, check the box beside the documents that you want to publish.
Tip
• You can quickly select the entire list by clicking Select All, or you can
clear the entire list by clicking Clear All.
3. Click OK to accept the selections. The documents you selected to publish now
appear in the Documents to Publish list on the Publish dialog box, and are ready
to be published.
Note
• The lists displayed on the Find Documents to Publish dialog box are
compiled at the time indicated in the Last search performed box. You
can update the lists by clicking Update, but this process can be time-

Schema Mapping
consuming, depending on whether you are running the applications in

synchronous or asynchronous mode.
Select Document Types (Document Selection Wizard)

The Document Selection Wizard allows you to find engineering documents in a
specific <unit> of the current domain and add them to the list of selected documents
to publish. Select the check box beside each document type that you want to include
for publishing.
Instrument Index data — A document published as a .pdf file (one .pdf file per
<unit>). Each instrument index document contains data about all the instruments
and loops existing in a SmartPlant Instrumentation database and defined for a specific
<unit>.
Instrument process data sheets — Documents containing detailed information

about process data values for a specific instrument you have associated with a
particular tag number. You can select a tag number and view the corresponding
process data sheet for a specific instrument as a read-only .pdf file.
Instrument specification sheets — Documents containing detailed information

about specification sheet data associated with a particular tag number. You can select
a tag number and view the corresponding specification sheet as a read-only .isf file.
Enhanced SmartLoop reports — Documents containing detailed information

about a loop drawing that you generated as an Enhanced SmartLoop report using the
Enhanced Report Utility. You can select a loop name and view the corresponding
Enhanced SmartLoop report as a read-only .sma file.
Instrument dimensional data sheets — Documents containing detailed

information about dimensional data values for a specific instrument that you have
associated with a particular tag number. You can select a tag number and view the
corresponding dimensional data sheet for a specific instrument as a read-only .pdf
file.
Note
• You can publish a new instrument index document each time you make a
revision for that document. The source data for the instrument index
document is located in the current Instrument Index Standard Browser
view.

Schema Mapping
Select Plant Group (Document Selection Wizard)

Allows you to select the SmartPlant Instrumentation plant group for which you want
to publish the selected documents.
Project — Displays 'As-Built' or the name of the SmartPlant Instrumentation project

that you selected.
Plant hierarchy — Select a SmartPlant Instrumentation plant group at the lowest

plant hierarchy level (for example, a unit).
Select Instrument Process Data Sheets (Document

Selection Wizard)
This page allows you to select instrument process data sheets for performing revisions
and publishing. You can batch generate process data sheets for instruments in the
Instrument Index Standard Browser by using the shortcut menu command Generate
Process Data Sheets. This is important when you use revisions from SmartPlant
Foundation and ensures that the appropriate instruments appear in the Search results
table when you click Find.
You can use wildcards in the fields where you type values: underscore (_) for single
characters and percent (%) for multiple characters.
The following table shows search parameters that you can use to narrow the results of
your search for process data sheets.

Parameter
Tag number Type the whole tag number you are looking 101-FT – 2225/1
characters. You can use wildcards if needed. Or use a wildcard:
101-FT%
find all the tag numbers that contain this
numeric segment. You can also use
Instrument Select an instrument type to narrow your D/P Type Flow
type search to tags belonging to this instrument Element (FE), Mass
type. Flow Transmitter (FT)
Pressure (DP)

Schema Mapping
Status Select a tag status to narrow your search to An existing device, a

tags associated with this status. new instrument, a
relocated device
Location Select a tag location, such as Field, to narrow Equipment room,
your search to tags for which you have junction box
Process Select a process function to narrow your Flow
function search to tags belonging to this process Pressure
function.
Click Find to display the process data sheets that exist in the specified <unit> and
according to the search parameters, if specified.
In the Search results table, you can view the process data documents to select for
publishing. Note that the Revision column displays the number of the latest revision
for each process data sheet.

Schema Mapping
Select Instrument Specification Sheets (Document

Selection Wizard)
This page allows you to select instrument specification sheets for performing
revisions and publishing. You can batch generate specification sheets for instruments
in the Instrument Index Standard Browser by using the shortcut menu command
Apply Profile > Generate Specification Sheets. This is important when you use
revisions from SmartPlant Foundation and ensures that the appropriate instruments
appear in the Search results table when you click Find.
characters and percent (%) for multiple characters. The following table shows search
parameters that you can use to narrow the results of your search for specification
sheets.
Parameter
Or use a wildcard:
characters. You can use wildcards if needed.
101-FT%
find all the tag numbers that contain this
Instrument Select an instrument type to narrow your D/P Type Flow Element
type search to tags belonging to this instrument (FE), Mass Flow
type. Transmitter (FT)
Pressure (DP)
Status Select a tag status to narrow your search to An existing device, a new
tags associated with this status. instrument, a relocated
device
Location Select a tag location, such as Field, to narrow Equipment room, junction
your search to tags for which you have box
Form number Select a form number to narrow your search
to documents that have this specification
form number.
Click Find to display the instrument specification sheets that exist in the specified
<unit> and according to the search parameters, if specified. In the Search results
table, you can view the specification documents to select for publishing. Note that
the Revision column displays the number of the latest revision for each spec sheet.

Schema Mapping
Select Enhanced SmartLoop Reports (Document Selection

Wizard)
A published loop drawing allows you to view Enhanced SmartLoop reports in .sma
format.
your search for Enhanced SmartLoop reports.

Parameter
Loop number Type the whole loop number you are looking for. 101F -
Include any prefix, suffix, and separator characters. Use 2225\A
101F-%
Number Type the numeric segment of the loop number to find all 2225
the loop numbers that contain this numeric segment.
Use wildcards if needed.
Measured From the list, select a measured variable to find all the Density
variable existing loop numbers that have this measured variable. (D)
Pressure
(DP)
Click Find to generate Enhanced SmartLoop reports for the loops that exist in the
specified <unit> and according to the search parameters, if specified.
In the Search results table, you can view the loops to select for publishing the
reports. Note that the Revision column displays the number of the latest revision for
each loop.

Schema Mapping
Select Wiring Reports (Document Selection Wizard)

This page allows you to select wiring reports in .pdf format for performing revisions
and publishing. You can batch generate wiring reports for panels in the Wiring
module by displaying working data and using the shortcut menu command
Regenerate Wiring Reports. This is important when you use revisions from
SmartPlant Foundation and ensures that the appropriate panels appear in the Search
results table when you click Find.
your search for wiring reports.

Parameter
Panel name Type the panel name you are looking for. 101 JB -100
Include any prefix, suffix, and separator
characters. Use wildcards if needed. JB-%
Type From the list, select a panel type to narrow Measuring Device,
your search. Monitor, Power
Supply
Manufacturer From the list, select a manufacturer to find all
the existing panels that have this
manufacturer.
Model From the list, select a model to narrow your
search to a specific model or group of models
for the selected manufacturer.
Report style From the list, select the desired report style:
With Adjacent Connections or Without
Adjacent Connections (Style 2).
Click Find to generate wiring reports for the panels that exist in the specified <unit>
and according to the search parameters, if specified.
In the Search results table, you can view the panels to select for publishing the
reports. Note that the Revision column displays the number of the latest revision for
each panel.

Schema Mapping
Select Dimensional Data Sheets (Document Selection

Wizard)
This page allows you to select dimensional data sheets in .pdf format for performing
revisions and publishing. You can batch generate dimensional data sheets for
instruments in the DDP module by displaying working data and using the shortcut
menu command Regenerate Dimensional Data Sheets. This is important when you
use revisions from SmartPlant Foundation and ensures that the appropriate
instruments appear in the Search results table when you click Find.
your search for dimensional data sheets.

Parameter
for. Include any prefix, suffix, and
separator characters. You can use Or use a wildcard:
wildcards if needed. 101-FT%
Number Type the numeric segment of a tag number 2225
to find all the tag numbers that contain this
Instrument type Select an instrument type to narrow your D/P Type Flow
search to tags belonging to this instrument Element (FE), Mass
type. Flow Transmitter (FT)
Pressure (DP)
Dimensional Select a tag status to narrow your search to An existing device, a
data status tags associated with this status. new instrument, a
relocated device
Manufacturer Select a to manufacturer to narrow your Fisher, Honeywell
search to tags for which you have defined
this manufacturer.
Dimensional Select a dimensional group to narrow your IA1, IA2, ICM1, All
group search to tags belonging to this dimensional Groups
group.

Schema Mapping
Note
• The software supports publishing of dimensional data sheets for certain
dimensional groups only. For the full list of supported dimensional
groups, see List of Publishable Dimensional Groups.
Click Find to display the dimensional data sheets that exist in the specified <unit>
and according to the search parameters, if specified.
In the Search results table, you can view the dimensional data documents to select
for publishing. Note that the Revision column displays the number of the latest
revision for each dimensional data sheet.
Document Selection Summary (Document Selection

Wizard)
This page allows you to review the number of documents of each type that you have
selected. Click Back to review or modify your selections. Click Finish to accept
your selections and return to the Publish dialog box.

Schema Mapping
List of Publishable Dimensional Groups

The SmartPlant Instrumentation dimensional groups in the list are those that also
appear in the SmartPlant schema, in INtoolsMap.xml, and in SmartPlant 3D. Only
dimensional data sheets for instruments that use these groups will publish
successfully. Other dimensional groups in SmartPlant Instrumentation are currently
not supported for publishing.
Group Description
IA1 Annubar Type 1
IA2 Annubar Type 2
ICM1 Coriolis Flowmeter Type 1
ICM2 Coriolis Flowmeter Type 2 Liquid
ICM3 Coriolis Flowmeter Type 2 Gas
ICM4 Coriolis Flowmeter Type 3 Liquid
ICM5 Coriolis Flowmeter Type 3 Gas
IDCO Orifice_Double Chamber Fitting
IDL1C Valve_Rotary Diaph. Act. Pos C1
IDL1D Valve_Rotary Diaph. Act. Pos D1
IDL4C Valve_Rotary Diaph.Act.Pos
C4(Vert.Line)
IDL4D Valve_Rotary Diaph.Act.Pos
D4(Vert.Line)
IDR1A Valve_Rotary Diaph. Act. Pos A1
IDR1B Valve_Rotary Diaph. Act. Pos B1
IDR4A Valve_Rotary Diaph.Act.Pos
A4(Vert.Line)
IDR4B Valve_Rotary Diaph.Act.Pos
B4(Vert.Line)
IEAM1 Valve_Electric Actuator Type 1
IIOL Orifice_Integral Type 2
IIOR Orifice_Integral Type 1
IIV Insert Venturi

Schema Mapping
IKG1 Knife Gate Valve Typ 1_Piston Actuator

IKG2 Knife Gate Valve Typ 2_Piston Actuator
ILSV Long or Short Venturi
IMFM1 Magnetic Flowmeter Type 1
IMOP1 Meterrun_Orifice Flanges & Plate
IMRSV Meterrun_Short Venturi
IOP Orifice Plate
IPDA1 Valve_Double Acting Dual Cyl Act. TYP
1
IPDA2 Valve_Double Acting Sngl Cyl Act. TYP
2
IPDA3 Valve_Double Acting Piston Act. TYP 3
FC
IPDA3A Valve_Double Acting/Sprg Rtrn Act. 90
RS
IPDA4 Valve_Double Acting Sngl. Piston Act.
FO
IPDA4A Valve_Double Acting/Sprg Rtrn Act. 90
LS
IPDA5 Valve_Double Acting Dual Cyl Act TYP
5
IPL1C Valve_Rotary Piston Act. POS C1
IPL1D Valve_Rotary Piston Act. POS D1
IPL4C Valve_Rotary Piston Act.POS
C4(Vert.Line)
IPL4D Valve_Rotary Piston Act.Pos
D4(Vert.Line)
IPR1A Valve_Rotary Piston Act. POS A1
IPR1B Valve_Rotary Piston Act. POS B1
IPR4A Valve_Rotary Piston Act.POS
A4(Vert.Line)
IPR4B Valve_Rotary Piston Act.POS
B4(Vert.Line)
IPSR1 Valve_Spring Return Piston Act. Typ1 FC

Schema Mapping
IPSR2 Valve_Spring Return Piston Act. Typ2

FO
IPSR3 Valve_Spring Return Piston Act. Typ3 FC
IPSR4 Valve_Spring Return Piston Act. Typ4
FO
IR1 Rotameter Type 1
IREG1 Regulator Type 1
IRVT3 Relief Valve Type 3 (Pilot)
IRVT4 Relief Valve Type 4 (Pilot)
IRVT7 Relief Valve Type 7 (Specials)
IRXPA Valve_Rack & Pinion Actuator
ISSDA Valve Angle_Linear Diaphragm Actuator
ISSDS Valve Linear Diaphragm Actuator
ISSPS 3 Way Valve_Linear Piston Actuator
ITM Turbine Meter
IVM1 Vortex Flowmeter Type 1
IVM4 Vortex Flowmeter Type 4_Dual Head
IWFE Wedge Flow Element
Related Topics

Revising Documents in an Integrated Environment
Revising Documents in an Integrated

Environment
The Revise Documents command, available on the SmartPlant menu, allows you to
revise a document and save it to the database of the authoring tool without publishing
it. When you register a plant, the software implements integrated revisions. During
report publishing, the software first checks whether the report has an integrated
revision and then assigns the appropriate revision scheme automatically.
Reserving Revision Number

The Revise functionality also provides an option that allows you to designate
revisions numbers to the plant or to particular projects. For each document, you can
reserve revision numbers at the plant or project level. Using this feature, you can use
the same document in different projects, while still allowing the revision numbers to
be sequential within each project.
For each project (or even at the plant level) you can reserve a certain number of
revisions that are held for that particular project. If the document is used within a
different project and revised, it is given either a later revision number or its own set of
numbers.
For more information about reserving revision numbers, refer to the Revise Dialog
Box, page Error! Bookmark not defined..
Related Topics
• Revise a Document, page 415
• Revise Dialog Box, page Error! Bookmark not defined.
• Revise Documents Command, page Error! Bookmark not defined.

Revise a Document
1. Do one of the following to open the Revise dialog box:
From any module that supports publishing and retrieving of documents, on
the Revisions dialog box, click New
• From within SmartPlant Instrumentation, click SmartPlant > Revise
Documents
Tips
• This option is available only if you have registered the active
SmartPlant Instrumentation plant.
• If you are logged on to SmartPlant Instrumentation with a user name
that is not defined in SmartPlant Foundation for the specific plant, you
are prompted to log on to SmartPlant Foundation when you use this
command.
• The documents that appear in the Selected documents list on the
Revise dialog box when it first appears are documents that were
selected within the authoring tool before you clicked the Revise
Documents command.

2. For a new document, or a document that does not yet have a defined revision
scheme, select the revision scheme you want to use from the Revision Scheme
list.
Tip
• If you selected a document that already has a defined revision scheme,
it is displayed in the Revision Scheme field and cannot be changed.
3. In the Revise in Tool section, choose the next available major and minor revision
numbers.
Tip
• Any revision numbers that have been reserved by another project are
not available and are skipped in the revision scheme, if applicable. In
other words, if the current version of the document is B and there are
three outstanding revision reservations for that document in other
projects, the next available revision number will be F.
4. Click OK.
Notes
• When you click OK to revise the document, it is saved to the authoring
tool database. The document stored in SmartPlant Foundation is not
updated until your publish it from SmartPlant Instrumentation.
• Using the Revise dialog box, you can reserve revision numbers, revise
documents, or do both at the same time.
Related Topics
• Revise Dialog Box, page Error! Bookmark not defined.
• Revise Documents Command, page Error! Bookmark not defined.
• Revising Documents in an Integrated Environment: An Overview, page
414

Retrieving in an Integrated Environment

When you retrieve documents into an authoring tool, you are retrieving the document
data that was published by another authoring tool. For example, in SmartPlant
Instrumentation, you can retrieve engineering information from a published P&ID
into the SmartPlant Instrumentation database.
The authoring tools provide commands that let you select a document and retrieve it
into that tool. You can use either the SmartPlant > Retrieve command to open a
wizard that assists you in retrieving applicable documents, or with some authoring
tools, you can configure an automatic retrieval feature.
Note
• The software trims all leading and trailing spaces from all strings and from
all values without units of measure. These spaces do not appear in the
retrieved data file.
Additionally, you can access the Web Client through the SmartPlant > Browser
command. This allows you to select the document or documents that you want to
retrieve from your Web Client To Do List, the tree view, or by using the Web Client
search functionality. After you select the documents that you want to retrieve, you
can use the Retrieve command on the Web Client SmartPlant menu to start the
retrieval process.
The Retrieve command provided in the authoring tools is slightly different from the
Retrieve command available in the SmartPlant Foundation Web Client. The Web
Client presents a list of documents from which you can select those you want to
retrieve. However, when you use the command from an authoring tool without first
selecting documents, the software searches the SmartPlant Foundation project for
documents to retrieve, and these are presented in a list on the Retrieve dialog box.
You can retrieve a document in two ways:
• As published— Retrieves only the data the authoring tool originally

published with the selected revision and version of the document.
Retrieving as-published data retrieves the .xml file the authoring tool
published from the appropriate SmartPlant Foundation vault.
• With the latest data— Retrieves the latest data associated with the
selected document in the SmartPlant Foundation database. If another,
more-recently published document contains updates to objects in the
selected document, the software retrieves the most current data in the
SmartPlant Foundation database for those shared objects. When you
retrieve the latest data, SmartPlant Foundation generates an .xml file
containing the published data.

Document Types for Retrieval

The types of documents that you can retrieve depend on the authoring tool that you
are using. For details of documents that each authoring tool can publish and retrieve,
see Tool Documents That are Published and Retrieved.
From the authoring tools, you can retrieve the plant breakdown structure (PBS) and
project documents. The PBS and project documents, created in SmartPlant
Foundation, are retrieved by authoring tools to provide information about the plants,
areas, units, projects, and contracts that need to be created in the authoring tool so that
the information is consistent across all authoring tools.
The PBS document published by SmartPlant Foundation contains information about

the physical plant with a structure consisting of plants, areas, and units. The default
structure is plant/area/unit, but you can define a custom hierarchy in the Schema
Editor. The project breakdown structure, project list, and project definition document
contain information about the project or projects and their statuses in a plant/project
structure.
Notes
• Retrieving the project breakdown documents and the PBS into SmartPlant
Engineering Manager creates the appropriate structures automatically.
• When using SmartPlant Instrumentation, you must create the plant
hierarchy according to the PBS information in SmartPlant Foundation
before you retrieve either the PBS or the project definition document.
You must create a plant hierarchy with at least three levels with a
minimum of one PBS item at the lowest level before you can retrieve the
PBS and project definition document.
Data Handling After Retrieval
The authoring tool that you use also determines how the system deals with changes in
downstream data when you retrieve a document. SmartPlant P&ID, SmartPlant
Instrumentation, SmartPlant Electrical, and Zyqad analyze the impact of the newly
retrieved data on the existing database, then place tasks on the authoring tool's To Do
List that allow you to create, delete, or modify items at the appropriate time in the
design process. The To Do List gives you the opportunity to view and understand
potential changes before accepting, deleting, or modifying those changes.
Design Basis
Objects that tools retrieve from other authoring tool documents can become the
design basis for objects in downstream documents. Objects that become the design
basis for other objects can be specific objects that get richer as they move through the
lifecycle or they can be schematic or logical objects in one application that evolve
into more detailed objects downstream.
Design basis is implicit based on retrieval; you do not have to define it. For example,
a pump retrieved from a PFD becomes the design basis for a pump in the P&ID.

When you change common properties for the pump and retrieve the changes into
SmartPlant P&ID, tasks to update the pump automatically appear in the To Do List.
The same process works for logical items that are a design basis for other items, such
as a P&ID tag in SmartPlant P&ID can evolve into a control loop with associated tag
numbers in SmartPlant Instrumentation.
Related Topics
• Open the To Do List, page 426

Retrieve Documents to SmartPlant Instrumentation

1. Display one of the following:
• The main SmartPlant Instrumentation window with no modules
open.
• The Instrument Index Standard Browser view.
2. Click SmartPlant > Retrieve. The Retrieve dialog box appears.
Tips
• If you logged onto SmartPlant Instrumentation with a user name that is
not defined in the integrated environment, you are prompted to log on
when you use this command.
• The Retrieve command searches the integrated environment for
documents that are ready to be retrieved into SmartPlant
Instrumentation. These documents appear in the Documents to
retrieve list on the Retrieve dialog box.
3. In the Document type box, specify the type of document to be retrieved.
4. In the Show section, select Documents to be retrieved only to include

documents that have been retrieved previously and have been published again
since the last retrieval. Select All documents to include all revisions and types of
documents. Select New documents only to retrieve documents that have not been
retrieved yet.

5. In the Documents to retrieve list, select the check box beside each document you
want to retrieve. To help identify the documents, review the details in the Type,
Revision, Version, and Last Retrieved columns.
Tip
• To quickly select the entire list, click Select All. To quickly cancel the
selections, click Clear All.
6. For each document you checked, use the Retrieve Option column to specify
whether you want to retrieve the document with the latest data or retrieve it as
published.
7. Click OK to retrieve the specified documents.
Notes
• Check the Batch retrieve option if you want the retrieve process to run in
batch mode. If you select this option, an e-mail message will alert you
when the process is complete. Otherwise, the retrieval process begins
when you click OK.
• The Deleted and Unclaimed Objects document is retrieved automatically
every time you retrieve, if there is a newer version of this document since
the last retrieval. The document is not included in the list, but it is
retrieved automatically, when necessary, to ensure that the applicable
information is updated.

• When the retrieval process is complete, the following dialog box appears.
If the View Log button on the dialog box is enabled, messages are
available concerning the operation. These messages may include errors or
warnings or even informational messages. Click View Log to see these
messages.
Related Topics
• Find Documents to Publish from SmartPlant Instrumentation, page 402
• Publish Documents from SmartPlant Instrumentation, page 399

Using the To Do List

The To Do List allows you to keep track of tasks required to keep your plant updated
with information in an integrated environment. Specifically, this feature aids in
retrieving data by providing a list of all the things that must be added, deleted, or
modified to bring the plant data into agreement with the latest retrieved information.
All the users of a plant database share a single To Do List. You can view the entire
To Do List and see the tasks that have been completed and those that are pending.
Some types of tasks have associated code and when you run those tasks, the software
modifies the database.
From the To Do List, you can perform tasks, defer them, or delete them altogether.
Additionally, you can view properties for each task in the To Do List. The
information that is available is specific to the type of task that is selected: Create
tasks and Update tasks, for instance, but certain information is provided for all types.
The available task types are:
• Create— Creates a new item in the plant

• Update— Updates the selected properties of the specified item
• Delete— Deletes the specified item from the plant
• Manual— Creates and displays a reminder. You can decide when a
manual task is complete and set the status accordingly.
Each task in the To Do List has a status. Initially, the status is Open. If you
successfully run the task, the status changes to Completed . If you attempt to run
a task, but the process is not completed successfully, the status is changed to Error
. Error status occurs, for example, if you attempt to run an Update task assigned
to a drawing that is not currently open. You can also postpone running a task and
change its status to Deferred .
Notes
• When an Update task is created in the To Do List, the units of measure
used in properties are automatically converted to the defaults for the plant.
The software converts units of measure used for properties in Create tasks
to the plant defaults when the task is run.
• By clicking the heading of columns on the To Do List, you sort the list by
the values in that column. You can change the order in which these
columns appear by selecting a column heading and dragging it to the left
or right to the desired position.
Related Topics
• Defer a Task from the To Do List, page 430

• Remove a Task from the To Do List, page 430

To Do List Common Tasks

The following tasks are used frequently when you work with the To Do List.
Run a Task from the To Do List

You run tasks to create, update, or delete data in the SmartPlant Instrumentation
database with data from a retrieved document. For more information, see Run a Task
from the To Do List, page 427.
Sort Tasks in the To Do List

This procedure enables you to sort the To Do List tasks by task properties such as
Status, Task Type, Item Type, and Item Name. For more information, see Sort
Tasks in the To Do List, page 429.
Filter Tasks in the To Do List

This procedure enables you to filter the To Do List tasks by task properties or for
tasks with specific values. For example, you may want to filter only those tags with
task type Create. For more information, see Filter Tasks in the To Do List, page 429.
Remove a Task from the To Do List

This procedure enables you to delete tasks that are no longer needed from the To Do
List. Permanent deletion of tasks is a two-stage operation. First, you need to move
the task from the To Do List to a buffer that displays tasks intended for deletion. If
necessary, you can restore tasks in the buffer to the To Do List. Next, you delete the
task from the buffer. When you delete the task from the buffer, the software removes
it from the database and it cannot be restored. For more information, see Remove a
Task from the To Do List, page 430.
Update the To Do List Display

Updating the To Do List display is useful when several users can access the To Do
List, and you want to refresh the display with the latest information from the
SmartPlant Instrumentation database after another user has modified the item
specified by the task. For more information, see Update the To Do List Display, page
431.
Related Topics

Set Preferences for the To Do List

1. Log on to the SmartPlant Instrumentation application.
3. In the Preferences dialog box tree-view pane, click SmartPlant > To Do List.
4. Under Task execution, click the desired option to determine how the software
executes tasks in the To Do List when you implement the Run command:
• Execute— Executes tasks immediately.
• Submit— Submits tasks for batch execution at a later stage.
5. Select other options as desired.
Related Topics
• To Do List Common Tasks, page 425
Open the To Do List

Click SmartPlant > To Do List on the main menu bar.
Related Topics

Modify To Do List Task Properties

1. Click SmartPlant > To Do List.
2. On the To Do List window, select the task or tasks that you want to edit.
3. On the To Do List toolbar, click Properties .
Tip
• You can also open the Task Properties dialog box by double-clicking
a task in the To Do List.
4. On the Task Properties dialog box, click the Details tab.
5. Select the check box beside each property for which you want the software to
create or update the value when you run the task.
Note
• The properties available for each task depend on the type of task. For all
types, you can edit the name and notes for the task. For Create tasks, you
can edit the item being created and turn off or on the values assigned to
different properties for that item. For Update tasks, you can turn off or on
the new values assigned to properties for the item.
Related Topics
Run a Task from the To Do List

2. On the To Do List window, select the task or tasks that you want to run.
Tips
• You can configure the Run Task command to execute tasks
immediately or to submit selected tasks for batch execution at a later
stage. For details, see Set Preferences for the To Do List, page 426.
• Before running tasks, you can select a filter to run only tasks that meet
certain criteria, for example Update tasks only. For details, see Filter
Tasks in the To Do List, page 429.
• You can select specific data columns for which to transfer data values
from the Details tab on the Task Properties dialog box.
• You can select all the tasks on the To Do List by pressing Ctrl + A.
3. On the To Do List toolbar, click Run Task .

Notes
• When creating process data for which minimum, normal, and maximum
values of a property apply, the software converts the minimum and
maximum values to the normal units of measure, if different. If there is
no normal value, the software converts to the maximum units of measure,
and if there are no normal and maximum values, only the minimum value
is used. For updates, the software converts all values to the existing units
of measure in SmartPlant Instrumentation.
• When retrieving loops without equipment and tag numbers with
equipment and then running a task that creates a relation between the
loops and the tag numbers, you must ensure that the loop equipment is not
set to propagate to the tag numbers by default, otherwise, the empty loop
equipment value will overwrite the existing equipment values for the tag
numbers. To do so, before running the task, open the intools.ini file, and
under the [Index] section, type the following line:
• LoopNoPropagateCheck=1
Related Topics
Task Dependencies
When you run tasks, there are some task types that require other tasks to run first.
For example, if two tasks exist for an item, one to move it to another <unit>, and the
other to update some of the item properties, the software cannot run the update task
until the move task is complete. The software analyzes the To Do List for these
dependencies to ensure that the tasks run in the appropriate sequence. The following
table indicates the dependencies that can exist between different task types.
Master Task Dependent Task

Claim Move
Claim Update
Move Update
Task dependencies influence the way in which the result of running a master task
affects the status of the dependent tasks. On running a task, the software checks the
To Do List for prerequisites, and changes the status of those tasks that are New to
Submitted. If the status of a prerequisite task is Deferred, Deleted, or Failed, then
the software marks all dependent tasks as Failed.
Related Topics
• Run a Task from the To Do List, page 427

Complete a Task from the To Do List

2. On the To Do List window, select the task or tasks that you want to complete.
Tip
• You can select all the tasks on the To Do List by pressing Ctrl + A.
3. On the To Do List toolbar, click Complete Task .
Related Topics
Sort Tasks in the To Do List

2. On the To Do List toolbar, click Sort .
3. On the Sort dialog box, select a property under the Available columns list.
• Click Add.
• Drag the selected property to the Sort by pane.
5. Repeat for other properties that you want to sort by.
Tip
• After selecting the columns, you can change the sort order for the
properties by selecting a column in the Sort by pane and clicking
Move Up or Move Down as needed.
6. If you want to specify sorting for a particular column by descending order of the
values, select the Descending check box beside that column. Clear the check box
to sort by that column in ascending order.
Related Topics
Filter Tasks in the To Do List

2. On the To Do List toolbar, click Filter .
3. On the Filter dialog box, click Add to specify a new filter condition.

4. Specify the filter condition by selecting the desired parameters from the
Property, Operator, and Value columns; for example, you can specify the
condition:
Task Type = Create
5. If desired, specify additional filter conditions.

6. For two or more conditions, specify the logic (AND or OR) between each pair of
successive conditions.
Related Topics
Defer a Task from the To Do List

2. On the To Do List window, select the task or tasks that you want to defer.
3. On the To Do List toolbar, click Defer Task .
Related Topics
Remove a Task from the To Do List

2. On the To Do List window, select the task or tasks that you want to remove.
3. On the To Do List toolbar, click Delete Task .
Note
• You can display deleted tasks on the To Do List. For more information,
see Display Deleted Tasks in the To Do List, page 431.
Related Topics

Display Deleted Tasks in the To Do List

2. On the To Do List toolbar, click View Deleted .
Tip
• To return to the current task list, click View Deleted again.
3. To delete tasks permanently, select the task or tasks that you want to delete, and
on the To Do List toolbar, click Delete .
Related Topics
Run a To Do List Report

1. Click SmartPlant > To Do List on the main menu bar.
2. On the To Do List toolbar, click Report .
Related Topics
Update the To Do List Display

On the To Do List toolbar, click Refresh .
Related Topics

Merger Utility
Merger Utility
Overview
The Merger Utility provides you with the means of transferring a selected plant
hierarchy item (for example, domain, plant, and so forth) from a source domain to the
same type of plant hierarchy item in an existing target domain. The source and target
domains can be a part of the same database or part of different databases. You can
also merge source and target plant hierarchy items within the same domain.
You run the Merger Utility in any of the following scenarios:
• You need to transfer all the data from a source domain to a target
domain.
• You need to transfer all the data from a source plant hierarchy item to a
target plant hierarchy item at the same level.
Notes
• Only the Domain Administrator has access to the Merger Utility.
• The source and target domains must be of the same SmartPlant
Instrumentation version. If they are not the same version, the Merger
Utility displays an appropriate message. In this case, you need to upgrade
the domain that belongs to the earlier version.
• The Merger Utility only supports domains of type Engineering company
when merging plant data. For configuration data, the Merger Utility
supports Engineering company and Operating owner (As-Built) domains.
• The Merger Utility changes the contents of your target database.
Therefore, we recommend that you backup your target database before
proceeding with the merge process. (For details of how to backup your
database, see Installation Guide, Backup and Restore.)

Merger Utility
Database Platform Support

The Merger Utility provides you with inherent support of the following database
platforms:
• Oracle
• Microsoft SQL Server
• Sybase Adaptive Server Anywhere
You can use any of the above database platforms after you configured that database
platform to work with SmartPlant Instrumentation.
You can also import data from database platforms other than those specified above.
To do this, you need to install the appropriate drivers manually and configure the
appropriate configuration files.
Note
• SmartPlant Instrumentation uses a database engine developed by Sybase
for SmartPlant Instrumentation repository. This engine is called Sybase
Adaptive Server Anywhere.

Merger Utility
Starting the Merger Utility

To start the Merger Utility you must comply with the following requirements:
• You must have a previously defined source and target domains with at
least one plant hierarchy item at the lowest level of the hierarchy (by
default, this is a unit).
• Both the source and target domains must be of the same SmartPlant
Instrumentation version and sub-version.
See Installation Guide, SmartPlant Instrumentation Setup Maintenance and Database
Selection, Installing SmartPlant Instrumentation Components to learn more about
SmartPlant Instrumentation programs and utilities.
Start the Merger Utility

1. Select Merger Utility from the Intergraph SmartPlant Instrumentation
program group in the Windows Start menu.
2. On the Logon Information dialog box, type the Domain Administrator name and
password.
3. On the Open dialog box, expand the hierarchy as needed by clicking and select
the desired <unit> .
Tips
• Whenever you start the Merger Utility, the software prompts you to
select a target <unit>. If you have already started a merge process in a
previous Merger Utility session, you are prompted to resume that
merge process.
• You need to select a single target <unit> before starting the merge
process, the same way you do when you enter every SmartPlant
Instrumentation module. You can select additional target plant
hierarchy items as you proceed through the merge process. (For
details of how to select additional target data, see Merging Data -
Overview, page 442 .)

Merger Utility
Working with Log Files

Log files allow you to keep track of all operations during a merge process.
When you start the Merger Utility for the first time, you create a new log file. The
log file keeps growing as you continue merging data unless you decide to change the
current log file. The information in the log file describes chronologically the events
which have taken place during the merge process. This information includes:
• and time in which the merge process started.

• Details of the selected source and target:
• The database platform (for example, Oracle)
• The domain name
• The plant hierarchy item name on the level at which data has been
transferred
• The starting ID of each table (for details of how to set the starting ID, see
Setting the Merger Comparison Criteria, page 441 ).
• The total number of updated target rows (where the software overwrites
data).
• The total number of inserted rows (new rows that were appended in the
target domain).
• The total number of rejected source rows: source rows which were not
transferred).
• The transferring results: whether the merge process was successful if the
user stopped it or if it stopped due to merge failure.
If you start the merge process with no log file defined, the software prompts you to
define a log file when you are about to start the data transfer.
Note
• SmartPlant Instrumentation uses Notepad to view the log file; however,
Notepad is limited by file size that it can handle. If your log file becomes
too large for Notepad, an appropriate message appears. In this case, you
can view your log file using Windows Write or another appropriate utility.
Related Topics
• Closing the Current Log File, page 155
• Creating a New Log File, page 151
• Deleting an Existing Log File, page 156
• Opening an Existing Log File, page 152
• Viewing a Log File, page 153

Merger Utility
Creating a New Log File

It is advisable to create a new log file each time you perform an important import
operation. You should also create a new log file if your existing log file has become
too long.
Create a New Log File

1. Click Log > New.
2. On the New Log File dialog box, type the name of your new log file, select the
desired path, and click Save.
Tip
• The Merger Utility opens a new (empty) log file automatically (even
though you do not see it).

Merger Utility
Opening an Existing Log File

It is advisable to open a log file before you perform an import procedure so that you
have a record of the import process.
Open an Existing Log File

1. Click Log > Open.
2. On the Open Log File dialog box, select the name of the log file you want to
open and click Open.
Tip
• After you create a new log file or open an existing one, it stays open even
though you do not see it displayed. The log file remains active until you
close the Merger Utility. (For details of how to close the current log file
manually, see Creating a New Log File, page 151.) When you exit the
Merger Utility, the log file closes automatically and reopens when you
restart the Merger Utility.

Merger Utility
Viewing a Log File

You can view the current log file to review the previous import process information.
You can also view any other existing log file.
View the Current Log File

• Click .
• Click Log > View.
The current log file opens for viewing in Notepad.
Tip
• SmartPlant Instrumentation uses Notepad to view the log file. However,
Notepad is limited by file size that it can handle. If your log file becomes
too large for Notepad, you will get an appropriate message. In this case
you can view your log file using Windows Write or another appropriate
utility.

Merger Utility
Closing the Current Log File

You can also import data without a log file. If you choose to do this and there is a
current log file, you can close it.
Close the Current Log File

• Click Log > Close.
The Merger Utility immediately closes the current log file. After you close the
current log file you need to define a new log file to resume tracking the import
process. (For details of how to define a new log file, see Creating a New Log File,
page 151.)

Merger Utility
Deleting an Existing Log File

You can delete a log file when the information in it becomes unimportant.
Caution
• This action deletes the selected log file from your hard disk and cannot be
reversed.
Delete an Existing Log File

1. Click Log > Delete.
2. On the Open Log File Name dialog box, select the name of the log file you want
to delete and click Open.
Tip
• On clicking Open, the software deletes the specified log file from your
hard disk.

Merger Utility
Setting the Merger Comparison Criteria

You can control the way the Merger Utility identifies the source data as identical to
the target data during the merge process. This is important, because when the Merger
Utility encounters identical source and target rows, it can overwrite the target row or
leave it intact, depending on the comparison criteria settings. You can therefore
control the merge results by selecting the appropriate comparison criteria.
In SmartPlant Instrumentation, the database is organized in tables, for example:

CABLE, COMPONENT, CONTROL_VALVE, and so forth. These tables contain
data arranged in columns that represent various item types such as tags, cables,
panels, and so forth.
For example: The COMPONENT table contains all the tags together with the
appropriate links to other tables, which utilize tags, such as: COMPONENT_MFR
(Manufacturers table), CABLES (Cables table), and so forth.
You can use one or more data columns in each table as the primary key fields of this
table. The value of the primary key of each table is unique in this table. For
example, the primary key of the COMPONENTS Table is CMPNT_ID. This means
that each row in the COMPONENT Table has a different value in the CMPNT_ID
field.
Note that the primary keys are not accessible to you when you work in SmartPlant
Instrumentation. The primary keys are designed only for SmartPlant Instrumentation
internal use. When comparing rows, the Merger Utility treats the source and target
rows as identical only if both the source primary key and target primary key
contain the same value. For example, if the COMPONENT table in both source and
target rows contains the same values in the columns defined as primary keys, then the
software considers both rows as being identical.
In this case, the Merger Utility can either replace the entire target row with the source
row or leave this target row intact, depending on the merge process settings.
You can select the appropriate primary key of every table in the database. This way
you can create a different comparison criterion for each table.
Caution
• Changing the settings in the Target Definition dialog box alters the
relations between the tables. We therefore recommend that you do not
change these settings unless you find it necessary and only if you are
familiar with the SmartPlant Instrumentation database structure. In most
cases when you merge data, you do not have to modify the Merger Utility
comparison criteria. If you decide to modify the comparison criteria,
make sure you enter the appropriate data, as this feature changes the
contents of the target.

Merger Utility
Merging Data
Before you can merge data, you must create a merge session, within which you select
the source data, match the source and target data, and set the merging options.
After selecting the source data, you match the source and the target <units>. You
need to do this because the source and target domains may differ in the domain
hierarchy. For example, there may be more <units> in the selected source area than
in the target area.
The next stage is to select the data to be merged. There are two ways you can select
the data to be merged:
• Transfer all the data of selected modules or sub-modules using the module
list feature. When you select this option, the software transfers the entire
data for the selected item types.
• Transfer only the data that you select using the comparison list feature.
With this option, you can generate comparison reports which help you to
identify exactly which data needs to be merged. We recommend that you
save the comparison reports as .psr files. The advantage of having the
comparison reports in the .psr format is that you can re-use them in other
Merger Utility sessions if needed. There are, however, some limitations:
• PSR files reflect the situation at the time they were created. If the data
has changed during the time between the report creation and its
restoration, you cannot be certain that the data contained in the report
is up- to-date.
• Restore only supporting tables and reports for main item types (loops,
tags, cables, panels, and so forth). Do not select composite tables such
as tag and block relations.
Note
• If you want to delete data that is present in the target but not in the source,
you can do so only through the comparison list option.
You can manipulate, view, and print a .psr file from both InfoMaker and SmartPlant
Instrumentation. SmartPlant Instrumentation provides the best interface to deal with
the .psr files, as there are built-in features to filter, sort and column selection. If you
edit a .psr file outside SmartPlant Instrumentation, the hidden columns become
visible. This is a technical limitation that you should be aware of.
If you intend to merge data based on saved PSR files, do not save any changes made
through InfoMaker (you can make changes temporarily in order to adjust the layout
of the printed document, but do not save it).

Merger Utility
Generate and save the comparison reports as PSR files. If there is a lot of data in the
source and target databases, consider doing this on a per <unit> basis for the basic
engineering. In this case, save the comparison reports in different folders.
If you use InfoMaker, set it so it does not retrieve the data from the database when the
document is opened. To set it, follow this procedure:
• Open the .psr file in InfoMaker in design mode.

• Click Design > Options.
• Clear the Retrieve on Preview option.
• Make sure that the Retain Data to Design option is selected.
In order not to run out of resources during the different comparisons, run this process
in different sessions as recommended.
To improve performance, make sure that the Build table list for merging data check
box in the Compare Source-Target Data window is cleared (there is no need to
build a table list for merging if you do not intend to use it at that time).
The next stage is to set the Merger Utility settings which include the general options,
setting the date from which to start merging the data, and selecting the tag custom
field data to be merged.
When you start to merge data, you can monitor the transfer process in the Merger
Progress window.
The merge process includes the following major steps:
• Selecting the source data; that is, the plant hierarchy item.
• Matching the source data with the target data.
• Selecting the source data to be transferred to the target domain.
• Setting the general Merger Utility options.
• Setting other Merger Utility options: date, user-defined fields, and log file.
• Transferring the selected source data to the target data.
Related Topics
• Creating a New Merger Session, page 445
• Duplicating a Merger Session, page 448
• Opening a Merger Session, page 446

Merger Utility
Selecting the Target

When merging data, the Merger Utility treats the database identified in the current
intools.ini file as the target database and refers to your current plant hierarchy item as
the target. This means that the source data will be merged data in that <unit>.
SmartPlant Instrumentation connects to the current (target) database when you start
the Merger Utility. After the Merger Utility starts, the Open dialog box appears,
where you can select the desired target <unit>.
Select the Target Item

1. Click File > Select Plant Hierarchy Item for Target.
2. On the Open dialog box, expand the hierarchy as needed by clicking and select
the desired <unit> .

Merger Utility
Creating a New Merger Session
Create a New Merger Session

1. Click Actions > New Session.
2. In the text box, type a unique name for the session.
3. Click Actions > Open Session.
4. Make your definitions for the session as you require.
5. When done, on the Actions menu, click Save Session.
Related Topics
• Duplicating a Merger Session, page 448

Merger Utility
Opening a Merger Session
Open a Merger Session

1. In the Merger Session Manager window, select the session that you want to
open.
• Click Actions > Open Session.
Right-click the session, and on the shortcut menu, click Open Session.
•
3. Make any changes to the session as you require.

4. When done, on the Actions menu, click Save Session.

Merger Utility
Renaming a Merger Session
Rename a Merger Session

rename.
• Click Actions > Rename Session.
• Right-click the session, and on the shortcut menu, click Rename
Session.
3. In the text box, type a new name for the session.

Merger Utility
Duplicating a Merger Session
Duplicate a Merger Session

duplicate.
• Click Actions > Duplicate Session.
Right-click the session, and on the shortcut menu, click Duplicate
•
Session.
3. On the Duplicate Session dialog box, do one of the following:
• Click New and type a new session name.
• Select an existing session to overwrite it with the new session data.

Merger Utility
Deleting a Merger Session
Delete a Merger Session

delete.
• Click Actions > Delete Session.
• Right-click the session, and on the shortcut menu, click Delete
Session.
3. At the prompt, confirm the deletion.

Merger Utility
Selecting the Source Domain

After you have opened a session or defined a new session, the next step is to select a
domain or any plant hierarchy item within the domain.
The source domain can be:
• The same as the target domain (for details, see Selecting the Same Source
Domain as the Target Domain, page 451).
• Different from the target domain but belonging to the same database (for
details, see Selecting Source Domain from ODBC Database).
• A domain from a database or a database platform other than the target
domain database (for details, see Selecting a Source Domain from a
Database Platform Other than ODBC, page 454).
Note
• You can select multiple <units> to be merged with the target.
During this stage you can also:
• Select the appropriate source modules.

• Select the appropriate source tables.

Merger Utility
Selecting the Same Source Domain as the Target

Domain
You can select identical source and target domains if required.
Select the Same Source Domain As the Target Domain

1. Open a Merger Utility session (Opening a Merger Session, page 446).
• Expand the tree and click Connect.
• Click Actions > Connect to Source.
3. On the Connect to Source dialog box, select Use target domain as source.
Tip
• Whenever you open a new Merger Utility session, the source domain
is the same as the target domain by default. Therefore the details of
the current target domain (the domain that you selected when you
started this merge session) appear under Information.
4. Click Plant Hierarchy.
5. On the Source Plant Hierarchy dialog box, select as the source either the entire
domain or any plant hierarchy item within the domain. (For details of how to
continue the merge process, see Matching the Source Data with the Target Data,
page 457 .)

Merger Utility
Selecting a Source Domain from the Same

Database as the Target Domain (ODBC
You can select a different source domain than the target domain, but from the same
database as the target domain. You do this by selecting ODBC as your database and
Sybase Adaptive Server Anywhere as your database platform.
Notes
• The Merger Utility does not support source databases that have the As-
Built functionality.
• Make sure you have the proper access rights (logon name and password)
required to connect to the source domain. See Installation Guide,
Appendixes > SmartPlant Instrumentation Technical Review > Logon
Data and Database Connection Security to learn more about database
access rights.
You start this procedure as described in the procedure above. Then you establish the
connection to the required domain, as described in the steps that follow:
Select a Source Domain From the Same Database As the

Target Domain
1. In the Merger Session Manager window, open the desired Merger Utility
session.
Click Actions > Connect to Source.
•
3. On the Connect to Source dialog box, clear Use target domain as source.
4. Click Connect.
5. On the Connect to Database dialog box, from the DBMS list, select ODBC as
the database platform.
6. From the Profile name list, select the source database profile.
Tip
If you select ODBC as your database platform you can select only a
•
Sybase Adaptive Server Anywhere database profile (for example,
IN_DEMO, SP_INSTRUM, and so forth) from the Profile name list.
7. In the Logon name and Logon password boxes, type the logon name and
password to connect to the selected database.

Merger Utility
8. Click Plant Hierarchy.

page 457.)

Merger Utility
Selecting a Source Domain from a Database

Platform Other than ODBC
You can select a source domain from a database platform other than ODBC. In order
to establish a connection to the required database platform:
• Make sure you have all the correct DLL files and the right settings in the
appropriate INI files and/or registry. See Internal Setup Utility, to learn
more about configuring the database settings.
• Make sure you have the proper access rights (logon name and password)
required to connect to the source database. See Installation Guide,
Appendixes > SmartPlant Instrumentation Technical Review > Logon
Data and Database Connection Security to learn more about database
access rights.
Note
• The Merger Utility does not support source databases that have the As-
Built functionality.
You start this procedure as described in the section above. Then you establish the
connection to the required database, as described in the following steps.

Merger Utility
Select a Source Domain From a Database Other Than

ODBC
session.
• Click Actions > Connect to Source.
3. On the Connect to Source dialog box, clear Use target domain as source.
4. Click Connect.
5. On the Connect to Database dialog box, from the DBMS list, select the database
platform that you require.
6. Click OK to open the additional part of the Connect to Database dialog box.
7. In the Server name box, type the name of the database server.
8. From the Logon name list, select a logon name to connect to the selected source
database.
9. In the Logon password box, type the appropriate password to connect to the
selected source database.
10. On the Connect to Database dialog box, click Plant Hierarchy.
page 457 .)

Merger Utility
Matching Source and Target Projects
Match the Target Projects to the Source Projects

1. On the Connect to Source dialog box, click Match Projects.
2. On the Match Projects dialog box, match each target project individually to the
required source project by selecting in the Target (left) data window, the row that
represents the required target project and dragging it to the required cell under
Connected to Target Project in the Source data window.
Tips
• If projects in the source and target have the same names, you can
connect them automatically by clicking Match Names.
You cannot map a project onto itself.
•
3. Click OK to return to the Connect to Source dialog box.

Merger Utility
Matching the Source Data with the Target Data

After connecting to a database and selecting the source domain or plant hierarchy
item, you match the source and the target <units>. In this way, the Merger Utility
transfers data from the selected source <units> to the selected target <units> which
you are going to link. This procedure applies where you have selected a source plant
hierarchy item other than a <unit>.
Match the Target Data With the Source Data

1. On the Connect to Source dialog box, click Match Plant Items.
Tip
• If the Match Plant Items command button is not available, first click
Plant Hierarchy to open the Source Plant Hierarchy dialog box
where you have to select the domain, a plant, or an area as the source.
This action automatically opens the Match Plant Hierarchy Items
dialog box.
2. On the Match Plant Hierarchy Items dialog box, match each target <unit>
individually to the desired source <unit> by selecting in the Target (left) data
window, the row that represents the required target <unit> and dragging it to the
required cell under Connected To in the Source data window.
Tips
• You can map multiple source <units> to the same target <unit>.
• If <units> in the source and target have the same names, you can
connect them automatically by clicking Match Names.
• You cannot map a <unit> onto itself.
3. Click OK to return to the Connect to Source dialog box.
Tip
• If you need to merge the entire plant data; that is, matching all the
source and target <units>, you should consider merging the data in
several separate sessions. Merging the entire plant data in one session
may take a long time because it increases the time required to generate
the comparison reports. Also, a single merge session requires more
client and server computer resources.

Merger Utility
Matching Source and Target Naming Conventions

After mapping source and target <units>, you can match the loop and tag naming
conventions for those <units>. In most cases, if the source and target <units> use the
same naming convention type, you do not need to match the segment names.
However, under certain circumstances, for example, if the target naming convention
is the Flexible standard, you may need to match individual segments between the
source and target or map segments automatically when the source and target segment
names are identical.
Note
• After matching naming conventions, it is recommended that you run the
comparison list to view loop and tag names before merging the data
Match Source And Target Naming Conventions

1. On the Connect to Source dialog box, click Match Conventions.
2. On the Match Naming Conventions dialog box, under Target plant hierarchy,
expand the hierarchy and navigate to the desired <unit>.
Tip
If a source <unit> is mapped to the selected <unit>, the plant hierarchy
•
of the source <unit> appears beside the target <unit> name.
3. Under Naming convention type, do one of the following:
• Click Tag to map a tag naming convention.
•Click Loop to map a loop naming convention.
4. If required, click Clear to clear the mapping between the naming convention
segments in the source and target <units>. This action clears all the data in the
Source Segment column.
Tip
You can clear the loop and tag naming convention mapping for all
•
<units> in the domain by clicking Clear All.
• Under Source naming convention, select a row representing the
segment you want to match, and drag it to the Source Segment
column under Target naming convention for the required target
segment.
• Under Target naming convention, type in the Source Segment
column for the required target segment the required source segment
name.

Merger Utility
Tips
• If segments in the source and target have the same names, you can
connect them automatically by clicking Match Segments.
• When you drag the source name, the software displays the number of
the source segment in the Source Segment column instead of copying
the full string. You can add a substring and include fixed text in the
source segment name. For example:
#2 (1,3) + `DD'This means that the name of the second segment in the source is used.
The segment itself consists of the first three characters of the source segment name,
and has suffix `DD' (without the quotes).

Merger Utility
Defining Merger Utility Settings

Before merging data in a session, you need to set the Merger Utility options.
You can determine whether to do any of the following:
• Overwrite the target rows with identical source rows.

• Stop data merging if a source row fails to be transferred to the target.
• Use tag names for wiring items, and use the same source and target tag
and loop convention names.
Define Merger Utility Settings

1. Open a Merger Utility session.
2. Click Actions > Options.
3. Click each tab folder as required and specify your settings. The available tab
folders are:
• General
• Comparison Actions
• Update Mode
• Date
• Custom Fields
• Postprocess
Tips
• The Comparison Action tab folder becomes available only after
running a comparison list.
• The Update Mode tab folder becomes available only after you select
Update existing data in the General tab folder.
When merging configuration data items, you must select Update
•
existing data if you want to merge data for the Custom Field
Definitions and Custom Table Definitions items. These items
include tables that contain a fixed number of existing rows, and for
this reason, these rows can only be updated; it is not possible to insert
new rows.
4. After defining all the settings, proceed with the selection of the item types to
merge by performing one of the following procedures:
• Select the item types that you want to merge.

Merger Utility
• Compare the source and target data.

Merger Utility
Selecting the Source Modules

You use this option if you want to transfer all the data of selected modules or sub-
modules to the target domain. You can select entire modules and/or expand the
appropriate modules to select the required module data. At this stage, you can also
select specific loops that you want to merge.
For example, you can select the entire Instrument Index module or you can double
click the Instrument Index module icon to expand it and select the required
module data (for example, Line, Equipment, and so forth). You can also expand any
Instrument Index module data, such as supporting tables.
Note
• You cannot proceed with the merge process until you select the source
module and/or module data. The data window in the Select Items dialog
box does not contain module data with the caption Tags. This is because
the source tags are automatically selected when you select the Instrument
Index module. Therefore, to merge the source tags, select the source
Instrument Index module without expanding it.
Select the Source Modules and Module Data

1. Open a Merger Utility session.
3. Click the Item Type tab.
4. Under Merge data for, do one of the following:
• Click All plant items to select all items in the plant for data merging.
This option is available only if you have connected to a database that
is an Engineering company domain.
• Click Configuration data items to select configuration data items
only for merging. Configuration data is background data that includes
default panels and cables, specification forms, instrument types, and
various supporting table data. This option is available for any database
connection, whether it is part of an Operating owner domain or an
Engineering company domain. This option is useful where you need
to populate several domains with basic data from the same source.

Merger Utility
Tips
• When merging configuration data items, on the Merger Preferences
dialog box, you must select Update existing data if you want to
merge data for the Browser with Specification item. This ensures
that the browser views open properly after merging.
• When merging configuration data items, you must select Update
existing data if you want to merge data for the Custom Field
Definitions and Custom Table Definitions items. These items
include tables that contain a fixed number of existing rows, and for
this reason, these rows can only be updated; it is not possible to insert
new rows.
5. Return to the Merger Session Manager and do one of the following:
• Expand the tree and click Select.
• Click Actions > Select Items.
6. On the Select Items dialog box, select the module data that you want to transfer
from the source domain to the target domain.
A check mark appears beside everything that you select.
Tip
• Using the Select all check box to select items is not the same as
selecting all the items in the data window. If you select the Select all
check box, the software selects all plant items and all configuration
data items (excluding User Group and Access Rights), regardless of
which items appear in the data window.
7. To make a more precise selection of the source data by selecting the required
source table (applies only if you selected All plant items), do the following:
a. Click Advanced.
b. On the Advanced Selection dialog box, select the source table to be merged
to the target domain.
8. Click OK to save the Merger Utility settings.
9. At the prompt, click Yes to confirm your selection of the source data.
Related Topics
• Monitoring the Transfer Process, page 507
• Selecting the Source Tables, page 464

Merger Utility
Selecting the Source Tables

You can make a more precise selection of the source data. You do this by selecting
the source tables to be merged (for example, Manufacturers Table, Status Table, I/O
Table, and so forth) in the Advanced Selection dialog box.
You open the Advanced Selection dialog box by clicking Advanced in the Select
Items dialog box.
The Advanced Selection dialog box consists of the following sections:
• Filter: Select the criteria that are used to filter the displayed tables.
• Sort: Select whether to sort the tables by name or by merge order.
• (Table data): Select the required source table to transfer to the target
domain. You can also type additional data to append to the target domain
during the transfer process.
Note
• If you resume a previous merge session, you see in the Advanced
Selection dialog box the source tables which were selected in that merge
session.
Now you can:
• Select the source tables that you want to merge.

• Specify data which will be appended to the target domain during the data
transfer.
• Specify an insertion condition for the required source tables.
• View the displayed source tables according to your required filtering and
sorting options.

Merger Utility
Select the Source Tables to Be Merged

• Under the Select column, select the check box for each table you
require to include in the merge process.
• Select the Select all check box to select all the available source tables.
Selected source tables are displayed in red; unselected source tables are displayed
in black.
Tip
• To locate a table by name, click Search and type the table name in the
text box.
2. Select the check box in the Insert Only column if you want to specify an
insertion condition for the selected table — any updated data in the table does
not get merged in this case.
3. To merge the reference tables of any selected source table, click Reference
Tables.
Note
• All the reference tables associated with the selected source table are
automatically selected for merging.
Related Topics
• Selecting the Source Modules, page 462

Merger Utility
Selecting Item Types to Merge

You can select specific item types in the source that you want to merge:
• Wiring: All source wiring items, reference items, or plant (user- created)
items.
• Drawings: All drawings or just P&ID drawings.
Select the Source Item Types to Merge

1. With the Advanced Selection dialog box open, click Data Types.
2. On the Data Type Selection dialog box, under Wiring, select source wiring items
by doing one of the following:
• Click All to select all the source domain wiring items to be merged
with the target domain.
• Click Default to select only the source reference wiring items to be
merged with the target domain.
Click Plant to merge the plant (user-created) items from the source
•
domain with the target domain.
3. To select the source drawings, in the Drawings section, do one of the following:
• Click All to select all the source drawings to be merged with the target
domain.
• Click P&ID to select only source P&ID drawing names to be merged
with the target domain.
Tip
When merging P&ID drawings, associated data such as specifications,
•
tags, and so forth, is not transferred.
4. Click OK to close the Data Type Selection dialog box and return to the
Advanced Selection dialog box after accepting the values.

Merger Utility
Specifying an Insertion Condition

You can specify an insertion condition for every selected source table. This way you
instruct the Merger Utility to insert every selected source row of the selected source
table, which complies with the table's insertion condition. Note that the insertion
condition will affect only the source tables which you have selected to be merged (for
details, see Selecting the Source Tables, page 464.)
The insertion condition can contain any combination of the following:
• Source columns
• Operators or functions
• Alphanumeric values
Specify an Insertion Condition

1. On the Advanced Selection dialog box, select the check box under the Insert
Only column for the selected table. Use the horizontal scroll bar to display the
pertinent section of the dialog box.
This causes the Merger Utility to insert any source rows (of the selected source
table) which comply with the condition specified in the adjacent Condition
column.
2. Under the Condition column, type the appropriate insertion condition.
Caution
• Make sure you type the appropriate condition, as this will affect the
merge process results.
The Merger Utility provides you with the following inherent operators and functions.
Operator / Function Descriptions Example

= Equal to cpmnt_mfr
= `Shell'
> Greater than cmpnt_name
> `101'
< Less than item_price <
100
>= Greater or equal to num >= 10
=< Less than or equal to item_price
=< 30

Merger Utility
<> Not equal to prefix <>

ÀA'
AND Include the following expression name AND
in the filter combination num <> 0
OR Accept either the previous or the Loop OR
following expression in the filter line = `'
combination
NOT Select the value opposite to the NOT
following expression (item_price
= 0)
LIKE Select a value that is similar to the cmpnt_name
one in the `%[value]%' field LIKE
`%AA%'
IN Select a value that is equal to one cpmnt_name
of those specified in the = IN
parentheses (`101','103')
BETWEEN Select a value which is within the item_price
following interval BETWEEN
100 AND
500
IS NULL Equal to NULL Loop IS
NULL
IS NOT NULL Not equal to NULL line IS NOT
NULL
Tip
• The above operators and functions are those used in the WHERE string of
the SQL command.
You can also use special functions which are native to the source database.
The following table describes some of the most common functions. The source
databases which provide each function are specified beneath the function name (in
italics) in the Function column. The function output is described beneath the syntax
example (in italics) in the Example column.
Function Descriptio Example

ns

Merger Utility
LTRIM (<value>) dBase Sybase Remove all LTRIM(cmpnt_mfr) cmpnt_mfr

Adaptive Server Anywhere 7.0 leading = ` Shell'
Oracle 9i, 10g SQL Server spaces in LTRIM(cmpnt_mfr)=`Shell'
the field
indicated in
the
parentheses
RTRIM(<value>) dBase Sybase Remove all RTRIM(cmpnt_num) IS NULL
Adaptive Server Anywhere 7.0 trailing cmpnt_num = `108-FT 100 `
Oracle 9i, 10g SQL Server spaces in RTRIM(cmpnt_num)=`108-FT
the field 100'
indicated in
the
parentheses
SUBSTRING(<value>,<begin>,<co Retrieve a SUBSTRING(cmpnt_mfr,1,4)
unt>) dBase Sybase Adaptive Server part of the cmpnt_mfr = `Shell'
Anywhere 7.0 Oracle 9i, 10g field SUBSTRING(cmpnt_mfr,1,4)=`S
indicated in hell'
the [value]
data field
from the
[begin]
position for
the number
of
characters
SUBSTR(<value>,<begin>,<count> indicated in SUBSTR (cmpnt_mfr,1,4)
) SQL Server the [count] cmpnt_mfr = `Shell'
field SUBSTR(cmpnt_mfr,1,4)=`Shel'
UCASE(<value>) DBase Sybase The upper UCASE(cpmnt_name)
Adaptive Server Anywhere 7.0 case format cmpnt_name = `101-aa'
of the UCASE(cmpnt_name)=`101-AA'
contents of
the field
UPPER(<value>) Sybase Adaptive indicated in UPPER(cpmnt_name)
Server Anywhere 7.0 Oracle 9i, 10g the [value] cmpnt_name = `101-aa'
SQL Server data field UPPER(cmpnt_name)=`101-AA
LCASE(<value>) dBase Sybase The lower LCASE(Loop_name) Loop_name
Adaptive Server Anywhere 7.0 case format = `101-AA'
of the LCASE(Loop_name)=`101-aa
contents of
the field

Merger Utility
LOWER(<value>) Oracle 9i, 10g indicated in LOWER(Loop_name)

SQL Server the [value] Loop_name = `101-AA'
data field LOWER(Loop_name)=`101-aa
Note
• When a table is defined on a specified level, it contains data which is
unique on that specified level. For example, the CABLE Table is defined
per area. Therefore, the CABLE Table contains data which is unique only
on the area level of the domain.

Merger Utility
Filtering and Sorting the Displayed Source Table

List
You can filter and sort the displayed source tables. You do this by selecting the
options in the appropriate parts of this dialog box.
Note
• Filtering and sorting the source data in this dialog box does not affect the
results of the merge process.
Filter And Sort the Displayed Source Table List

1. To sort the table list which is displayed in the Advanced Selection dialog box, do
• Click By name to list the source tables by table name
• Click By merger order to list the source tables by the order in which
they will be merged during the transfer process (the merging order).
Tip
• You cannot change the merge order because it is automatically
determined by the Merger Utility.
2. To filter the data which is displayed in the Advanced Selection dialog box,
specify the filter conditions by doing one of the following:
• Select All to display tables at all levels in the domain.
• Select Selected to display only tables that were selected for merging.
• Select Per domain to display only tables that relate to the domain
level.
• Select Per plant to display only tables that relate to the plant level.
• Select Per area check box to display only tables that relate to the area
level.
• Select the Per unit check box to display only tables that relate to the
unit level.

Merger Utility
Selecting Source Data Using the Comparison List

This option enables you to compare the source and target data before you select it to
be merged. You can select item types to be compared either in batch mode (group
mode) or one by one. If you use group mode, the Merger Utility allows you to save
the comparison list in a number of file formats (psr, dbf, xls, and so forth). If you do
not select group mode, the Merger Utility displays the comparison data in a special
dialog box for each item type that you select in the Compare Source-Target Data
window.
After running the comparison list, you should examine the comparison results
carefully and select the desired data transfer mode and transfer parameters. For
example, you can determine whether you want to delete target data that does not exist
in the source or whether you want to delete all the tags associated with a deleted loop,
and so forth. You can also access specific comparison data, such as Specs, Process
Data, Cross Wiring, Signals, and so forth, depending on the item type you selected to
compare. Furthermore, you can customize the comparison list data display by
filtering and/or sorting the data according to your needs.

Merger Utility
Defining Comparison List Options

Before comparing data in a session, you need to set the comparison list options.
You can determine whether to do any of the following:
• Include or exclude wiring data when comparing tag data.

• Include or exclude connections when comparing wiring data.
• Include or exclude complementary data in the comparison.

Merger Utility
Define Comparison List Options

1. With the Merger Session Manager window open, click to display the
Compare Source-Target Data window.
2. Click Actions > Options.
3. On the Merger Compare Data Options dialog box, do the following to specify
how the Merger Utility auto-selects and merges wiring information:
a. If you selected Tag in the Compare Source-Target Data window, click one
of the following settings under Wiring selection by tag to merge wiring data:
• No wiring— The software includes no wiring data with the
selected tags during the transfer: the wiring information of the
target tags remains intact.
• Instrument wiring — The software includes all the device panel
and device cable data relevant to the selected tag be included, that
is, only the field device panels and cables are created for the
selected tags. If you select this option, make sure that you also
select Without connections under Selection by panel/cable.
• All wiring— The software includes the entire signal data that is
relevant to the selected tag.
b. If you selected the Cable, Set, Wire (Plant) and/or Panel, Strip, Terminal
(Plant) options in the Compare Source-Target Data window, select one of
the following settings to merge wiring data:
• Without connections — The software includes no connection
data with the selected item type during the transfer, that is, when
selecting panels and/or cables, only their structure is selected. This
is useful when merging or moving cables or panels from one
domain to another. You can access the connection information by
clicking 1 Side in the comparison list and select the relevant rows.
• With connections— The software includes the relevant
connection data during the transfer, that is, when selecting cables
or panels, their connections are also selected. This option instructs
the Merger Utility to select all the relevant panels, cables, tag
numbers, loop numbers, and all the rest of the required data. You
can refine the selection by canceling the selected connections.
c. Under Complementary data, beside each item, select the Select check box to
merge complementary data (specifications, process data, hook-ups, loop
module data, calibration data, custom field data, and other items).

Merger Utility
Defining a Comparison List Style

When displaying comparison data for an item type, you can specify which properties
of that item type you want to appear in the comparison list by defining a style. By
means of a style you can determine which columns are available, the order of the
columns, column widths, column header text, and the appearance of the column
header: border, background color, and overall height.
Define a Comparison List Style

2. Select an item type from the Comparison Item Tree and do one of the following:
• Click Actions > Create Style.
• Right-click the item type, and on the shortcut menu, click Style.
3. Specify the comparison list layout as follows:
• Change the column sequence by dragging the column header to the
required position.
• Change the column widths by dragging the right border between the
columns to the left or right as needed.
• Adjust the overall column header height by dragging the lower border
of the header up or down.
4. To change the header text, double-click inside the header to open the Edit
Column Name dialog box and edit the text as required.
• Click Actions > Style Properties.
6. On the Comparison List Style Properties dialog box, from the Border list, click
the border type that you require for the header.
7. Select View beside each column that you want to appear in the style.
Tip
• To display all the columns, select View all; to display none of the
columns, clear View all.
8. To choose a background color for the comparison list header, click Color to open
the Windows Color dialog box, where you can specify the color that you require.

Merger Utility
9. When done, click OK to accept the values and close the Comparison List Style
10. Click Actions > Save to save the style for the selected item type.
11. Click Actions > Close to return to the Compare Source- Target Data window.

Merger Utility
Comparing Data
You can compare data between the source and the target by opening a comparison list
for a selected item type. You can then select which data items to merge. You can
also specify the items that you want to display and print a report for the displayed
items.
Compare Source And Target Data

2. Select an item type from the Comparison Item Tree and do one of the following:
• Click Actions > Compare Data.
• Right-click the item type, and on the shortcut menu, click Compare
Data.
• Double-click the item type.
3. In the comparison list window for the selected item type, do one or more of the
following:
• To filter the data records to display, click .
• To sort the data, click .
• To specify which data columns to display, click .
4. To create or modify a style for viewing a comparison list that is already open, do
the following:
a. Click to return to the Compare Source-Target Data window.
b. Select the item type and click to open the Style window.
c. Modify the style as desired (for details, see Defining a Comparison List Style,
page 475). .
d. In the comparison list window for the selected item type, click to update
the comparison list using the style properties.
e. Select the records for merging by doing one of the following:
• Select the Select check box beside each data record that you want
to merge.
• To select all the data records, click .
• To clear the selection of all the data records, click .
• To select updated data records only, click .

Merger Utility
• To select inserted data records only, click .

• To select deleted data records only, click .
f. Select the data to display by doing one of the following:
• To display all the data items, click .
• To display modified data items only, that is, where the source and
target data differs, click .
• To display selected data items only, click .
g. If a comparison list is available for a child item type, click the desired option
on the Reports menu.
h. To generate a comparison list report, on the Actions menu, click Report.
i. To save the selection you made for merging, on the Actions menu, click Save.
Related Topics
• Working in Group Mode, page 479

Merger Utility
Working in Group Mode

Group mode enables you to make a batch selection of item types for comparison and
subsequent transfer of data. You save the comparison data for subsequent inspection
and analysis in an external file in a file format of your choice. After running the
comparison list, you can open the saved external file to examine the data so that you
can determine how to use the comparison list data.
Caution
• If you selected wiring item types or wiring information to be merged, do
not change the settings you made in the Merger Compare Data Options
dialog box. If you change these settings after selecting wiring item types
in the comparison list, the new settings apply only to new comparison list
selections. In any case, it is difficult to predict what happens when you
merge data in this case, as sometimes there can be a relation between
different item types that you select.
Compare Data Using Group Mode

session.
• Click Actions > Comparison List.
• Right-click the session, and on the shortcut menu, click Comparison
List.
3. Click Actions > Use Group Mode.
4. Click Actions > Group Mode Parameters.
5. On the Group Mode Parameters dialog box, select Save comparison list as
report only if you do not want to save the comparison results to the database.
This saves the generated comparison reports as external files only. You have to
make the appropriate selections under the Save data in section.
6. To automate the selection process, select the type of data to be selected under
Select data:
• All– This option selects all the existing item types (for example, tag,
loop, panel, cable, and so forth) This option is recommended to get all
the wiring and connection changes.
• Deleted– This option selects the item types that appear in the target
domain only.
• Inserted– This option selects the item types that appear in the source
domain only.

Merger Utility
• Updated– This option selects the item types that exist both in the
source and target and need to be updated.
• Saved previously– This option includes previously saved comparison
data.
Tip
It is recommended that you select the Deleted, Inserted, and Updated
•
options.
7. Under Additional options, select the required types of comparison reports to be
generated based on the selections you made under Select data:
• 1 Side– This report is for cables and panels. It reports the wire and
• Cable levels – Generate two additional reports for cables: cable sets
and wires of the cable. (Not mandatory if 1 Side is selected.)
• Panel level – Generate two additional reports for panels: panel,
strips, and sets and wires of the cable. (Not mandatory if 1 Side is
selected.)
• Jumper– This report identifies the jumpers by listing the two
terminals that the jumpers are connected to.
• Cross Wire– This report identifies the crossed wires by listing the
two terminals/strips and panel names that the crossed wires are
connected to.
• 2 Sides– This report lists the connections on both sides of a terminal
strip. Note that this report and the relevant comparison list data cannot
be used to select connections: it is for your information only.
• Signal– This report lists the connections for the selected tag numbers.
Note that this report and the relevant comparison list data cannot be
used to select connections – it is for your information only.
• Specs– This report lists the differences in specifications. This is a
generic report that displays the changed data only. You cannot select
single attributes for an update.
• Process Data– This report lists the differences in process data. This
is a generic report that displays the changed data only. You cannot
select single attributes for an update.
• For all data – Generate comprehensive comparison reports for
selected item types under Additional options (recommended).
• For selected data – Generate comparison reports based on your
selections under Select data for the item types selected under
Additional options.

Merger Utility
8. Click to specify the path and format of the file in which you will save the
comparison data. Several file formats are available, for example: .psr, .dbf, .xls.
Caution
• Make sure that you select the .psr format so that you can use the report
in the merge process.
After you make your selection, the Group Mode Parameters dialog box displays
the information in the Save data in section.
9. Click OK to accept your selections and to return to the Compare Source-Target
Data window.
10. Make your selections in the data window by clicking the desired item type. The
icon beside the selected item type changes to . The software automatically
selects all the child item types belonging to a selected item type. You can select
or deselect individual child item types if required as follows:
a. Double-click an item type to expand it. (Certain child item types may contain
other child item types.)
b. Click the desired item type to select or deselect it. The icon beside selected
item types changes to . If a check mark appears beside an item type, it
means that the item type has already been used in a previous run of the
comparison list.
Caution
• To ensure correct merging of specification data, make sure that you
select all the tag numbers associated with multi-tag specifications,
especially the master tag number. If you do not do so, the
specification information will not be updated.
11. Click Actions > Build Item List if you want make additional source selections in
the module list after running the comparison list. Note that selecting this option
will slow down the merge process. Do not select this option if you do not intend
to use the module list feature.
12. Click Actions > Generate Comparison List to run the comparison list for the
selected items.
Note
• The comparison procedure may take some time depending on the size of
the database tables. At the end of the comparison procedure, you can view
the comparison reports by opening the appropriate psr files.

Merger Utility
Running the Comparison List in Multi-Sessions

So as not to run out of computer resources, it is highly recommended that you run the
comparison list in group mode in more than one session. Make sure that on the
Actions menu, the Build Item List menu command is not selected (no check mark
beside the command) — this speeds up the process. There is may be no need to
create a table list for merging if you don't intend to use it at that time. The following
table summarizes the recommendations for the multi-session procedure.
Session A Session B Session C Session D Session

E
Mandatory: No Yes Yes Yes No
Can be No Yes No No No
done per
<unit>?
Long time No Yes Yes Yes Moderate
for
generation?
Select Wiring Instrument Panels Cables Restore Panel
items Supporting Index (Plant) (Plant) (Plant) PSR
Tables Supporting and run for
Default Tables Loop Strip &
Cables Tag Line Terminals
Default Equipment Comparison
Panels Loop P&ID CS Tags List, then
Drawings save
Module
Hook-Ups
Module
Group Select data Select data – Select data – Select The Panel
Mode – All Cable All All Cross data – and Cable
Options Levels Panel Specifications Wiring 2 All 1 Levels can be
Levels Save Process Data Sides Side generated
comparison Signal Select (optional) Select separately
list as report the For all Select the the For from the PSR
only Note: Data option For all Data all Data files of the
Cable and Save the option Save option Panel &
panel levels Comparison the Cable to save
are not list as report Comparison the computer
mandatory. only. list as report resources
only. during the
Group mode
comparison.

Merger Utility
If run on Panel Levels Cable

<unit> basis, (see session Levels
save in E) (see
different session
folders E)
Note
• You can reduce the amount of data to be merged by selecting fewer item
types, depending on the comparison information you require.

Merger Utility
Analyzing Comparison Reports

After the comparison reports are saved as psr files (or any other type of file), you can
print them out and start analyzing the data. If a field's value was changed, a U mode
is assigned to this record and the changed column is highlighted with a light blue
background.
The following example is for instrument type comparison.
In the second row, the highlighted changes were made in the target table. In the
source table, these fields do not contain data.
In the third row, the target table does not contain an entry while the source table does.
That is why there are two rows. Sometimes the field is too short to display the entire
record, which causes the text to auto- scroll. Note that this can also make the field
appear as two rows. You can then stretch the column to make it longer.
To analyze the data, you need to print out the reports and mark changes you want to
make on the printouts. In the case of the supporting tables, this is a simple task since
these tables usually include two columns. All of the supporting tables are merged in
one process since they are required for the main item types. Therefore, you do not
need to worry about them so much.
Concentrate on the main item types:
• Loops and tags

• Instrument Type (although this is a supporting table)
• Cables
• Panels
• Analyze the changes in process data and specifications
• Connections (1 Side)
• Cross Wires
• Jumpers
• Control system tags:
• Loop blocks
• Hook-up drawings

Merger Utility
Mark the reports (use color markers if possible), mainly for wiring changes.

Merger Utility
Checking for Duplicate Items

Sometimes, when you create data, you can add spaces or other characters
accidentally, so that what is intended to be the same record with updated data is in
fact viewed by the database as a separate record. You can specify redundant
characters that you want the software to ignore, and then you can run a check for
duplicate items based on the item names without the redundant characters.
Check for Duplicate Items

1. With a Merger Comparison List dialog box open, on the Actions menu, click
Duplicates to open the Duplicate Items dialog box.
2. Click Characters to open the Redundant Characters dialog box.
• Click Add to add a new row and type in the required character or
string.
• Select an existing character and modify it as needed.
• Select a row and click Delete to remove that row from the list of
redundant characters.
• Click Use Default to clear all user changes and restore the default set
of redundant characters.
Tip
You can type strings of up to 20 characters.
•
4. Click OK to return to the Duplicate Items dialog box.

Tip
The Identity Name column displays the modified item name without
•
the redundant characters, and selects any duplicate rows using
background shading: the software selects the first instance using light
blue shading and duplicate items using gray shading.
5. Under View, click one of the following options:
• All items– All the items derived from the comparison list appear.
• Selected items– Only the items you select for merging appear.
Duplicate items– Only the items highlighted as duplicates appear.
•

• In the Select column, select the items you want to include for data
merging.

Merger Utility
• Select the Select all check box to include all of the items or clear the
check box to include none of the items.
Tip
• Selecting or clearing Select all affects the displayed items only.

Merger Utility
Restoring Saved PSR Files

Restoring .psr files enables you to avoid re-generation of the comparison list. Restore
your existing .psr files if you are certain that they reflect updated data. If you are not
sure that the .psr files contain updated data, re-generate the comparison lists either
one at a time (not recommended) or in group mode.
Restore a Previously Saved .Psr File

session.
2. Define a new log file.
3. Define the required Merger Utility settings — the settings depend on the item
types you are about to merge.
• Click Actions > Comparison List.
Right-click the session, and on the shortcut menu, click Comparison
•
List.
5. In the Compare Source-Target Data window, highlight the item types that you
want to include in the comparison.
6. Click Actions > Restore Comparison Data.
7. On the Select PSR File dialog box, navigate to the .psr file that you want to
restore.
8. Click Actions > Merge to start generating the comparison lists.

Merger Utility
Making Individual Item Type Selections

You can also select individual item types for comparison. You can expand an item
type and run the comparison list for the selected item type only. If a child item type
contains other child item types, they will also be included in the comparison list for
that item type. Expand the desired child item type and make your selections.
Running the comparison list by making an individual item type selection
• With the Compare Source-Target Data window open, make sure that on
the Actions menu, the Use Group Mode menu command is not selected
(no check mark beside the command).
• Expand the items in the tree so that you can highlight the individual item
type for which you want to run a comparison list.
• Double-click the selected item type.
• Click Actions > Generate Comparison List.
• Right-click the item type, and on the shortcut menu, click Generate
Comparison List.
The Merger Utility starts running the comparison list. At the end of this process, the
Merger Comparison List dialog box opens.
• If available, select an option on the Reports menu to display the

Connection, Process Data, and Specifications comparison data to
facilitate the selection of rows to be merged. Note that some of these
options are disabled if they are not relevant for the item type you selected
in the Compare Source-Target Data window.
• To customize the displayed data in the comparison list, on the Actions
menu, point to Display Records and click one of the following options:
• All Records— Displays all the available records.
• Selected— Displays only those records selected for merging
• Modified— Displays modified records only, where the source and target
data differs.
• Under the Select column, click the check box for each row you want to
select to be merged.
• Make a batch selection by right-clicking in the window, pointing to Select
Records and clicking one of the commands: All, Updated, Inserted, or
Deleted to specify the rows to include in the merge process.
• Click Actions > Save.

Merger Utility
Merging Supporting Tables

When merging supporting tables, note the following:
• Instrument Index module: When selecting tag numbers, the appropriate

items from the relevant supporting tables will also be selected. Specific
supporting tables can be also merged using the comparison list feature.
• Wiring module: Use the comparison list feature to merge specific Wiring
module supporting tables. However, if a cable or a panel was selected by
you or by the Merger Utility, previous selections will be ignored and the
entire table will be merged. To merge data successfully, you must include
the entire set of reference data. This rule applies to both the Instrument
Index and Wiring modules. Failure to select all the reference data may
result in a chain reaction which will cause large amounts of data not to be
merged. The Merger Utility makes sure that this situation does occur by
selecting entire supporting tables to be merged.

Merger Utility
Guidelines for Selecting Item Types and Defining

Merger Settings
The following tables provide some specific guidelines to help you define the settings
when merging various SmartPlant Instrumentation modules. Remember to define
these settings before you select the item types to be merged. If you run merger
several times to merge different tables, click Clear all to reset the previous selections.
Selected Option Settings Result Comments

Instrument Types General: Update existing Imports all
data Comparison references as per
Options: Insert/Update instrument type
Include all reference tables profile: Wiring
supporting tables,
defaults for cable,
panel and
connection types
I/O Types
Location Hook-ups
and hook-up types
Specification
forms
Equipment General: Update existing Equipment type
data Equipment custom
fields
Line General: Update existing Line Type PD
data Comparison insulation Line and
Options: Insert/Update Line custom fields
Include all reference tables
Loop General: Update existing Loop Reference New loops will
data Identical source and Tables Loop and automatically
tag Comparison Options: Loop custom fields be added if new
Insert/Update Include all Specification tags are added
reference tables forms from the
source.

Merger Utility
Tag Numbers – General: Update existing Wiring supporting Merges all

No Wiring data Identical source and tables Associated associated
tag Comparison Options: instrument types reference
Insert/Update Include all Associated index tables. No
reference tables Wiring and loop tables wiring will be
Selections Selection by Loop drawing merged or
Tag No Wiring Selection information changed for
by Panel/Cable Without Blocks/cells and selected tag
Connections types Process Data numbers.
Specifications and Selecting With
Revisions Connections
Associated custom will not
fields Associated affect/add any
hook-up data wiring data.
Tag Numbers – General: Update existing Wiring supporting Control System
Instrument data Identical source and tables Associated tags will not be
Wiring (Field tag Comparison Options: instrument types merged
Devices only) Insert/Update Include all Associated index Important: If
reference tables Wiring and loop tables the With
Selections Selection by Loop drawing Connections
Tag Instrument Wiring information option is
Selection by Panel/Cable Blocks/cells and selected,
Without Connections types Process Data additional
Specifications and panels, cables,
Revisions and connections
Associated custom will not be
fields Associated added (junction
hook-up data Field boxes and
Device cables, marshaling
panels, and their racks) unless
connections on the these are
instrument side selected from
Panel/Cable
lists.

Merger Utility
Tag Numbers – General: Update existing Wiring supporting Will only

All Wiring data Identical source and tables Associated connect the
tag Comparison Options: instrument types wires
Insert/Update Include all Associated index associated with
reference tables Wiring and loop tables the selected tag
Selections Selection by Loop drawing numbers.
Tag Instrument Wiring information Caution: If the
Selection by Panel/Cable Blocks/cells and With
Without Connections types Process Data Connections
Specifications and option is
Revisions selected,
Associated custom additional
fields Associated panels, cables,
hook-up data Field and connections
Device cables, will be added
panels, and their for all the
connections on the selected panels.
instrument side All
associated panels
and cables that the
signals go through

Merger Utility
Cable or Panel General: Update existing Merges the Connections

(Plant or data Comparison Panel/Cable can be merged
Default) Options: Insert/Update structures without if selected from
Include all reference tables connections. the Merger
Wiring Selections Panel/Cable Comparison
Selection by Panel/Cable supporting tables List - Wire
Without Connections Terminal
dialog box.
This will
include
additional
information as
required. If you
select
connections (by
cables) with
signals, field
device cables
will be selected
to be merged
but they will
not be
connected. The
Selection by
Tag setting has
no effect in this
case.

Merger Utility
Cable (with General: Update existing Complete cable You can cancel
connections) data Comparison structures the selection of
Caution: Options: Insert/Update (cable/set/wires) cable
Working in this Include all reference tables and supporting connections on
mode makes Wiring Selections tables. All the the Merger
Merger select Selection by Panel/Cable panels / strips / Comparison
more panels, With Connections terminals that are List - Wire
cables, and required to connect Terminal
connections than their wires. dialog box.
selected. This is Instrument Index Additional
due to signal – tag numbers and panels, cables,
relations. If you their loop and and all their
are not sure, supporting table connections
choose the records. will be added
Without Specifications and and processed if
connections Process Data. Loop connections
option. and Hook-Ups with signals are
module associated involved. The
data (for tag Selection by
numbers). Wire Tag setting has
connections. All no effect in this
associated custom case.
field data.

Merger Utility
Panel (with General: Update existing Complete panel You can cancel
connections) data Comparison structures the selection of
Caution: Options: Insert/Update (panel/strip/termin cable
Working in this Include all reference tables als) and supporting connections on
mode makes Wiring Selections tables. All the the Merger
Merger select Selection by Panel/Cable cables connected Comparison
more panels, With Connections to the selected List - Wire
cables, and panel / strip, Terminal
connections than including the cable dialog box.
selected. This is supporting tables. You can cancel
due to signal Instrument Index the selection of
relations. If you – tag numbers and jumpers and
are not sure, their loop and cross wires in
choose the supporting table appropriate
Without records. dialog boxes.
connections Specifications and Additional
option. Process Data. Loop panels, cables,
and Hook-Ups and all their
module associated connections
data (for tag will be added
numbers). Wire and processed if
connections, connections
including jumpers with signals are
and cross wires involved. The
connected to the Selection by
selected panels / Tag setting has
strips. All no effect in this
associated custom case.
field data.

Merger Utility
Control System General: Update existing Appropriate data You will not
Tag Caution: If data Comparison will be selected to need this option
With Options: Insert/Update be merged in most cases.
connections is Include all reference tables depending on the However, if
selected, the Wiring Selections setting you select you do, the
entire wiring Selection by Panel/Cable in the Selection by software will
chain of all Without Connections Tag section: No merge basic
cables is selected Selection by Tag No Wiring and engineering,
(not Wiring OR All Wiring Instrument wiring, and
recommended). (not recommended) Wiring will select other associated
the data required data.
for tag assignment.
If a field device
exists, it will be
merged too. The
All Wiring option
will select the
entire signal data.
Instrument Index
– tag
numbers and their
loop and
supporting table
records.
Specifications and
Process Data. Loop
blocks. All
associated custom
field data.
Associated hook-
up data.
External Blocks N/A Block Types
Blocks
Tag & Block N/A for information Tag and block
Association only. Not associations are
selectable to be merged when
merged. merging tag
numbers

Merger Utility
Item List Comparison Item List Library Items List Selecting the
Options: Include all
Insert/Update reference
Include all tables option in
reference tables the
Comparison
Options tab
folder will
merge the
hook-types,
hook-ups, and
hook-up items
Hook-Ups No special Hook-up type Hook-ups
settings Item Library and Items
Tag and Hook- N/A for information only. Not Tag and hook-
Up Association selectable to be merged. up association
is merged when
merging tag
numbers.
Important Notes:
1. Do not change the wiring selection options before starting the actual merge
process. The software processes the selected rows and carries out the merge
process in accordance with the settings.
2. When selecting the With connections option in the Wiring Selections tab folder,
records that appear only in the target are marked as deleted and are selected
automatically by the Merger Utility. These selections, in most cases, will be
wrong and you will have to clear the Select the check box in the appropriate
comparison list dialog box (for example, after clicking on the 1 Side button in the
Comparison List).
3. Exercise caution when using the Delete option in Merge Options dialog box,
Comparison Actions tab folder. This option instructs the Merger Utility to
actually carry out delete operations. It is possible that the software will not delete
items that are associated with other items. Double check the selected records after
merging. Delete data directly in SmartPlant Instrumentation if results are not
satisfactory. In most cases, you do not need to select the Delete option.
4. When selecting item types to be merged, especially Wiring and Instrument Index
data, it is important not to select different item types within the same merge
session. This is due to the fact that the Merger Utility processes your selections
differently when it comes to tag numbers, cables, panels, and connections based
on the pre-selected settings.
5. The final selection of tables and item types to be merged is determined when you
click Save to close the Merger Comparison List window. You can browse the

Merger Utility
selected records of different item types. Click Close to close the window without
saving your changes.

Merger Utility
Merging Jumpers and Cross Wires

Jumpers and cross wires are processed differently from ordinary cables since the
Merger Utility has to connect both sides of the wires when adding them. To access
the cross wires or jumpers, select a panel and in the Merger Comparison List
window, on the Reports menu, click Cross Wire or Jumper. The dialog box
displays the wires that are connected to the selected panels. Under Records to select,
click the appropriate check boxes for the records that need to be inserted, depending
on whether you selected With connections or Without connections.
You can select or deselect records as required. It is important to have all the jumpers
and cross wires existing in the Wiring module for further processing.
Note that when you select a panel using the With connections option, the Merger
Utility automatically selects the jumpers and cross wires.

Merger Utility
Merging Specification Forms that Include Custom

Title Blocks
When you associate custom title blocks with specification forms, two methods of
association are available:
• A separate special title block definition for each form

• A common standard title block definition used for all the forms in the
domain.
When merging data in update mode, you must analyze your source and target
databases to determine which option they are using for specification form custom title
blocks. If the options are identical in both, or if the target uses the standard option,
you can merge the data without any problems.
If the source database uses the standard option, and the target uses the special option,
you are likely to lose data after merging. In this case, your System Administrator
must change the Custom title block assignment method option in the source domain
from Standard to Special.

Merger Utility
Customizing the Comparison List Display

The Merger Utility enables you to customize the comparison list data display. You
can filter and or sort the data according to your needs. You can select the columns
you want to view, in which case the other columns will not be displayed. It is also
possible to display only the data lines that you selected for the merge process
(selected check boxes in the Select column). Another way of choosing the rows to
display is to select the By mode option. In this case, you can display deleted,
inserted, and or updated rows.

Merger Utility
Filtering the Comparison List Data

This option enables you to filter the rows displayed in the comparison list. You can
specify a filtering condition that will filter the comparison list data.
Note that filtering the comparison list rows will not affect the selection and row
sorting you made prior to filtering the comparison list data.
Filter the Comparison List Data

1. With the comparison list open, on the Actions menu, click Filter to open the
Merger Comparison List Filter dialog box.
2. To include a field in the filter condition, double-click the required field in the
Field list and it will appear in the editable data window at the top of the dialog
box.
3. Enter the required filter condition by either typing it in directly in the data
window or by selecting the appropriate operators and functions.
4. Click OK to accept the filter condition and return to the comparison list.

Merger Utility
Displaying Specific Columns

This option enables you to select the data columns that you want to be displayed in
the comparison list.
Display Specific Data Columns in the Comparison List

1. With the comparison list open, on the Actions menu, click View to open the
Select Columns for Viewing dialog box.
2. Under Column list, drag the required columns to be displayed to Columns to
view. Only the columns that appear under Columns to view will be displayed in
the comparison list.
3. If the comparison list currently does not display all the available rows, you can
select the check boxes Select All to display all the columns in the comparison list,
or Include modified columns to display only those columns that contain changed
data.
4. Click OK to accept your selections and return to the comparison list.

Merger Utility
Sorting the Comparison List Data

This option enables you to sort the comparison list data. You can select any number
of columns to use for sorting the data.
Sort the Comparison List Data

1. With the comparison list open, on the Actions menu, click Sort to open the Select
Columns for Sorting dialog box.
2. Under Column list, drag the required columns to be used for sorting to Sorted
columns. The data will be sorted according to the columns that appear under
Sorted columns in the order that they appear.
3. To remove a column to be used for sorting, drag it from Sorted columns to
Column list.
Tip
• To change the sort order, drag all the columns to Column list, and
then drag them in the required order under Sorted columns.
4. Click OK to accept your selections and return to the comparison list.

Merger Utility
Displaying a Comparison List for a Child Item Type

This option enables you to display additional detailed comparison data pertaining to a
child item type (if available).
Note
• The information in the comparison list for child item types is not editable.
The following table indicates the item types that contain child item types.
Main Item Type Available Child Item Types for Comparison

Line Process Data
Tag Signal, Process Data, Specs
Panel 1 Side, 2 Side, Cross Wire, Jumper
Strip 1 Side, 2 Sides
Terminal 1 Side, 2 Sides
Cable 1 Side
Cable Set 1 Side
Wire 1 Side
Display the Comparison List for a Child Item Type

1. With the comparison list for the selected item type open, on the Reports menu,
click the appropriate command to open the Merger Comparison List dialog box
for the desired child item type.
2. Under View, click All or Changed data only as required to filter the data to be
displayed.
3. Click Print to print out the data.
4. Click Close to return to the comparison list.
Tip
• When the 2 Sides option is selected for panels, strips, or terminals, if
some of the connection data was changed, the merge mode will be U
(update), and both the previous and current values will appear in the
same field. Fields that contain no data signify that the selected panel
has no wiring on that side.

Merger Utility
Monitoring the Transfer Process

At this stage, you carry out the actual data transfer, after you have selected the source
and target data and matched one to the other.
Caution
• You will not be able to change the Merger Utility process parameters after
you start the data transfer.
Start the Transfer Process

1. With the Merger dialog box open, click Merge to start the transfer process.
2. At the prompt, click Yes to start the data transfer.
Tip
• If you encounter memory problems or you want to make the data
transfer process faster, for details of how to speed up the transfer
process or free memory resources during the transfer process, see
Preliminary Configuration, page 508.
3. On the Merger Progress dialog box, click Stop if required at any point during
the transfer process to stop the current data transfer process.
Note
• If you stop the transfer process, the Merger Utility skips all the rows of
the currently processed table. You can resume the transfer process in
the current merge session (by clicking Continue) or in another merge
session (after exiting the current merge session). When you resume
the transfer process, the Merger Utility restarts the merge of the last
table from which you left off.
4. On completion or stopping of the transfer process, click OK to close the
notification message.
5. In the Merger Progress window click Cancel to return to the Merger dialog box.
You have successfully copied data from a source domain to a target domain.
Now you can:
• Start SmartPlant Instrumentation and enter the appropriate target domain

to view the results of the merge.
• View the log file to examine information about the merge results of the
current merge process (for details of how to view the log file contents, see
Working with Log Files, page 150).

Merger Utility
Preliminary Configuration
Caution
• We recommend that you do not configure the Merger Utility unless it is
absolutely necessary.
This feature provides you with the means to control the data flow during the merge
process. You can also use this feature to select the application to view the log file. In
most cases, you do not need to use this feature. However, you can use it if you
encounter the following problems:
• The merge process is slow.

• Your computer has insufficient memory resources to perform the merge
process.
• The current application which is used to view the log file cannot handle
the current log file (for example, due to the size of the log file).
• This procedure enables you to:
• Speed up the transfer process.
• Free memory resources for the transfer process.
Perform A Preliminary Configuration

2. Click the Data Flow tab.
3. Do one of the following to determine how fast the software merges data:
• Leave the contents of the fields unchanged (the default values are:
1000 rows in the Source rows to retrieve data field, and 500 rows
in the Target rows to commit data field).
• Type a larger number of rows than the current default values. This
way you speed up the merge process.
• Type a smaller number of rows than the current default values.
This way you free memory resources but it may slow down the
merge process.
Tip
• Make sure you do not exceed your memory capacity as this may
cause the merge process to fail during the data transfer.
4. To see the effect of the new settings, continue with the merge process.

Merger Utility
Related Topics
• Merging Data - Overview, page 442

Merger Utility
Post Merging Actions

After the merge process has been completed (in one or several sessions), it is
recommended to test the results. In some cases, there might be a need to do some re-
propagation of tag numbers in the Wiring module (some manual adjustments may be
required in the database). This is due to tag numbers that were created in one
database in the field, but in the other database they originated in a DCS or PLC.
For a large quantity of data, it is recommended running the comparison lists again to
verify that all new items were inserted and there are no missing connections or cross
wires.

Merger Utility
Configuring Your Environment

When you install the software, the Merger Utility settings are automatically
configured in the appropriate configuration files. See your database manual to learn
more about your database configuration.
In a Windows 2000 or Windows XP environment, the database configuration settings

are located in the following registry folders:
• HKEY_CURRENT_USER\Software\ODBC\ODBC.INI
• HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI
Caution
• Do not change the setting in the configuration files if you are not familiar
with the database configuration.

Merger Utility
Naming Convention Rules

When the Merger Utility transfers data from a source domain into a target domain,
the source and target domains must have applicable naming convention standards.
This is important because some naming convention standards cannot be merged into
other naming convention standards.
The naming convention standards define the structure of the naming convention in the
domain. The possible standards are:
• ISA
• Loop
• Flexible
• Free
The Domain Administration determines the naming convention standard when you
create the domain in the Administration module.

Merger Utility
After you select the source domain in the Merger dialog box, the Merger Utility
automatically checks the source and target naming convention standards. If the
source and target naming convention standards cannot be merged, an appropriate
message is displayed, in which case you will have to select a different source/target
domain. The following table describes the applicable source and target naming
convention standards, which are supported by the Merger Utility.
Source Standard Target Standard Is merging possible?

ISA ISA Yes
ISA Loop No
ISA Free Yes
ISA Flexible No
Loop Loop Yes
Loop ISA Yes
Loop Free Yes
Loop Flexible No
Free Free Yes
Free ISA No
Free Loop No
Free Flexible No
Flexible ISA Yes
Flexible Loop Yes
Flexible Free Yes
Flexible Flexible Yes

Index
Index
.dxf files in the Merger Utility, 470
saving reports, 91 comparison list
.pbl files analyzing Merger comparison reports, 477
retrieving reports, 105 customizing Merger Comparison List display, 493
.psr files defining style, 468
managing the file list, 104 displaying, 470
opening in InfoMaker, 117 displaying specific columns to merge, 495
overview, 99 filtering Merger Comparison List data, 494
retrieving files, 101 import options, 167, 168, 169, 170, 186, 188, 190,
saving data, 102 191, 192, 193, 194, 196, 197, 199, 200, 203,
user-defined fields, 106 205, 206, 208, 209, 211, 212, 215, 219, 220,
viewing, 100, 103 221, 222, 223, 224, 225, 226, 227, 228, 229,
.xml files 230, 231, 232, 233, 234, 236, 238, 239, 241,
prerequisites for working with DCS vendors, 303 242, 243, 244, 245, 246, 247, 248, 249, 250,
ABB 251, 253, 254, 255, 256, 257, 258, 261
associate fieldbus device types, 326 Merger data for child item types, 497
retrieving definitions, 313 Merger group mode selection of source data, 472
ABB interface, 302 Merger multi-session mode, 475
accessing options, 466
Web Client, 348 selecting individual item types to merge, 481
Acrobat Distiller selecting source data to merge, 465
batch printing to PDF, 86 sorting Merger Comparison List data, 496
setting print options, 88 comparison options
Acrobat Distiller printer driver Merger comparison criteria, 436
testing configuration, 364 custom fields
Adobe Acrobat custom title block, 94
defining PDF generation settings, 367 documents, 94
running Update Title Block add-in, 368 revisions, 94
Adobe Acrobat Distiller viewing PSR user-defined fields, 108
configuring, 361 custom hierarchy, 374
associating custom tables, 46
fieldbus device types, 326 managing custom tables, 46
batch operations custom title blocks
Acrobat Distiller options, 88 associating with SmartPlant Instrumentation, 356
Ghostscript printer options, 87 customization requirements, 94
printing documents, 85 editing properties, 98
printing documents to PDF files, 86 field descriptions, 94
browser manager overview, 93
creating a workflow, 78 customized reports
browsers Save As options, 120
creating new, 120 data formats
CENTUM CS 3000 Save As options, 90, 91, 92, 102, 120
terminology differences, 325 data import
CENTUM CS 30000 interface, 302 import mode parameters, 175, 177, 179, 184
changed documents, 75 database
changing creating profiles in InfoMaker, 115
schema, 372 database structure of SmartPlant Instrumentation, 111
tasks, 422 databases, 141
claiming Import Utility, 141
To Do List, 419 DCS panels
comparing data manufacturer-specific labels, 46

Index
DCS vendors, 326 finding loops

creating DCS panels, 324 all loops in a unit, 31
overview, 302 common tasks, 26
prerequisites, 303 overview, 25
publishing data, 320 typical loops, 33
viewing items in SmartPlant Instrumentation, 323 using search parameters, 31
viewing the log, 323 finding tags
deferring all tags in a unit, 27
tasks, 425 common tasks, 26
deleting overview, 25
tasks, 425, 426 typical tags, 30
DeltaV using search parameters, 28
associate fieldbus device types, 326 Fluke interface
crucial fields, 314 overview, 327
downloading definitions, 309 generic PostScript printer
flow of activities, 305 configuring, 358
publishing data, 321 Ghostscript
retrieving definitions, 310 printer options, 87
terminology differences, 325 global revisions
DeltaV interface, 302 adding, 61
dimensional data sheets common tasks, 58
publishable groups, 407 deleting, 66
Distiller printer driver filtering items, 60
testing configuration, 364 overview, 57
document headers updating, 63
editing, 92 upgrade example, 65
Document Selection Wizard, 399, 400, 406 upgrade settings, 62
finding dimensional data sheets, 405 upgrading, 64
finding Enhanced SmartLoop reports, 403, 404 Honeywell
finding process data sheets, 400 associate fieldbus device types, 326
finding specifications, 402 retrieving definitions, 312
overview, 399, 400 Honeywell interface, 302
summary, 406 I/O cards
documents manufacturer-specific labels, 46
previewing, 83 Import Utility
printing, 85 database platform support, 141
printing to PDF files, 86 overview, 140, 143, 145, 146, 147, 149, 150, 151,
retrieving, 413 152, 153, 154, 155, 156, 157, 158, 159, 161, 163
revision archive, 69 prerequisites, 142
revision management common tasks, 58 importing data, 177
revision management overview, 56 import mode parameters, 175, 177, 179, 184
saving, 90 InfoMaker, 109
saving in .dxf format, 91 building a query, 113
editing defining a library, 119
tasks, 422 installing, 110
Emerson DeltaV i,nterface, 302 libraries, 117
executing opening psr files, 117
tasks, 422 reports, 117
export saving customized reports, 120
Save As options, 90, 91, 92, 102 instrument types
Export Schema Configuration Utility, 391 associating with fieldbus device types, 326
fieldbus instruments
device type associations, 326 finding, 25
finding integration, 336
SmartPlant Instrumentation documents to publish, accessing Web, 348
398 creating custom hierarchy, 374

Index
deferring tasks, 425 revision management overview, 56

define To Do List settings, 421 jumpers
defining PDF generation settings, 367 merging, 491
defining schema, 384 language
deleting tasks, 426 common tasks, 48
Document Selection Wizard, 399, 400, 406 creating language files, 51
filtering tasks, 424 editing, 53
finding dimensional data sheets, 405 overview, 47
finding Enhanced SmartLoop reports, 403, 404 prefixes and suffixes, 55
finding process data sheets, 400 replacing from database, 49
finding specifications, 402 replacing from file, 50
installing Update Title Block Component, 366 library in InfoMaker, 119
mapping DDP data, 387 link properties
mapping schema, 371, 379, 386 import mode parameters, 175, 177, 179, 184
overview, 336 local revisions
publishable dimensional groups, 407 adding, 67
publishing documents, 392 deleting, 68
refreshing, 426 editing, 68
reporting, 426 log file
requirements, 338 DCS vendors, 323
retrieving documents, 413 logon passwords
running Update Title Block add-in, 368 changing, 21
sorting tasks, 424 loop numbers
task dependencies, 423 finding all loops in a unit, 31
title blocks, 351, 353 finding loops using search parameters, 31
To Do List, 419, 421, 422, 424, 425 finding typical loops, 33
updating title blocks, 352 search options, 26
interface language search options overview, 25
common tasks, 48 manufacturers (instruments)
creating language files, 51 manufacturer-specific field headers, 46
editing, 53 map file, 370
overview, 47 description, 370
prefixes and suffixes, 55 mapping schemas
replacing from database, 49 overview, 369
replacing from file, 50 SmartPlant schema to tool schema, 371
interface to SmartPlant Electrical matrix
create device panel, 297 integration, 349
create tag signal, 298 Merger
create wiring items, 296 analyzing comparison reports, 477
overview, 288 Comparison List, 465
power supplies, 299 database platform support, 428
prerequisites, 289 defining settings, 455
publish, 301 filtering and sorting source table data, 464
retrieve, 293 group mode selection of source data in the
signals, 291 Comparison List, 472
viewing tag numbers, 294 log files, 430
interfaces matching source and target data, 452
associate fieldbus device types, 326 matching source and target projects, 451
DCS vendors, 302 merging jumpers and cross wires, 491
Fluke, 327 merging supporting tables, 483
SmartPlant Electrical, 288 monitoring the data transfer process, 498
items naming conventions, 502
checking for duplicates, 478 overview, 427
filtering for global revisions, 60 post-merge acrions, 500
Merger item type selection, 460 preliminary configuration, 499
revision management common tasks, 58 restoring saved PSR files, 480

Index
running the Comparison List in multi- sessions, selecting a Merger source domain from ODBC,
475 447
selecting a source domain from a non-ODBC opening
database, 449 Web Client, 348
selecting a source domain from the same ODBC organizing
database as the target domain, 447 tasks, 421
selecting a target, 439 panels
selecting individual item types, 481 manufacturer-specific labels, 46
selecting item types, 460 passwords
selecting the same source domain as the target changing the logon password, 21
domain, 446 paths
selecting the source domain, 445 for MicroStation, 127
setting comparison criteria, 436 PDF files
source table selection, 458 Acrobat Distiller options, 88
specification forms that include custom title PDF generator
blocks, 492 configuring, 358
specifying insertion conditions, 461 plant hierarchy
starting, 429 custom, 374
the merge process, 437 PLC panels
update mode, 455 manufacturer-specific labels, 46
merger session postponing
creating, 440 tasks, 425
deleting, 444 PostScript printer driver
duplicating, 443 configuring, 358
opening, 441 testing configuration, 362
renaming, 442 power supplies
merging data flow of activities, 299
comparing data, 470 preferences
MicroStation, 123 customizing, 23
adding cells to cell libraries, 136 displaying, 23
cell libraries, 133 general preferences common tasks, 23
cell on the Desktop, 138 intools ini file, 24
cell origin, 135 previewing documents, 83
cell origin coordinates, 136 printer settings
cell preview, 137 modifying, 89
creating tag sets, 128 printing documents
exporting tag sets, 130 Acrobat Distiller options, 88
fencing elements for cells, 134 details, 85
importing tag sets, 131 Ghostscript printer options, 87
linking tags to drawing elements, 132 overview, 82
microstation settings, 124 process data
overview, 122 implementing Workflow, 79
path settings, 127 statuses for Workflow, 81
prerequisites for running, 127 Workflow browser view, 78
report generation, 139 Workflow overview, 76
SmartPlant Instrumentation parameters, 127 Workflow prerequisites, 77
system requirements, 123 properties
modifying tasks, 422
schema, 372 PSR files
tasks, 422 restoring for Merger, 480
modules publish data, 301
opening, 22 publishing, 399, 400, 402, 403, 404, 405
naming conventions Document Selection Wizard, 399, 400, 406
rules for merging data, 502 documents, 392
ODBC finding dimensional data sheets, 405
finding Enhanced SmartLoop reports, 403, 404

Index
finding process data sheets, 400 upgrading global revisions, 64

finding specification sheets, 402 viewing archive, 69
matrix of publishable documents, 349 save data
SmartPlant Instrumentation documents, 395 in other formats, 120
query, 113 saving data
refreshing in .dxf format, 91
To Do List, 426 in various formats, 90, 102
removing saving documents
tasks, 425, 426 editing headers, 92
report comparison in .dxf format, 91
comparing archived reports, 72 in other formats, 120
comparison color, 71 in various formats, 90, 102
comparison font, 71 overview, 82
currently previewed with archived, 73 Schema Configuration Wizard
overview, 70 xxx, 388, 389, 390
report management schema mapping
comparison options, 70 map file, 370
editing report headers, 92 schemas
previewing documents, 83 synchronizing, 379
printing, 85 search options
printing documents to PDF files, 86 common tasks, 26
saving, 90 overview, 25
saving in .dxf format, 91 searching for
viewing archived reports, 74 all loop numbers, 31
report types all tag numbers, 27
list, 56 loops using search parameters, 31
non-list, 56 tags using search parameters, 28
reporting typical loops, 33
to do list, 426 typical tags, 30
requirements select lists, 45
integrated environment, 338 adding new values, 45
reserving,revision numbers, 410 session
retrieve data, 293 creating, 440
retrieving deleting, 444
documents, 413 duplicating, 443
matrix of retrievable documents, 349 opening, 441
retrieving documents renaming, 442
to SmartPlant Instrumentation, 416 Setting General Parameters, 171
revising signals
documents, 410, 411 create wiring items, 296
revisions flow of activities, 291
adding global revisions, 61 SmartPlant Electrical interface
adding local revisions, 67 create device panel, 297
common tasks, 58 create tag signal, 298
deleting global revisions, 66 create wiring items, 296
deleting local revisions, 68 overview, 288
editing local revisions, 68 power supplies, 299
filtering items for global revisions, 60 prerequisites, 289
global revisions, 57 publish, 301
global upgrade example, 65 retrieve, 293
overview, 56 signals, 291
per document, 56 viewing tag numbers, 294
per item, 56 SmartPlant Instrumentation
report types, 56 changing the logon password, 21
updating revisions globally, 63 database structure, 111
upgrade settings for global revisions, 62 general preferences, 23

Index
getting started, 17 modifying, 422

InfoMaker, 109 properties, 422
navigating, 19 refreshing, 426
opening a module, 22 removing, 425, 426
opening another domain, 20 reporting, 426
overview, 16 running, 422
searching for loops, 25 sorting, 424
searching for tags, 25 To Do List, 419, 421
starting, 18 types, 419
swtching to another unit, 22 updating, 426
SmartPlant integration adapter, 370 title blocks
SmartPlant schema associating with SmartPlant Instrumentation, 356
mapping overview, 369 configuring PDF generator, 358
mapping to tool schema, 371 custom title block macros, 94
synchronizing, 379 customization requirements, 94
source defining PDF generation settings, 367
filtering and sorting Merger source table data, 464 editing properties, 98
matching Merger source and target data, 452 installing Update Title Block Component, 366
matching Merger source and target projects, 451 integration, 351
Merger group mode selection using the overview of custom title blocks, 93
Comparison List, 472 requirements for integration, 353
Merger source domain selection, 445 running Update Title Block add-in, 368
Merger source table selection, 458 updating for integration, 352
using the Comparison List to select source data to to do list
merge, 465 task dependencies, 423
source domain for Merger tasks, 419
selecting a source domain from a non-ODBC To Do List, 420
database, 449 common tasks, 420
selecting from the same ODBC database as the completing a task, 424
target domain, 447 deferring tasks, 425
selecting the same source domain as the target deleted tasks, 426
domain, 446 filtering tasks, 424
source domain selection, 445 opening, 421
supporting tables, 34, 35, 36, 43, 45 properties, 422
adding new values, 45 remove a task, 425
common tasks, 35 reporting, 426
list, 36 sorting tasks, 424
merging, 483 updating, 426
overview, 34 tool schema
Telecom, 43 mapping to SmartPlant schema, 371
tag numbers synchronizing, 379
electrical, 294 Tool Schema
finding all tags in a unit, 27 map file, 370
finding tags using search parameters, 28 typical loops
finding typical tags, 30 finding, 33
search options, 26 typical tags
search options overview, 25 finding, 30
target UDF
matching Merger source and target data, 452 see custom fields, 94
matching Merger source and target projects, 451 units
selecting a merger target, 439 opening another unit, 22
tasks To Do List, 419
completing, 424 update mode
deferring, 425 merging data, 455
executing, 422 Update Title Block add-in
filtering, 424 running, 368

Index
updating prerequisites, 77
schema, 372 process data statuses, 81
to do list, 426 Workflow browser view, 78
Web Client Yokogawa CENTUM CS 3000
accessing, 348 associate fieldbus device types, 326
wiring items, 296 crucial fields, 318
Workflow flow of activities, 307
example scenario, 76 publishing data, 322
implementing, 79 retrieving definitions, 311
overview, 76 Yokogawa interface, 302

SPI Guide

Uploaded by

Copyright:

Available Formats

SPI Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SPI Guide

Uploaded by

Copyright:

Available Formats

SmartPlant Instrumentation

Version 2007 (8.0) January 2007 DINS-08.00.0001A

Restricted Rights Legend

Warranties and Liabilities

Working with SmartPlant Instrumentation..................................................................34

Getting Started .................................................................................................................39

Searching for Tag and Loop Numbers ..........................................................................46

SmartPlant Instrumentation User’s Guide 3

Prefixes and Suffixes in the Interface Text....................................................................... 74

Revision Management .....................................................................................................75

4 SmartPlant Instrumentation User’s Guide

Saving in DXF Format..............................................................................................111

SmartPlant Instrumentation User’s Guide 5

Wiring > Custom (Preferences) ...................................................................................... 151

6 SmartPlant Instrumentation User’s Guide

Module Icons (Preferences) ............................................................................................ 197

Claiming As-Built Items in a Project ...........................................................................199

Preparing Project Items for Merging with As-Built...................................................201

Working with the SmartPlant Instrumentation Explorer .........................................211

Working with the Domain Explorer ............................................................................212

SmartPlant Instrumentation User’s Guide 7

Working with the Reference Explorer.........................................................................252

Reference Explorer ........................................................................................................257

Browser Module .............................................................................................................260

8 SmartPlant Instrumentation User’s Guide

Display the Current Sorting Sequence ............................................................................ 297

Instrument Index Module .............................................................................................328

SmartPlant Instrumentation User’s Guide 9

Rename Multiple Loop Numbers.................................................................................... 344

10 SmartPlant Instrumentation User’s Guide

Delete a Typical Loop..................................................................................................... 391

Wiring in SmartPlant Instrumentation .......................................................................423

SmartPlant Instrumentation User’s Guide 11

Principles of Wiring Operations in SmartPlant Instrumentation..............................424

12 SmartPlant Instrumentation User’s Guide

Customize and Use Wiring Equipment Categories......................................................... 489

SmartPlant Instrumentation User’s Guide 13

Effect I/O Assignment for a Segment ............................................................................. 551

14 SmartPlant Instrumentation User’s Guide

Manage Intrinsic Safety Circuit Types ........................................................................... 605

Foundation Fieldbus Design..........................................................................................644

SmartPlant Instrumentation User’s Guide 15

Flow of Activities for Foundation Fieldbus Design .................................................645

16 SmartPlant Instrumentation User’s Guide

Assign Connector Pins to Cable Wires ........................................................................... 693

Profibus Design: An Overview .....................................................................................707

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

Fieldbus and Conventional Multi-Input Devices ........................................................723

SmartPlant Instrumentation User’s Guide 17

18 SmartPlant Instrumentation User’s Guide

SmartPlant Instrumentation User’s Guide 19

Spec Forms: An Overview........................................................................................821

20 SmartPlant Instrumentation User’s Guide

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

SmartPlant Instrumentation User’s Guide 21

Correct a Line Discontinuity........................................................................................... 917

Document Binder Module .............................................................................................948

22 SmartPlant Instrumentation User’s Guide

Loop Drawings Module .................................................................................................987